Skip to content

Branches: condense multiple sections, strip old images

Amy Qualls requested to merge 393187-aqualls-branches-ctrt-sorta into master

What does this MR do?

Significant revision to https://docs.gitlab.com/ee/user/project/repository/branches/ which is old and crusty. Prep work for what I know is coming in 15.11.

  • Renames subheads in accordance with style guide
  • Strips out some painfully old images
  • Condenses three subheadings into one. Another couple of cases of "every time a new field was added, we added a new subheading."
  • Polishes random phrasing in a few places.

Doesn't complete the page, but brings it much more in line with current expectations, and will allow the %15.11 work to flow more easily.

Related issues

Related to Better display of tags and branches in commit d... (#325871 - closed) - this merge request helps prepare a better landing place for the revamp that will happen in %15.11.

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