Removals: Link to deprecation issue, make formatting consistent
What does this MR do?
Essentially it does the same thing as !120200 (merged), but for removals instead of deprecations.
This MR also adopts the newer, less
Quoting from that MR:
Deprecation issues are required, as stated in the YAML template, MR template, and the handbook. But, deprecation notices don't automatically link to those issues. So, you have to reference the deprecation issue in the text of your notice if you want to direct users to the issue.
This MR:
- Adds a link to the deprecation issue, if it's provided.
- Adjusts the wording of the breaking-change notice to avoid confusion as reported in gitlab-com/Product#5558 (comment 1372612533).
Suggestion: Let's not merge this until all the pending removal MRs are merged. If we merge it earlier, we'll force everyone with removals still pending to re-run the rake task. I think we could:
- Allow pending removal MRs to merge by the 17th.
- Re-run the rake task and merge this MR on the 18th.
Related issues
gitlab-com/Product#5558 (comment 1384202041)
Screenshots
Before | After |
---|---|
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.