Skip to content

Revamp permissions table

Marcel Amirault requested to merge docs-permissions-table-revamp into master

What does this MR do?

The permissions table at https://docs.gitlab.com/ee/user/permissions.html#project-members-permissions is very hard to use, and very hard to manage. Currently, the whole table is sorted by permission level, but within each level is mixed.

This causes problems for:

  • Authors:
    • It's not clear where to put new entries.
  • Users
    • It's hard to find the permissions you are looking for.
    • It's hard to find what's related to the permissions you are looking at.
    • Sometimes it's hard to even know what a permission relates to. For instance, I had no idea that the Create/edit/delete a Cleanup policy entry was actually a Packages permission.
  • Technical Writers:
    • All technical writers may have to maintain this table, but without any clear pattern, we all try to do it differently.

This MR attempts to fix a lot of that by:

  • Re-sorting everything in a more logical and manageable pattern:
    1. Grouping features together.
    2. Sorting the groups alphabetically.
    3. Sorting within the groups based on permission levels.
  • Adding links to a related page for every permission.

Related issues

Closes #258967 (closed)

Author's checklist (required)

Do not add the feature, frontend, backend, ~"bug", or database labels if you are only updating documentation. These labels will cause the MR to be added to code verification QA issues.

When applicable:

Review checklist

All reviewers can help ensure accuracy, clarity, completeness, and adherence to the Documentation Guidelines and Style Guide.

1. Primary Reviewer

  • Review by a code reviewer or other selected colleague to confirm accuracy, clarity, and completeness. This can be skipped for minor fixes without substantive content changes.

2. Technical Writer

  • Technical writer review. If not requested for this MR, must be scheduled post-merge. To request for this MR, assign the writer listed for the applicable DevOps stage.

For more information about labels, see Technical Writing workflows - Labels.

For suggestions that you are confident don't need to be reviewed, change them locally and push a commit directly to save others from unneeded reviews. For example:

  • Clear typos, like this is a typpo.
  • Minor issues, like single quotes instead of double quotes, Oxford commas, and periods.

For more information, see our documentation on Merging a merge request.

3. Maintainer

  1. Review by assigned maintainer, who can always request/require the above reviews. Maintainer's review can occur before or after a technical writer review.
  2. Ensure a release milestone is set.
  3. If there has not been a technical writer review, create an issue for one using the Doc Review template.

Merge request reports

Loading