Mention `rubocop:todo` for temporary inline disables in RuboCop docs
What does this MR do?
This MR clarifies the use of rubocop:todo
in https://docs.gitlab.com/ee/development/rubocop_development_guide.html#disabling-rules-inline.
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 @splattael
marked the checklist item I have evaluated the MR acceptance checklist for this MR. as completed
changed milestone to %16.7
added Engineering Productivity documentation labels
added docsimprovement maintenancerefactor typemaintenance labels
marked the checklist item If you're adding or changing the main heading of the page (H1), ensure that the product tier badge is added. as completed
marked the checklist item If you are a GitLab team member, request a review based on: as completed
- Resolved by Doug Stull
Can you review this MR?
requested review from @robotmay_gitlab
mentioned in issue #428053
- 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 Usermentioned in epic &11989
added docs-only label
requested review from @dstull and removed review request for @robotmay_gitlab