CTRT: merge request dependencies
What does this MR do?
Complete rewrite of https://docs.gitlab.com/ee/user/project/merge_requests/merge_request_dependencies.html for CTRT.
- Break apart into sections for individual tasks.
- Strip out old images. Reshoot one with new info.
- Use the text from status messages in the page for searchability.
- Shift caveats into something closer to a troubleshooting form.
- Strip out subheadings we shouldn't be using, and blend them back into the concept portion of the page.
- Completely revise Mermaid graphs to use a more sensible order, and include verbs describing the relationships to help users better understand.
Note to self: give thought to revising file name after the 22nd. There's no need for this URL to be that long:
- OLD:
doc/user/project/merge_requests/merge_request_dependencies.md
- PROPOSED:
doc/user/project/merge_requests/dependencies.md
Related issues
Related to Q3FY23 KR: Improve findability, organization, a... (technical-writing#579 - 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.