Add announcement + history for admin perms change
What does this MR do?
Now that the feature has landed (with very very MVC docs), let's step back and figure out the full docs ramifications. @jwoodwardgl provided useful info here that tipped me off that more changes were needed:
We've changed the protected ref access logic to prevent admin users from being able perform actions on protected refs unless they have been explicitly allowed to do so. These actions include pushing and merging into a protected branch, unprotecting a branch, and creating protected tags.
Here's what I see is needed:
-
Check the protected-branches page. -
Check the protected-tags page. -
Create a breaking-change announcement
Related issues
- Related to Remove admin override for ProtectedRef Access (!118532 - merged) which introduced the change
- Related to Update who can modify a protected branch (!117737 - merged) which did the first part of the docs
- Related to Inconsistent behaviour for instance administrat... (#12776 - closed)
- Related to Display of fields in Protected Tags admin UI page (#409894 - closed) which is the UX issue I filed because I got so frustrated by not being able to read the fields
Author's checklist
-
Optional. Consider taking the GitLab Technical Writing Fundamentals course. -
Follow the: -
If you're adding or changing the main heading of the page (H1), ensure that the product tier badge is added. -
If you are a GitLab team member, request a review based on: - The documentation page's metadata.
- The associated Technical Writer.
If you are a GitLab team member and only adding documentation, do not add any of the following labels:
~"frontend"
~"backend"
~"type::bug"
~"database"
These labels cause the MR to be added to code verification QA issues.
Reviewer's checklist
Documentation-related MRs should be reviewed by a Technical Writer for a non-blocking review, based on Documentation Guidelines and the Style Guide.
If you aren't sure which tech writer to ask, use roulette or ask in the #docs Slack channel.
-
If the content requires it, ensure the information is reviewed by a subject matter expert. - Technical writer review items:
-
Ensure docs metadata is present and up-to-date. -
Ensure the appropriate labels are added to this MR. -
Ensure a release milestone is set. - If relevant to this MR, ensure content topic type principles are in use, including:
-
The headings should be something you'd do a Google search for. Instead of Default behavior
, say something likeDefault behavior when you close an issue
. -
The headings (other than the page title) should be active. Instead of Configuring GDK
, say something likeConfigure GDK
. -
Any task steps should be written as a numbered list. - If the content still needs to be edited for topic types, you can create a follow-up issue with the docs-technical-debt label.
-
-
-
Review by assigned maintainer, who can always request/require the reviews above. Maintainer's review can occur before or after a technical writer review.
Merge request reports
Activity
changed milestone to %16.0
added Category:Source Code Management Deliverable Enterprise Edition SLONear Miss Technical Writing backend backend-weight2 customer devopscreate docsfeature documentation groupsource code maintenancerefactor missed-deliverable missed:14.10 missed:14.3 missed:14.9 missed:15.11 missed:15.3 missed:15.4 permissions priority2 sectiondev severity2 tw-weight5 twdoing typebug workflowin review labels
assigned to @aqualls
added typemaintenance label and removed typebug 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/update/removals.md
(Link to current live version) -
doc/user/project/protected_branches.md
(Link to current live version) -
doc/user/project/protected_tags.md
(Link to current live version)
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
Danger-
removed SLONear Miss label
removed priority2 label
removed sectiondev label
removed severity2 label
added sectiondev label
removed missed-deliverable label
removed missed:14.10 label
removed missed:14.3 label
removed missed:14.9 label
removed missed:15.11 label
removed missed:15.3 label
removed missed:15.4 label
- Resolved by Jon Glassman
@jwoodwardgl @tlinz I'd like both of you to review what I've done here:
- Both of you: please forgive the extra work I had to do on the protected-tags page. The instructions were incomplete, and the images were from 12.x.
I deleted the images and updated the text. - Torsten: please look at the breaking-change announcement.
- Joe: please look at the entirety of the protected-tags page, and the protected-branches page. Not just my changes. Is there ANY additional wording that needs corrections or changes?
Extra consideration for Joe: what about https://docs.gitlab.com/ee/api/protected_tags.html and https://docs.gitlab.com/ee/api/protected_branches.html ? Any changes needed there?
Let me know, and then I'll get this work over to another writer for review.
- Both of you: please forgive the extra work I had to do on the protected-tags page. The instructions were incomplete, and the images were from 12.x.
requested review from @tlinz and @jwoodwardgl
mentioned in merge request !118532 (merged)
mentioned in merge request !117737 (merged)
@jwoodwardgl
, thanks for approving this merge request.This is the first time the merge request is approved. To ensure full test coverage, a new pipeline will be started shortly.
For more info, please refer to the following links:
added pipeline:mr-approved label
I grumbled about the text I couldn't read, so I filed Display of fields in Protected Tags admin UI page (#409894 - closed) to document what I think is a UX bug. It's probably easy to fix … if you're a frontend engineer.
- Resolved by Jon Glassman
Assigning over to @jglassman1 for review / edit / maybe merge.
requested review from @jglassman1
added 1110 commits
-
648ce437...7486da83 - 1108 commits from branch
master
- 7a24541c - Add announcement + history for admin perms change
- 99c1b3a6 - Rewrite protected-tags section for style
-
648ce437...7486da83 - 1108 commits from branch
added 15 commits
-
99c1b3a6...0428148a - 12 commits from branch
master
- ef09e75c - Add announcement + history for admin perms change
- d8a5dcb4 - Rewrite protected-tags section for style
- 539db651 - Rebuild removals page
Toggle commit list-
99c1b3a6...0428148a - 12 commits from branch
mentioned in commit 9b0df76e
added workflowstaging-canary label and removed workflowin review label
added workflowcanary label and removed workflowstaging-canary label
added workflowstaging label and removed workflowcanary label
added workflowproduction label and removed workflowstaging label
added workflowpost-deploy-db-staging label and removed workflowproduction label
added workflowpost-deploy-db-production label and removed workflowpost-deploy-db-staging label
added releasedcandidate label
I can't seem to find the updated documents for the GitLab administrators must have permission to modify protected branches or tags removal (deprecation issue).
So far, all i've found is this note:
Branch push permission changed to require GitLab administrators to also have the allowed permission in GitLab 16.0. here
I'm preparing to upgrade our self-managed GL Ultimate instance to 16, so more complete or more easily located documentation would be helpful.
For example, can I grant the allowed permission to GitLab administrators as a "role" or must I grant it to each individual human who is an administrator? Must I do so at the project level or can I do so at the group level? etc
mentioned in merge request gitlab-com/www-gitlab-com!122228 (merged)
mentioned in merge request !132337 (merged)