Skip to content

Adds description metadata for files in Create

Amy Qualls requested to merge 442469-aqualls-line-15-metadata into master

What does this MR do?

Adds description metadata for these six files in various devopscreate groups:

  • doc/api/commits.md
  • doc/api/repository_files.md
  • doc/user/project/codeowners/index.md
  • doc/user/project/merge_requests/approvals/index.md
  • doc/user/project/merge_requests/squash_and_merge.md
  • doc/user/project/repository/mirror/index.md

When I next start this work, I should start on line 21 of the spreadsheet.

Related issues

Related to Tracking docs metadata updates for Create (#442469 - closed)

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