Skip to content

Fix metadata for topic to be deleted

Evan Read requested to merge eread/fix-meta-data-for-topic-to-be-deleted into master

What does this MR do?

@jglassman1 @marcel.amirault @ashrafkhamis were troubleshooting a problem with bundle exec rake docs:clean_redirects:

In ../gitlab/doc/development/integrations/codesandbox.md, remove date: 2023-02-01 is less than today (2023-02-20).
rake aborted!
NoMethodError: undefined method `start_with?' for nil:NilClass

The problem was that doc/development/integrations/codesandbox.md didn't have complete metadata and the Rake task couldn't tolerate it: https://gitlab.com/gitlab-org/gitlab-docs/-/blob/b6e5c8d3d8b864120ff6b07e6e11122d882a6387/lib/tasks/redirects.rake#L70.

This MR adds the necessary metadata

Author's checklist

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 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 reviews above. Maintainer's review can occur before or after a technical writer review.

Merge request reports