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

Add docs about permissions and webmaster libraries #1827

Open
wants to merge 1 commit into
base: develop
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
31 changes: 31 additions & 0 deletions docs/permissions-and-roles.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
# Permissions and roles

'mediator':
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
'mediator':
## `mediator`:

Just a suggestion to use headlines as this seems to be what it is. Take it or leave it 😄


* For users who frequently create dynamic content on the website.
* Can create and edit events, articles, pages, and campaigns in
/admin/content.

'editor':

* For users who, in addition to content creation, are responsible for
static content (e.g., opening hours) and the site's structure.
* Can coordinate and manage the work of mediators.
* Has access to the same as mediator plus all content types in
/admin/content, as well as taxonomy and menus in /admin/structure.

'local_administrator':

* For users who need to configure the website in terms of settings,
appearance, integrations, general information, library usage, etc.
* Has access to the same as editor plus the site's configuration
options in /admin/config, user creation in /admin/people, and
changing the site's appearance in /admin/appearance.
* This is the role assigned to trusted users on regular libraries.
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
* This is the role assigned to trusted users on regular libraries.
* This is the role assigned to trusted users on Editor libraries.

Please consider referring to the name of the plan used by the business and elsewhere in the docs.

The name overlaps with the user role but in practice I do not think this has been a problem.


'administrator':

* Can modify the site beyond the CMS's standard settings, e.g., by
enabling and disabling modules.
* Has access to everything in the CMS.
* This is the role assigned to trusted users on webmaster libraries.
14 changes: 14 additions & 0 deletions docs/webmaster-libraries.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
# Webmaster libraries

Libraries on the "webmaster" plan has extended permissions compared to
regular libraries. They have access to most of the Drupal
administration pages, and can install custom modules.

See [Permissions and roles](./permissions-and-roles) for details on
Drupal setup.

In addition to the Drupal setup, the site should use the `webmaster`
plan when configured in [DPL
Platform](https://danskernesdigitalebibliotek.github.io/dpl-docs/DPL-Platform/),
this creates a `moduletest` environment for testing and implies a
slightly different deployment scheduling.
Comment on lines +1 to +14
Copy link
Contributor

Choose a reason for hiding this comment

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

👍 I appreciate this addition. Consider moving it to dpl-docs.

As I see it the plan handling is handled partly by the CMS and partly with the Platform. Now what we have a general location within the documentation I think this would be a nice place to put this information and then refer to the parts within the individual projects.

With this in mind I also think it would make sense to provide an overview of all the plan types a bit like we have done elsewhere instead of only mentioning the webmaster libraries.

Loading