Skip to content

Doc: Update style guide to be based more on itself

Craig Norris requested to merge docs-style-guide-update-standard into master

What does this MR do?

This update to the Style Guide is a set of changes to get it closer to a style that we regularly encourage the TWs and contributors to use when they work on GitLab product documentation. I apologize that this MR contains changes throughout the guide, so while they're smaller changes, there are a number of them throughout the whole. And, I also apologize that I attempted to have the guide standardize on the underscore for italics, instead of the single asterisk. Why? Well, I think the doc should settle in one choice, and the underscore is visually distinctive from the asterisk, helping one at a glance see bold codes and italics codes.

If you have any questions or comments about this MR, please let me know.

Author's checklist (required)

Do not add the feature, frontend, backend, ~"bug", or database labels if you are only updating documentation. These labels will cause the MR to be added to code verification QA issues.

When applicable:

Review checklist

All reviewers can help ensure accuracy, clarity, completeness, and adherence to the Documentation Guidelines and Style Guide.

1. Primary Reviewer

  • Review by a code reviewer or other selected colleague to confirm accuracy, clarity, and completeness. This can be skipped for minor fixes without substantive content changes.

2. Technical Writer

  • Technical writer review. If not requested for this MR, must be scheduled post-merge. To request for this MR, assign the writer listed for the applicable DevOps stage.

For more information about labels, see Technical Writing workflows - Labels.

3. Maintainer

  1. Review by assigned maintainer, who can always request/require the above reviews. Maintainer's review can occur before or after a technical writer review.
  2. Ensure a release milestone is set.
  3. If there has not been a technical writer review, create an issue for one using the Doc Review template.

Merge request reports

Loading