Skip to content

Updates to default-branch info

Amy Qualls requested to merge 378499-aqualls-better-crosslink-vars into master

What does this MR do?

Addresses concerns in Write documentation for default branch names fr... (#378499 - closed) about information for updated branches. The questions I still needed to address:

  1. Do the docs say that the fields Default branch and Branch name template are now listed under Branch defaults? (This location changed some time ago.)
  2. Create a better, more obvious cross-link between Create a branch from an issue to the instructions further down the page, and make clear that variables are available.
  3. Make sure the %{id} and %{title} variables are documented.
  4. Check what tiers can create branches from issues.

So far, only one of the items actually needed a change, but I still need confirmation on what tiers can create branches from issues. I'll need to send that question over to a groupsource code engineer.

Related issues

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