Skip to content

Docs: Keep > characters outside the bold for more accurate UI text in docs

Everyone can contribute. Help move this issue forward while earning points, leveling up and collecting rewards.

Hi community contributors! 👋

Do you want to work on this issue? Please follow all instructions below, and please work on only 3-5 files at a time, to give everyone a chance to contribute. Thank you!

MRs created for this issue between October 1st and 7th, 2025, are eligible for the latest GitLab Hackathon!

If you are new contributing, see: https://about.gitlab.com/community/contribute/. The linked tutorial will help you get started as a contributor!

UPDATE: All lines in the spreadsheet have volunteers (or have already been fixed), so there is no more work available for this issue. Thanks for your participation!

Problem to solve

We use the > character to explain steps to follow in the UI, for example:

  • Select Overview > Users.

But in the markdown, we should keep this outside the bold (**) formatting. This ensures that we only use bold on UI text, which is our guidance: https://docs.gitlab.com/development/documentation/styleguide/#bold

Good

Select **Overview** > **Users**.

Bad

Select **Overview > Users**.

The work we need to do in this issue is to pull the > character out of the bold.

Implementation plan

You don't need to be assigned to this issue to work on it. To contribute:

  1. Open this spreadsheet and go to the Latest navigation formatting issues tab.
  2. Find some files you want to work on, and put your username in the rows for those files.
    • All of the files are in the doc folder in the GitLab repo.
    • Assign yourself to 3-5 files, or around 20-30 changes at most. There are many files available to update, so please do not create many small merge requests that only change 1 or 2 lines.
      • For any files you select, please fix all instances in those files at the same time. Do not create multiple merge requests for the same files.
  3. Open a merge request using the Documentation merge request description template. For details with how to open a merge request, see Contribute to the GitLab documentation.
  4. In the merge request description, include this text: https://gitlab.com/gitlab-org/gitlab/-/issues/554157
  5. Try to stick to the scope of the issue. If you see other improvements that can be made in the file, open a separate merge request.

Thank you in advance for your contribution!

Edited by Marcel Amirault