Remove really old TODO items
What does this MR do?
There are some ToDo's in this docs section that links to really old issues that are almost all closed.
This MR should remove those.
Related issues
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
assigned to @alvin
- A deleted user
added development guidelines label
1 Message This MR contains docs in the /development directory. Any Maintainer, other than the author, can merge. You do not need tech writer review. If needed, you can retry the
danger-review
job that generated this comment.Generated by
DangerEdited by Ghost Useradded docs-only label
@marcel.amirault I was going to ask Jacob about this (since he introduced the changes) but he is not at GitLab anymore. Both of the issues are closed now so I think we can remove these?
requested review from @marcel.amirault
added Technical Writing devopssystems docsnon-content groupgitaly labels and removed docsimprovement label
added sectioncore platform label
- Resolved by Evan Read
@alvin There is another TODO a little higher up that probably could be removed too. At the same time, while quickly looking into this, I also discovered: !104758. Let's ask about this.
@eread @bprescott_ @andrashorvath This dev doc has not been touched by any engineer since it was originally introduced over 4+ years ago (every edit since then has been by folks doing routine site-wide cleanup work). Is it even still relevant?
removed review request for @marcel.amirault
- A deleted user
added docsimprovement label and removed docsnon-content label
requested review from @eread
changed milestone to %16.9
enabled an automatic merge when the pipeline for 334454d2 succeeds