Documentation for Group-level protected environment
What does this MR do?
Adds doc for #215888 (closed)
Related issues
Related #215888 (closed)
Author's checklist (required)
-
Follow the Documentation Guidelines and Style Guide. - If you have Developer permissions or higher:
-
Ensure that the product tier badge is added to doc's h1
. -
Apply the documentation label, plus: - The corresponding DevOps stage and group labels, if applicable.
-
development guidelines when changing docs under
doc/development/*
,CONTRIBUTING.md
, orREADME.md
. -
development guidelines and Documentation guidelines when changing docs under
development/documentation/*
. - development guidelines and Description templates (.gitlab/*) when creating/updating issue and MR description templates.
-
Request a review from the designated Technical Writer.
-
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:
-
Update the permissions table. -
Link docs to and from the higher-level index page, plus other related docs where helpful. -
Add the product tier badge accordingly. -
Add GitLab's version history note(s). -
Add/update the feature flag section.
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. -
Ensure docs metadata are present and up-to-date. -
Ensure Technical Writing and documentation are added. -
Add the corresponding docs::
scoped label. -
If working on UI text, add the corresponding UI Text
scoped label. -
Add twdoing when starting work on the MR. -
Add twfinished if Technical Writing team work on the MR is complete but it remains open.
-
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
-
Review by assigned maintainer, who can always request/require the above reviews. Maintainer's review can occur before or after a technical writer review. -
Ensure a release milestone is set. -
If there has not been a technical writer review, create an issue for one using the Doc Review template.
Merge request reports
Activity
changed milestone to %14.0
assigned to @shinya.maeda
added documentation label
1 Message This merge request adds or changes documentation files. A review from the Technical Writing team before you merge is recommended. Reviews can happen after you merge. Documentation review
The following files require a review from a technical writer:
doc/api/group_protected_environments.md
doc/ci/environments/protected_environments.md
The review does not need to block merging this merge request. See the:
-
Metadata for the
*.md
files that you've changed. The first few lines of each*.md
file identify the stage and group most closely associated with your docs change. - The Technical Writer assigned for that stage and group.
- Documentation workflows for information on when to assign a merge request for review.
If needed, you can retry the
danger-review
job that generated this comment.Generated by
DangerEdited by Ghost Useradded 1 commit
- c8310abf - Documentation for Group-level protected environment
added 1 commit
- 451bff77 - Documentation for Group-level protected environment
marked the checklist item I have added/updated documentation, or it's not needed. (Is documentation required?) as completed
marked the checklist item I have included a changelog entry, or it's not needed. (Does this MR need a changelog?) as completed
marked the checklist item Follow the Documentation Guidelines and Style Guide. as completed
marked the checklist item Ensure that the product tier badge is added to doc's
h1
. as completedmarked the checklist item Apply the documentation label, plus: as completed
marked the checklist item Request a review as completed
added 1 commit
- 788770ce - Documentation for Group-level protected environment
added 1 commit
- 47ffd76f - Documentation for Group-level protected environment
added 1 commit
- 4bf36d8f - Documentation for Group-level protected environment
- Resolved by Achilleas Pipinellis
@kbychu This is documentation MR for Group-level permissions config for Protected Environments. Would you mind reviewing as PM? If it looks good, please click the approval button in the MR widget and pass it to @axil as the designated Technical Writer/maintainer review. Thanks!
Edited by Shinya Maeda
requested review from @kbychu
added 1 commit
- aba159c5 - Documentation for Group-level protected environment