Document supported branch name template variables

What does this MR do?

Documents the supported variables for branch name templates.

Lack of documented information was reported by a customer via a Zendesk ticket(internal)

Related issues

• !93108 (merged)
• !108985 (merged)

Author's checklist

• Optional. Consider taking the GitLab Technical Writing Fundamentals course.
• Follow the:
  • Documentation process.
  • Documentation guidelines.
  • Style Guide.
• 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 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.

added Support Team Contributions docsimprovement documentation maintenancerefactor typemaintenance labels

requested review from @aqualls

assigned to @j.castillo

	1 Message
	This merge request adds or changes documentation files. A review from the Technical Writing team before you merge is recommended. Reviews can happen after you merge.

Documentation review

The following files require a review from a technical writer:

• doc/user/project/merge_requests/creating_merge_requests.md (Link to current live version)
• doc/user/project/repository/branches/default.md (Link to current live version)

The review does not need to block merging this merge request. See the:

• Metadata for the *.md files that you've changed. The first few lines of each *.md file identify the stage and group most closely associated with your docs change.
• The Technical Writer assigned for that stage and group.
• Documentation workflows for information on when to assign a merge request for review.

If needed, you can retry the danger-review job that generated this comment.

Generated by Danger

While putting this together, I wondered if Branch name templates should have a dedicated section that could be linked to instead.

changed milestone to %15.10

approved this merge request

added Technical Writing label

added devopscreate docsfeature featureenhancement groupcode review tw-weight3 twfinished typefeature labels and removed docsimprovement typemaintenance labels

removed maintenancerefactor label

changed milestone to %15.9

added sectiondev label

added 1 commit

• b8e62f64 - Revisions for tone and style

Compare with previous version

@j.castillo You had no way of knowing this, but you just solved a problem I've had over the past month. Before I got sick in January (and then swapped to a new laptop) I had a tab open for a feature that had landed without documentation. I knew I needed to do the docs work. After I got sick and changed laptops? Tab gone, poof, forever.

I've been trying to remember what merge request it was. It was Configure branch name for creating MR from an i... (!93108 - merged)!

You just did me a solid, sir. I'm getting your work merged now, with some minor edits, and I can turn around to work on the docs now that I have the merge request.

Awesome! I'm glad I could help you find that to get started.

enabled an automatic merge when the pipeline for 78383406 succeeds

merged

mentioned in commit c55da821

added workflowstaging-canary label

added workflowcanary label and removed workflowstaging-canary label

added workflowstaging label and removed workflowcanary label

added workflowproduction label and removed workflowstaging label

added workflowpost-deploy-db-staging label and removed workflowproduction label

added workflowpost-deploy-db-production label and removed workflowpost-deploy-db-staging label

added releasedcandidate label

mentioned in issue gitlab-com/support/support-team-meta#4918 (closed)

mentioned in merge request !115276 (merged)

added releasedpublished label and removed releasedcandidate label

mentioned in issue #463264