From 010caf9d9f13aca4337e5bc83e9574668c0e0901 Mon Sep 17 00:00:00 2001 From: mzorai Date: Wed, 8 Apr 2020 14:01:59 +0100 Subject: [PATCH 1/7] DOC-4381: Add defintions for platform groups (#218) * DOC-4381: Add definitions for platform groups * DOC-4381: Add details for membership types * DOC-4381: FIx typo * Update docs/Administration.rst Co-Authored-By: Ali HAMDI * DOC-4381: Add details about spaces groups Co-authored-by: Ali HAMDI (cherry picked from commit 78c536014efa8dd1f86f014358259b323c568adc) --- docs/Administration.rst | 112 +++++++++++++++++++++++++++- docs/images/platform/Admin_menu.png | Bin 0 -> 1821 bytes 2 files changed, 109 insertions(+), 3 deletions(-) create mode 100644 docs/images/platform/Admin_menu.png diff --git a/docs/Administration.rst b/docs/Administration.rst index 5833fb1c..1eb750a7 100644 --- a/docs/Administration.rst +++ b/docs/Administration.rst @@ -2247,6 +2247,34 @@ 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 2 parent groups: Organzation and Platform. + +**Organization** helps you to organize your company: deparments, 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 5 sub groups: +- Administration: contains users having administrative roles i.e. who are able to access + the Administration menu |image|. +- Rewarding Administrators: contains users having the right to :ref:`manage rewards ` +- Guests: contains external users to the platform, they have access only to public content of the platform +- Users: contains all the platform users able to connect to the platform +- Content Management: contains users who have permissions to add and manage content in the platform + +.. note: Any registred user is automatically added to the platform/users group to be able to connect. + +.. _spacesGroups: + +.. tip: When creating new spaces, an associated group is added under the parent group ``Spaces`` having as label + the space's name. + ``Spaces`` parent is added when creating the first space in the platform. + + .. _AddNewGroup: Adding a new group @@ -2366,14 +2394,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 memships are `manager`, `member` and `*`. + +- The `manager` role to define users with managing privileges +- The `member` role to define normal users in a group +- `*` 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 ` which could be +:ref:`customized `. + +The most used roles are: + +- The `publisher` role defines users allowed to :ref:`publish content ` 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 `. + +.. note:: For :ref:`Spaces groups `, a user belonging to a space could be either a manager or a member. + No other memberships used in spaces groups. + If you are a manger in a space, this allows you to acces :ref:`the space's 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 @@ -5073,3 +5131,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 diff --git a/docs/images/platform/Admin_menu.png b/docs/images/platform/Admin_menu.png new file mode 100644 index 0000000000000000000000000000000000000000..7360822dbe063a0cddacee58d7b4a19153af9e72 GIT binary patch literal 1821 zcmbuA`9B*70>!gkR7|9CjM~I8C}N5_;tnw>M${2>6-A{=n7E@AGANoFtRqyUM5ts; zi8`t?O58_Br==#TGii)E()!d<42`5??7y)4!~4AVeLub5ULn@^TV*Av5&!^D#(25~ zoOsEJ92FJ*o2ZMi0D!_O#_gNSB*tdV;HA_h-67O5_M-i~9Ts}W6#|megDb*XhDmqh z;acY4ynMtH3d(P7>Qce%OoE$en6EvFjl78yy9~k}oAVl&WIiprza7a1J*52+B zGv=JP52YKZK)$tN9{5<0Y?M)jEXV5>Y)iIYqCUvQnk4iSmh+r~G;iv`d0 z2oLIY={s4nCIoK15)<=gF8A6TypKguNfF3bp3@jXxp*!UB+79kV~>3@;X1y1nrj4| z%!|xLvoEBz z`U~T~b-A@g$ue~{k>7U+`P@yB^&yu0idg15A#oZ98Mjs9vcYC?ryeMF`RBuI)+wJS zFy^DbZ5TPN&2n~r+$tJFtHc~fcc-8!lM<1o#x$o*jr6;bZ?CYCrT$xXV}yl$hMo`O zdsstZXDB;y0X`#M9{EZG;~$T-#1=(x(T-M&Vhf}ht-g*h?@Jv_UF0Md^X|e1M2dby zj`X$Q6-XVs?f#9sV*pW(@IWV-liUjdIRJ8 z;E29~B_%)qAf;-0IE;e+Q>VuSPd{AGTB-QQvg`IMp4Ot_4ZGtJJ$2&aJxIiQXo<&AiEL64sSm zA8audx?BTxJ*h>G!w0*6$79dOd8GRZXq#PwkE>eu&7}WQ6pS5h+!b7DW zWTDp&st`EU(`E3;$XU2Xk=C1@s7Hy8djp|SfQKUMb$4oA*mzG66K;6SMjRLtRuZb~ zfYTK*5<1x8=>$Zxf5i@|*N@pCu4AAdZ#nzbJiOrZ`N}FqE}!!se)=xtiy>1h6b718 zy@zh#+OP1QieZS|v9MvW2F=rrH6?!2VFhJIg!A`7xf80z91~T4e0**KKK*@N6TOCs zvlYmBjPmJ-VUXCiq2|M>|Uzk4>)Fi7(3&b9B`s2#B*u;t0ZME93CKIMOO^urAQx2D& z+p&S>{@;;V|4v)_0sf;<`}Kkf>Rd_fnNlT78*SsH zQ%K?yjO6RljSO?&#Qnh{eBKG;1^a2tef}0Tk$$6H$XLYHYrein=#vd~WDuhHXQHbL8HQ zfW+Y13qomOa&yP4`|mHCqD*{-!hgsO8J-tKpC^0vzeq0FKME{kdQq zVE|~+rnKb|PAmP)3|HJ2Ho8!LBwVeCdUf^AvDKi&ES<3*A!>(+q%@~;1U$x_K3H-= z;ylSkl|cUTTCFDM+3J@xlz1A%8t@bse?a_yczk*>P_3#G7 literal 0 HcmV?d00001 From eddfd4108a3340d0a234b6320d9aff6db6f69d68 Mon Sep 17 00:00:00 2001 From: mzorai Date: Thu, 9 Apr 2020 15:17:29 +0100 Subject: [PATCH 2/7] DOC-4381: Alig groups and memberships documentation to 5.2 version --- docs/Administration.rst | 14 +++++++------- 1 file changed, 7 insertions(+), 7 deletions(-) diff --git a/docs/Administration.rst b/docs/Administration.rst index 1eb750a7..f5e5e303 100644 --- a/docs/Administration.rst +++ b/docs/Administration.rst @@ -2251,7 +2251,9 @@ with the Add Member form. **Existing Groups** -By default, in eXo Platform there are 2 parent groups: Organzation and Platform. +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: deparments, teams or any way to represent your organization. @@ -2259,8 +2261,7 @@ By default, in eXo Platform there are 2 parent groups: Organzation and Platform. They are just made as a placeholder. **Platform** helps to define roles in the platform, it contains 5 sub groups: -- Administration: contains users having administrative roles i.e. who are able to access - the Administration menu |image|. +- Administration: contains users having administrative roles i.e. who are able to access the Administration menu |imagee354|. - Rewarding Administrators: contains users having the right to :ref:`manage rewards ` - Guests: contains external users to the platform, they have access only to public content of the platform - Users: contains all the platform users able to connect to the platform @@ -2270,11 +2271,10 @@ By default, in eXo Platform there are 2 parent groups: Organzation and Platform. .. _spacesGroups: -.. tip: When creating new spaces, an associated group is added under the parent group ``Spaces`` having as label - the space's name. - ``Spaces`` parent is added when creating the first space in the platform. +**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 From 4dbf4c9630b34ff01e607746320bc64965f6f136 Mon Sep 17 00:00:00 2001 From: mzorai Date: Thu, 9 Apr 2020 15:28:17 +0100 Subject: [PATCH 3/7] DOC-4381:Remove rewarding admins groups for 5.2 version --- docs/Administration.rst | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/docs/Administration.rst b/docs/Administration.rst index f5e5e303..b296f2c8 100644 --- a/docs/Administration.rst +++ b/docs/Administration.rst @@ -2260,9 +2260,8 @@ By default, in eXo Platform there are 4 parent groups: Development, Organzation, .. 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 5 sub groups: +**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|. -- Rewarding Administrators: contains users having the right to :ref:`manage rewards ` - Guests: contains external users to the platform, they have access only to public content of the platform - Users: contains all the platform users able to connect to the platform - Content Management: contains users who have permissions to add and manage content in the platform From 1ffeeacdaf180bc16caefdecc5fe689a02f45537 Mon Sep 17 00:00:00 2001 From: mzorai Date: Thu, 9 Apr 2020 21:34:35 +0100 Subject: [PATCH 4/7] Update docs/Administration.rst Co-Authored-By: Patrice Lamarque --- docs/Administration.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/Administration.rst b/docs/Administration.rst index b296f2c8..51d9b14f 100644 --- a/docs/Administration.rst +++ b/docs/Administration.rst @@ -2405,7 +2405,7 @@ and a group i.e. it is the combinaison between a group and a membership type to **Membership usage in eXo Platform** -In eXo Platform, the most used memships are `manager`, `member` and `*`. +In eXo Platform, the most used membership types are `manager`, `member` and `*`. - The `manager` role to define users with managing privileges - The `member` role to define normal users in a group From 43596befb95739e709205fb23e6ad5535cc13caa Mon Sep 17 00:00:00 2001 From: mzorai Date: Thu, 9 Apr 2020 21:35:03 +0100 Subject: [PATCH 5/7] Update docs/Administration.rst Co-Authored-By: Patrice Lamarque --- docs/Administration.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/Administration.rst b/docs/Administration.rst index 51d9b14f..fca4f263 100644 --- a/docs/Administration.rst +++ b/docs/Administration.rst @@ -2255,7 +2255,7 @@ By default, in eXo Platform there are 4 parent groups: Development, Organzation, **Development** is a sample group, could be used to organize users. -**Organization** helps you to organize your company: deparments, teams or any way to represent your organization. +**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. From bb5a7357509f062c5d6f9e1586fac9cbfdd99cd4 Mon Sep 17 00:00:00 2001 From: mzorai Date: Thu, 9 Apr 2020 21:35:52 +0100 Subject: [PATCH 6/7] Update docs/Administration.rst Co-Authored-By: Patrice Lamarque --- docs/Administration.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/Administration.rst b/docs/Administration.rst index fca4f263..b3dce382 100644 --- a/docs/Administration.rst +++ b/docs/Administration.rst @@ -2266,7 +2266,7 @@ By default, in eXo Platform there are 4 parent groups: Development, Organzation, - Users: contains all the platform users able to connect to the platform - Content Management: contains users who have permissions to add and manage content in the platform -.. note: Any registred user is automatically added to the platform/users group to be able to connect. +.. 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: From e19c7a9457079fdd028b941caaef46ff97fc3d25 Mon Sep 17 00:00:00 2001 From: mzorai Date: Thu, 9 Apr 2020 21:36:02 +0100 Subject: [PATCH 7/7] Update docs/Administration.rst Co-Authored-By: Patrice Lamarque --- docs/Administration.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/Administration.rst b/docs/Administration.rst index b3dce382..8b433ed3 100644 --- a/docs/Administration.rst +++ b/docs/Administration.rst @@ -2427,7 +2427,7 @@ Remaining roles could be used when you create your .. note:: For :ref:`Spaces groups `, a user belonging to a space could be either a manager or a member. No other memberships used in spaces groups. - If you are a manger in a space, this allows you to acces :ref:`the space's settings ` + If you are a manger in a space, this allows you to access :ref:`the space's 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.