Skip to content

DRAFT: Reorg project permissions tables for clarity

Mike Jang requested to merge mjang-reorg-user-permissions-doc into master

What does this MR do?

Reorg permissions tables in https://docs.gitlab.com/ee/user/permissions.html#project-members-permissions

Enable UX work in #280534 (closed)

My approach

  1. Replace https://docs.gitlab.com/ee/user/permissions.html#project-members-permissions with 5 separate sections
    • Each section should be subdivided by functionality

So far, I've taken the "Guest" permissions portion of the linked table, and organized it in a bulleted list of functionality.

To review my work "so far", navigate to http://docs-preview-ee-49618.178.62.207.141.nip.io/ee/user/permissions.html#project-members-permissions. It includes what I have in mind, for the Guest role, in http://docs-preview-ee-49618.178.62.207.141.nip.io/ee/user/permissions.html#project-members-guest-permissions

Related issues

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.
Edited by Mike Jang

Merge request reports