DWPF-1794 Groups and perms docs (#631)

docs/permissions-and-groups/custom-permissions/extended_search.md

@@ -0,0 +1,10 @@
+# `extended_search`
+
+Here we describe the different permissions in the `extended_search` app.
+
+## Setting
+
+### Django permissions
+
+- `extended_search.view_explore`: Can view the extended search explore page
+- `extended_search.change_setting`: Can change the settings for the extended search (on the explore page).

docs/permissions-and-groups/custom-permissions/peoplefinder.md

@@ -0,0 +1,30 @@
+# `peoplefinder`
+
+Here we describe the different permissions in the `peoplefinder` app.
+
+## AuditLog
+
+### Django permissions
+
+- `peoplefinder.view_auditlog`: Can view the audit logs for **Team** and **Person** objects.
+
+## Person
+
+### Django permissions
+
+- `peoplefinder.change_person`: Can change objects of type **Person**
+- `peoplefinder.delete_person`: Can delete objects of type **Person**
+
+### Can view inactive profiles
+
+`peoplefinder.can_view_inactive_profiles`
+
+Can view objects of **Person** that are marked as inactive.
+
+## Team
+
+### Django permissions
+
+- `peoplefinder.add_team`: Can add objects of type **Team**
+- `peoplefinder.change_team`: Can change objects of type **Team**
+- `peoplefinder.delete_team`: Can delete objects of type **Team**

docs/permissions-and-groups/groups/country-factsheet-editor.md

@@ -0,0 +1,17 @@
+# Country factsheet editor
+
+Users in this group get the following permissions:
+
+## Global permissions
+
+- Can access Wagtail admin
+
+## Page permissions
+
+- Can edit/publish the **DBT trade and investment factsheets** page
+
+## Document permissions
+
+- Can add/edit/choose documents belonging to the following collections:
+    - **HMTC region factsheets**
+    - **Group factsheets**

docs/permissions-and-groups/groups/editors.md

@@ -0,0 +1,37 @@
+# Editors
+
+Users in this group get the following permissions:
+
+## Object permissions
+
+- Can add/change/delete/view **Home page news order**
+
+## Global permissions
+
+- Can access Wagtail admin
+
+## Page permissions
+
+- Can add/edit/publish the following pages:
+    - **Working at DBT**
+    - **Topics**
+    - **All how do I guides**
+    - **Policies and guidance**
+    - **About us**
+    - **Tools**
+    - **Diversity and Inclusion Networks**
+
+## Document permissions
+
+- Can add/edit/choose documents belonging to the following collections:
+    - **Root**
+
+## Image permissions
+
+- Can add/edit/choose images belonging to the following collections:
+    - **Root**
+
+## Media permissions
+
+- Can add/edit images belonging to the following collections:
+    - **Root**

docs/permissions-and-groups/groups/moderators.md

@@ -0,0 +1,42 @@
+# Moderators
+
+Users in this group get the following permissions:
+
+## Object permissions
+
+- Can add/change/delete/view **Site alert banner**
+- Can add/change/delete/view **Quick link**
+- Can add/change/delete/view **Whats popular**
+- Can add/change/delete/view **Comment**
+- Can add/change **Redirect**
+- Can change **User**
+
+## Global permissions
+
+- Can access Wagtail admin
+
+## Page permissions
+
+- Can add/edit/lock/publish/unlock the following pages:
+    - **Working at DBT**
+    - **Topics**
+    - **All how do I guides**
+    - **Policies and guidance**
+    - **About us**
+    - **Tools**
+    - **Diversity and Inclusion Networks**
+
+## Document permissions
+
+- Can add/edit/choose documents belonging to the following collections:
+    - **Root**
+
+## Image permissions
+
+- Can add/edit/choose images belonging to the following collections:
+    - **Root**
+
+## Media permissions
+
+- Can add/edit images belonging to the following collections:
+    - **Root**

docs/permissions-and-groups/groups/news-moderators.md

@@ -0,0 +1,41 @@
+# News moderators
+
+Users in this group get the following permissions:
+
+## Object permissions
+
+- Can add/change/delete/view **Home page news order**
+- Can add/change/delete/view **News category**
+- Can add/change/delete **Comment**
+
+## Global permissions
+
+- Can access Wagtail admin
+
+## Page permissions
+
+- Can add/edit/lock/publish/unlock the following pages:
+    - **News**
+
+## Document permissions
+
+- Can add/edit/choose documents belonging to the following collections:
+    - **Root**
+
+## Image permissions
+
+- Can add/edit/choose images belonging to the following collections:
+    - **Root**
+
+## Media permissions
+
+- Can add/edit images belonging to the following collections:
+    - **Root**
+
+## Collection management permissions
+
+!!! note
+    I think this permission makes the document/image/media permissions redundant.
+
+- Can add to the following collection **Root**
+

docs/permissions-and-groups/groups/peoplefinder-beta-testers.md

@@ -0,0 +1,6 @@
+# Peoplefinder beta testers
+
+Users in this group get the no extra permissions.
+
+!!! warning
+    I can't see any permissions for this group in the codebase or in the Wagtail admin. I think this group is redundant.

docs/permissions-and-groups/groups/person-admin.md

@@ -0,0 +1,10 @@
+# Person admin
+
+Users in this group get the following permissions:
+
+## Custom permissions
+
+- `peoplefinder.change_person`: Can change objects of type **Person**
+- `peoplefinder.delete_person`: Can delete objects of type **Person**
+- `peoplefinder.view_auditlog`: Can view the audit logs for **Team** and **Person** objects
+- `peoplefinder.can_view_inactive_profiles`: Can view objects of **Person** that are marked as inactive

docs/permissions-and-groups/groups/proposed/feedback-viewer.md

@@ -0,0 +1,18 @@
+# Feedback viewer
+
+!!! warning "This is a proposed group"
+    This group is not yet available in the application and this document is a proposal for its definition and purpose.
+
+Users in this group should be able to view all feedback submitted through the feedback forms on the website.
+
+Users in this group get the following permissions:
+
+## Object permissions
+
+- `django_feedback_govuk.view_feedback_submission`: Can view **ALL** feedback submissions
+
+Optionally, we can create groups per feedback type by using their specific permissions:
+
+- `feedback.view_hrfeedback`: Can view feedback associated with the `feedback.HRFeedback` model
+- `feedback.view_searchfeedbackv1`: Can view feedback associated with the `feedback.SearchFeedbackV1` model
+- `feedback.view_searchfeedbackv2`: Can view feedback associated with the `feedback.SearchFeedbackV2` model

docs/permissions-and-groups/groups/proposed/navigation-page-admin.md

@@ -0,0 +1,13 @@
+# Navigation page admin
+
+!!! warning "This is a proposed group"
+    This group is not yet available in the application and this document is a proposal for its definition and purpose.
+
+Users in this group should be able to create/delete Navigation pages.
+
+Users in this group get the following permissions:
+
+## Object permissions
+
+- `content.create_navigationpage`: Can create new Navigation pages
+- `content.delete_navigationpage`: Can delete existing Navigation pages

docs/permissions-and-groups/groups/proposed/navigation-page-editor.md

@@ -0,0 +1,13 @@
+# Navigation page editor
+
+!!! warning "This is a proposed group"
+    This group is not yet available in the application and this document is a proposal for its definition and purpose.
+
+Users in this group should be able to edit/publish existing Navigation pages.
+
+Users in this group get the following permissions:
+
+## Object permissions
+
+- `content.edit_navigationpage`: Can edit existing Navigation pages
+- `content.publish_navigationpage`: Can publish existing Navigation pages

docs/permissions-and-groups/groups/proposed/post-page-admin.md

@@ -0,0 +1,13 @@
+# Post page admin
+
+!!! warning "This is a proposed group"
+    This group is not yet available in the application and this document is a proposal for its definition and purpose.
+
+Users in this group should be able to create/delete BlogPost pages.
+
+Users in this group get the following permissions:
+
+## Object permissions
+
+- `content.create_blogpost`: Can create new BlogPost pages
+- `content.delete_blogpost`: Can delete existing BlogPost pages

docs/permissions-and-groups/groups/proposed/post-page-editor.md

@@ -0,0 +1,13 @@
+# Post page editor
+
+!!! warning "This is a proposed group"
+    This group is not yet available in the application and this document is a proposal for its definition and purpose.
+
+Users in this group should be able to edit/publish existing BlogPost pages.
+
+Users in this group get the following permissions:
+
+## Object permissions
+
+- `content.edit_blogpost`: Can edit existing BlogPost pages
+- `content.publish_blogpost`: Can publish existing BlogPost pages

docs/permissions-and-groups/groups/proposed/search-admin.md

@@ -0,0 +1,14 @@
+# Search admin
+
+!!! warning "This is a proposed group"
+    This group is not yet available in the application and this document is a proposal for its definition and purpose.
+
+Users in this group should be able to **view** the Search explore page and the settings for the search. They will not be able to change the settings.
+
+This group is intended for users that would find it beneficial to understand what is happening behind the scenes of the search functionality.
+
+Users in this group get the following permissions:
+
+## Object permissions
+
+- `extended_search.view_explore`: Can view the extended search explore page

docs/permissions-and-groups/groups/proposed/search-setting-admin.md

@@ -0,0 +1,15 @@
+# Search setting admin
+
+!!! warning "This is a proposed group"
+    This group is not yet available in the application and this document is a proposal for its definition and purpose.
+
+Users in this group should be able to **view** the Search explore page and the settings for the search. They should also be able to **change** the settings for the search.
+
+This group is intended for users that would find it beneficial to understand what is happening behind the scenes of the search functionality. And be able to make changes to the settings if necessary.
+
+Users in this group get the following permissions:
+
+## Object permissions
+
+- `extended_search.view_explore`: Can view the extended search explore page
+- `extended_search.change_setting`: Can change the settings for the extended search (on the explore page).

docs/permissions-and-groups/groups/proposed/tag-admin.md

@@ -0,0 +1,13 @@
+# Tag admin
+
+!!! warning "This is a proposed group"
+    This group is not yet available in the application and this document is a proposal for its definition and purpose.
+
+Users in this group should be able to create/delete Tags.
+
+Users in this group get the following permissions:
+
+## Object permissions
+
+- `core.create_tag`: Can create new Tags
+- `core.delete_tag`: Can delete existing Tags

docs/permissions-and-groups/groups/proposed/tag-user.md

@@ -0,0 +1,12 @@
+# Tag user
+
+!!! warning "This is a proposed group"
+    This group is not yet available in the application and this document is a proposal for its definition and purpose.
+
+Users in this group should be able to view Tags.
+
+Users in this group get the following permissions:
+
+## Object permissions
+
+- `core.view_tag`: Can view Tags

docs/permissions-and-groups/groups/site-alert-banner-admin.md

@@ -0,0 +1,7 @@
+# Site Alert Banner Admin
+
+Users in this group get the following permissions:
+
+## Object permissions
+
+- Can add/change/delete/view **Site alert banner**

docs/permissions-and-groups/groups/team-admin.md

@@ -0,0 +1,10 @@
+# Team Admin
+
+Users in this group get the following permissions:
+
+## Custom permissions
+
+- `peoplefinder.add_team`: Can add objects of type **Team**
+- `peoplefinder.change_team`: Can change objects of type **Team**
+- `peoplefinder.delete_team`: Can delete objects of type **Team**
+- `peoplefinder.view_auditlog`: Can view the audit logs for **Team** and **Person** objects

docs/permissions-and-groups/index.md

@@ -0,0 +1,3 @@
+# Permissions and Groups
+
+Here we describe the different permissions and groups that have been set up in this project.

mkdocs.yml

@@ -63,9 +63,10 @@ markdown_extensions:
       linenums: null
       anchor_linenums: true
       use_pygments: true
+  - pymdownx.details
   - pymdownx.inlinehilite
   - pymdownx.snippets
-  - pymdownx.superfences
+  # - pymdownx.superfences
   - tables
 
 dev_addr: "127.0.0.1:8002"