Skip to content

Improve legibility of "authored branches" output

Katrin Leinweber requested to merge katrinleinweber-gtlb-master-patch-18206 into master

What does this MR do?

Improves the example command to provide table-like output. This should be more readible:

$ git for-each-ref --format='%(refname:short) %(authoremail)'  | grep $(git config --get user.email)
master-WIP-240315-1156 <kleinweber@gitlab.com>
mkozono-master-patch-a7ec-followup <kleinweber@gitlab.com>
origin/237931-job-details-page-should-display-code-coverage-even-if-0-percent <kleinweber@gitlab.com>
origin/285089-pages-separate-server-plus-custom-domains-docs <kleinweber@gitlab.com>
…

$ git for-each-ref --format='%(authoremail) %(refname:short)' | grep $(git config --get user.email)
<kleinweber@gitlab.com> master-WIP-240315-1156
<kleinweber@gitlab.com> mkozono-master-patch-a7ec-followup
<kleinweber@gitlab.com> origin/237931-job-details-page-should-display-code-coverage-even-if-0-percent
<kleinweber@gitlab.com> origin/285089-pages-separate-server-plus-custom-domains-docs
…

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.

Merge request reports