Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

DOC-4381: Add defintions for platform groups (#218) #222

Open
wants to merge 7 commits into
base: 5.2
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
111 changes: 108 additions & 3 deletions docs/Administration.rst
Original file line number Diff line number Diff line change
Expand Up @@ -2247,6 +2247,33 @@ By default, all existing groups will be displayed on the left panel. The
right panel shows information of the selected group and of its members
with the Add Member form.

.. _ExistingGroups:

**Existing Groups**

By default, in eXo Platform there are 4 parent groups: Development, Organzation, Platform and Spaces.

**Development** is a sample group, could be used to organize users.

**Organization** helps you to organize your company: departments, teams or any way to represent your organization.

.. tip:: Notice that these groups i.e. those under Organization group have no specific effects in the product.
They are just made as a placeholder.

**Platform** helps to define roles in the platform, it contains 4 sub groups:
- Administration: contains users having administrative roles i.e. who are able to access the Administration menu |imagee354|.
- Guests: contains external users to the platform, they have access only to public content of the platform
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

If I remember, no user is really assigned this group. It’s a membership automatically assigned to non authenticated users and thus, this technical group is mandatory to set permissions on this visible by non authenticated users only (such as pages and content)

- Users: contains all the platform users able to connect to the platform
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

IMO it’s important to explain that this is also a technical group mandatory for authe ticated isers. Users that are not members of isers geoup will see an http 403 (forbidden) when they try to connect

- Content Management: contains users who have permissions to add and manage content in the platform

.. note: Any self- registered user and account created by Administration > Add users is automatically added to the platform/users group to be able to connect.

.. _spacesGroups:

**Spaces** is the parent group for all spaces groups. When creating a space, its corresponding group is added
as sub group to ``Spaces`` parent group.


.. _AddNewGroup:

Adding a new group
Expand Down Expand Up @@ -2366,14 +2393,44 @@ Managing memberships
Select the Memberships tab. Here, you can manage user roles in a
specific group.

By default, 9 membership types are available in PRODUCT including
Member, Author, Editor, Manager, Redactor, Validator, Webdesigner,
Publisher and \*.
By default, 9 membership types are available in eXo Platform including
Member, Author, Editor, Manager, Redactor, Validator, Webdesigner, Publisher and \*.

|image178|

The membership, such as `manager:/platform/users`, is defined by both membership type (manager, member, author...)
and a group i.e. it is the combinaison between a group and a membership type to define the user's role in the group.

.. note:: The \* membership is identical to any other type, so choosing this type means adding all available membership types.

**Membership usage in eXo Platform**

In eXo Platform, the most used membership types are `manager`, `member` and `*`.

- The `manager` role to define users with managing privileges
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think it gives space management peivileges but I also thnk manager membership type has something to do with navigation management in the prtal and maybe administrative privileges in community management (to ne verified, I may be wrong)

- The `member` role to define normal users in a group
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

maybe worth adding : such as members of a space

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

members of a group have access to the corresponding group site

- `*` all the roles combined, that means a user with * membership type will have the permissions assigned to all membership types within this group

Other roles i.e. Author, Editor, Redactor, Validator, Webdesigner and Publisher are mainly used for the
:ref:`publication process <PublicationProcess>` which could be
:ref:`customized <PLFDevGuide.DevelopingContent.PublicationLifecycle.CreatingPublicationLifecycle>`.

The most used roles are:

- The `publisher` role defines users allowed to :ref:`publish content <PublishContent>` i.e. they are able to switch
contents from staged to published status.

- The `Author` role defines users able to add and manage content in draft, pending or approved statuses.

Remaining roles could be used when you create your
:ref:`own publication lifecycle <PLFDevGuide.DevelopingContent.PublicationLifecycle.CreatingPublicationLifecycle>`.

.. note:: For :ref:`Spaces groups <spacesGroups>`, a user belonging to a space could be either a manager or a member.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think news is adding more roles in spaces around news publication. @samehaidi ?

No other memberships used in spaces groups.
If you are a manger in a space, this allows you to access :ref:`the space's settings <Manage-Space-Settings>`
and manage the space. If you belong to the space as a member, you are just able to share and view content
in the space.

.. _AddNewMembership:

Adding a new membership type
Expand Down Expand Up @@ -5073,3 +5130,51 @@ The following image shows the screen when an anonymous user accesses
.. |image319| image:: images/platform/create_space_permission.png
.. |image320| image:: images/platform/edit_space.png
.. |image321| image:: images/platform/type-ahead-suggestions.png
.. |image322| image:: images/platform/SpaceTemplatesTable.png
.. |image328| image:: images/walletadmin/administration_menu.png
.. |image329| image:: images/walletadmin/wallets_administration.png
.. |image330| image:: images/walletadmin/new_wallet.png
.. |image331| image:: images/walletadmin/common_actions.png
.. |image332| image:: images/walletadmin/initialize_reject.png
.. |image333| image:: images/managekudos/manage_kudos.png
.. |image334| image:: images/managekudos/select_space.png
.. |image335| image:: images/managekudos/filter_kudos.png
.. |image336| image:: images/managekudos/kudos_list.png
.. |image337| image:: images/managerewards/reward_configuration.png
.. |image338| image:: images/managerewards/pool_no_user.png
.. |image339| image:: images/managerewards/create_pool.png
.. |image340| image:: images/managerewards/pools_tab.png
.. |image341| image:: images/managerewards/enabled_pool.png
.. |image342| image:: images/managerewards/disabled_pool.png
.. |image343| image:: images/managerewards/send_rewards.png
.. |image344| image:: images/managerewards/send_rewards_button.png
.. |image345| image:: images/managerewards/reward_details.png
.. |image346| image:: images/managerewards/display_disabled_users.png
.. |image347| image:: images/managerewards/search_bar.png
.. |image348| image:: images/sharenews/edit_layout.png
.. |image349| image:: images/sharenews/content_by_query.png
.. |image350| image:: images/sharenews/folder_path.png
.. |image351| image:: images/sharenews/template_selector.png
.. |image352| image:: images/sharenews/header_block.png
.. |image353| image:: images/sharenews/show_in_page.png
.. |imagee354| image:: images/platform/Admin_menu.png
.. |image354| image:: images/gamification/gamification_menu.png
.. |image355| image:: images/gamification/manage_badges.png
.. |image356| image:: images/gamification/manage_rules.png
.. |image357| image:: images/gamification/manage_domains.png
.. |image358| image:: images/gamification/add_badges.png
.. |image359| image:: images/gamification/add_rules.png
.. |image360| image:: images/gamification/add_domains.png
.. |image361| image:: images/gamification/edit_badges.png
.. |image362| image:: images/gamification/edit_rules.png
.. |image363| image:: images/gamification/edit_domains.png
.. |image364| image:: images/platform/branding_color_picker.png
.. |image365| image:: images/platform/primary_button_style1.png
.. |image366| image:: images/platform/primary_button_style2.png
.. |image367| image:: images/platform/primary_label_button.png
.. |image368| image:: images/platform/primary_activity.png
.. |image369| image:: images/platform/Primary_tag.png
.. |image370| image:: images/platform/secondary_button_sidebar.png
.. |image371| image:: images/platform/tertiary_tab.png
.. |image372| image:: images/platform/Tertiary_information.png
.. |image373| image:: images/platform/tertiary_stepper.png
Binary file added docs/images/platform/Admin_menu.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.