Skip to content

Add HTML comment to prevent breaking Rake task

Amy Qualls requested to merge docs-aqualls-add-helpful-comment into master

What does this MR do?

Adds a HTML comment to doc/development/documentation/redirects.md that says "if you move the location of this page, you need to update the Rake task in the gitlab-docs directory to prevent future sadness.

🤔 If, in our CLI string to determine deletion candidates, we could incorporate something like a head command to only grab the first few lines, we could probably make that Rake task a bit more future-proof.

Sending over to Suzanne for review - I don't think we have any style recommendations for when lines like these are needed, but let's make sure.

Related issues

Author's checklist

If you are only adding documentation, do not add any of the following labels:

  • ~"feature"
  • ~"frontend"
  • ~"backend"
  • ~"bug"
  • ~"database"

These labels cause the MR to be added to code verification QA issues.

Review 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.
    • 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 like Default behavior when you close an issue.
      • The headings (other than the page title) should be active. Instead of Configuring GDK, say something like Configure 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 above reviews. Maintainer's review can occur before or after a technical writer review.
  • Ensure a release milestone is set.
Edited by Amy Qualls

Merge request reports

Loading