Clean up merge request approvals API page
What does this MR do?
In Update documentation for selective code owner r... (!96550 - merged) I noticed changes were being applied to a table that wasn't in alphabetical order. When I looked more closely at the page, I saw lots of small things to clean up.
Taken as a whole, this merge request looks more painful to review than it actually is. If you look one commit at a time, you'll see I batched changes of a particular type together in a single commit to make reviews easier:
- !96798 (c9cac4e4) removes long spaces at the end of table rows.
- !96798 (0ea092eb) strips outdated version information.
-
!96798 (c4e2fad3) re-sorts the table data into a modified alphabetical order. I put the (likely) primary key of the table first (it's usually really easy to tell, it's almost always
id
) and then the rest of the fields in alphabetical order -
!96798 (15defa65) tidies up the contents of individual rows. Fix capitalization, standardize punctuation, spell out words. Most importantly: lightly edit a couple of deprecation lines to match the string
GitLab 12.x
(instead of justversion 12.x
) so these lines will be flagged by Vale in the future. - !96798 (f6528279) moves required parameters to the top of each table in alphabetical order
I need to make a follow-up issue regarding item 4 to ask someone in groupsource code to tell me if those GitLab 12.x deprecation lines can be removed entirely. I can't tell and it's out of scope of this merge request anyway.
Related issues
- Related to !96550 (merged) where the need was spotted
- Closes Follow-up from "Update documentation for select... (#372334 - closed)
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 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.