Build out section for branch naming
What does this MR do?
As part of working Caps and special chars are OK but spaces are not (!118100 - merged) I realized the proposed one-line change to doc/user/project/merge_requests/creating_merge_requests.md
pointed to a larger problem. Nowhere in https://docs.gitlab.com/ee/user/project/repository/branches/ had we laid out the full set of rules for branch names. The one line we were changing turned out to be incomplete, and the lack of a SSOT had caused multiple parts of the answer to be scattered across several pages in our documentation. I opted to merge the Community contribution merge request as-is, and focus on building a real solution here. This merge request:
- Revamps the
Name your branch
subheading ofdoc/user/project/repository/branches/index.md
- Disallowed items: explain that branch names are subject to rules from Git and the rules GitLab layers atop the Git rules;
- Optional but encouraged items: explain that carefully-structured branch names provide extra GitLab benefits, and link out to them
- Acknowledge a 'safer' set of characters
- Acknowledge that other packages may enforce additional rules, and link to a known set of rules for Docker
- Updates various pages that discuss branch naming to point back to this new SSOT
Related issues
- Related to Caps and special chars are OK but spaces are not (!118100 - merged) which this merge request is a follow-up to
- Closes Build better listing of branch naming expectations (#408882 - closed)
Author's checklist
-
Optional. Consider taking the GitLab Technical Writing Fundamentals course. -
Follow the: -
If you're adding or changing the main heading of the page (H1), ensure that the product tier badge is added. -
If you are a GitLab team member, request a review based on: - The documentation page's metadata.
- The associated Technical Writer.
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 likeDefault behavior when you close an issue
. -
The headings (other than the page title) should be active. Instead of Configuring GDK
, say something likeConfigure 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.