Skip to content

Commit

Permalink
[docs] added groups management sections
Browse files Browse the repository at this point in the history
  • Loading branch information
gioscarda committed Jun 27, 2019
1 parent 765ab23 commit 29be5c7
Show file tree
Hide file tree
Showing 10 changed files with 128 additions and 11 deletions.
Binary file added docs/admin/admin_panel/img/add_new_member.png
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/admin/admin_panel/img/group_activities.png
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/admin/admin_panel/img/group_logo.png
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/admin/admin_panel/img/groups_link.png
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/admin/admin_panel/img/new_members.png
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
139 changes: 128 additions & 11 deletions docs/admin/admin_panel/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -455,6 +455,123 @@ In order to add a new **Group Category** follow these steps:
Managing a Group
================

Through the :guilabel:`Groups` link of *About* menu in the navigation bar, administrators can reach the *Groups List Page*.

.. figure:: img/groups_link.png
:align: center

*The Groups Link in the navigation bar*

In that page all the GeoNode *Group Profiles* are listed.

.. figure:: img/group_profiles_list_page.png
:align: center

*Group Profiles List Page*

For each group some summary information (such as the *title*, the *description*, the number of *members* and *managers*) are displayed near the *Group Logo*.

Administrators can manage a group from the *Group Profile Details Page* which is reachable by clicking on the *title* of the group.

.. figure:: img/group_profile_details_page.png
:align: center

*Group Profile Details Page*

As shown in the picture above, all information about the group are available on that page:

* the group *Title*;
* the *Last Editing Date* which shows a timestamp corresponding to the last editing of the group properties;
* the *Keywords* associated with the group;
* *Permissions* on the group (Public, Public(invite-only), Private);
* *Members* who join the group;
* *Managers* who manage the group.

There are also four links:

* The :guilabel:`Edit Group Details` link opens the *Group Profile Form* through which the following properties can be changed:

* *Title*.
* *Logo* (see next paragraphs).
* *Description*.
* *Email*, to contact one or all group members.
* *Keywords*, a comma-separated list of keywords.
* *Access*, which regulates permissions:

* *Public*: any registered user can view and join a public group.
* *Public (invite-only)*: only invited users can join, any registered user can view the group.
* *Private*: only invited users can join the group, registered users cannot see any details about the group, including membership.

* *Categories*, the group categories the group belongs to.

.. figure:: img/group_profile_details_page.png
:align: center

*Group Profile Details Page*

* :guilabel:`Managing Group Members` (see next paragraphs).
* the :guilabel:`Delete this Group`, click on it to delete the Group Profile. GeoNode requires you to confirm this action.

.. figure:: img/confirm_group_deletion.png
:align: center
:width: 400px

*Confirm Group Deletion*

* the :guilabel:`Group Activities` drives you to the *Group Activites Page* where you can see all layers, maps and documents associated with the group. There is also a *Comments* tab which shows comments on those resources.

.. figure:: img/group_activities.png
:align: center

*Group Activities*

Group Logo
^^^^^^^^^^

Each group represents something in common between its members.
So each group should have a *Logo* which graphically represents the idea that identify the group.

On the *Group Profile Form* page you can insert a logo from your disk by click on :guilabel:`Browse...`.

.. figure:: img/editing_group_logo.png
:align: center

*Editing the Group Logo*

| Click on :guilabel:`Update` to apply the changes.
| Take a look at your group now, you should be able to see that logo.
.. figure:: img/group_logo.png
:align: center

*The Group Logo*

Managing Group members
^^^^^^^^^^^^^^^^^^^^^^

The :guilabel:`Manage Group Members` link opens the *Group Members Page* which shows *Group Members* and *Group Managers*.
**Managers** can edit group details, can delete the group, can see the group activities and can manage memberships.
Other **Members** can only see the group activities.

| In Public Groups, users can join the group without any approval.
Other types of groups require the user to be invited by the group managers.
| Only group managers can *Add new members*.
In the picture below, you can see the manager can search for users by typing their names into the *User Identifiers* search bar.
Once found, he can add them to the group by clicking the :guilabel:`Add Group Members` button.
The *Assign manager role* flag implies that all the users found will become managers of the group.
.. figure:: img/add_new_member.png
:align: center

*Adding a new Member to the Group*

The following picture shows you the results.

.. figure:: img/new_members.png
:align: center

*New Members of the Group*

Group based advanced data workflow
==================================

Expand Down Expand Up @@ -490,20 +607,20 @@ Please see the details of the following GeoNode ``Settings``:
The group Manager approval
^^^^^^^^^^^^^^^^^^^^^^^^^^
Here, the role of the Manager of the group to which your layer, document or map is linked is to check that the uploaded item is correct.
Particularly, in the case of a layer or a map, it consists of checking that the chosen cartographic representation and the style are
Particularly, in the case of a layer or a map, it consists of checking that the chosen cartographic representation and the style are
fitting but also that the discretization is appropriate.

The Manager must also check that the metadata are properly completed and that the mandatory information
The Manager must also check that the metadata are properly completed and that the mandatory information
(Title, Abstract, Edition, Keywords, Category, Group, Region) are filled.

If needed, the Manager can contact the contributor responsible of the layer, document or map in order to report potential comments or
If needed, the Manager can contact the contributor responsible of the layer, document or map in order to report potential comments or
request clarifications.

Members of the group can also take part in the reviewing process and give some potential inputs to the responsible of the
Members of the group can also take part in the reviewing process and give some potential inputs to the responsible of the
layer, document or map.

When the Manager considers that the layer, document or map is ready to be published, he should approve it.
To do so, the Manager goes to the layer, document or map page, then opens the :guilabel:`Wizard` in order to edit the metadata.
When the Manager considers that the layer, document or map is ready to be published, he should approve it.
To do so, the Manager goes to the layer, document or map page, then opens the :guilabel:`Wizard` in order to edit the metadata.
In the :guilabel:`Settings` tab, the manager checks the :guilabel:`Approved` box, and then updates the metadata and saves the changes:

.. figure:: img/adv_data_workflow/approbation_manager.gif
Expand All @@ -521,12 +638,12 @@ Following this approval, the GeoNode Administrators receive a notification infor
The publication by the GeoNode Administrator
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

Prior to the public release of an approved layer, a document or a map, the Administrator of the platform performs a final validation of
Prior to the public release of an approved layer, a document or a map, the Administrator of the platform performs a final validation of
the item and its metadata, notably to check that it is in line with licence policies.

If needed, the GeoNode Administrator can contact the Manager who has approved the layer, document or map, as well as its responsible.

Once the layer, document or map is validated, the item is made public by the Administrator.
Once the layer, document or map is validated, the item is made public by the Administrator.
It can now be viewed, accessed, and downloaded in accordance with the ``Permissions`` set by the responsible contributor.

Manage profiles using the admin panel
Expand Down Expand Up @@ -566,7 +683,7 @@ The ``Metadata`` information can be changed for multiple Layers at once throguh

.. figure:: img/admin-layers-batch.png

By clicking over one Layer link, it will show a detail page allowing you to modify some of the resource info like the metadata, the keywords, the title, etc.
By clicking over one Layer link, it will show a detail page allowing you to modify some of the resource info like the metadata, the keywords, the title, etc.

.. note:: It is strongly recommended to always use the GeoNode :guilabel:`Metadata Wizard` or :guilabel:`Metadata Advanced` tools in order to edit the metadata info.

Expand All @@ -583,7 +700,7 @@ The ``Metadata`` information can be changed for multiple Maps at once throguh th

.. figure:: img/admin-layers-batch.png

By clicking over one Map link, it will show a detail page allowing you to modify some of the resource info like the metadata, the keywords, the title, etc.
By clicking over one Map link, it will show a detail page allowing you to modify some of the resource info like the metadata, the keywords, the title, etc.

.. note:: It is strongly recommended to always use the GeoNode :guilabel:`Metadata Wizard` or :guilabel:`Metadata Advanced` tools in order to edit the metadata info.

Expand All @@ -607,7 +724,7 @@ The ``Metadata`` information can be changed for multiple Documents at once throg

.. figure:: img/admin-layers-batch.png

By clicking over one Document link, it will show a detail page allowing you to modify some of the resource info like the metadata, the keywords, the title, etc.
By clicking over one Document link, it will show a detail page allowing you to modify some of the resource info like the metadata, the keywords, the title, etc.

.. note:: It is strongly recommended to always use the GeoNode :guilabel:`Metadata Wizard` or :guilabel:`Metadata Advanced` tools in order to edit the metadata info.

Expand Down

0 comments on commit 29be5c7

Please sign in to comment.