Skip to content

Move the tags page from topics/ to UI directory

Amy Qualls requested to merge 325871-aqualls-tags-tags-tags into master

What does this MR do?

We've never had a page devoted to tags in the GitLab UI before. We HAVE, however, had https://docs.gitlab.com/ee/topics/git/tags.html which covers the Git basics of creating a tag. Rather than creating a page and having two separate locations for information, I've opted to move the contents of doc/topics/git/tags.md to a new page doc/user/project/repository/tags/index.md that will allow us to keep the previous information, and stack on the GitLab-specific information that we've somehow never documented.

Aside: I chose doc/user/project/repository/tags/ because doc/user/project/repository/branches/ exists, and it makes for a nice, parallel structure.

Related issues

Related to Better display of tags and branches in commit d... (#325871 - closed) so the work coming up in the next milestone has a place to land in the documentation.

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.
Edited by Amy Qualls

Merge request reports

Loading