Skip to content

Improve clarity for merged results pipeline labels

Manuel Grabowski requested to merge docs/mg-merged-results-label-20230927 into master

What does this MR do?

This is extremely minor, but a bunch of us SEs recently almost tripped over it: The way this currently looks on the rendered page makes it so that on a visual skim of the page, you're left with a strong impression that merged result pipelines are labeled with the the merge request label. This is because the link title alone says just that, and because the final two lines are separated by a blank line even though they logically belong together very strongly. The second line describes what happens when the first line is true. Making it into a single, bigger paragraph should give an indication that closer inspection is required instead of just looking at the link title.

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