Skip to content

Add style guide for YAML reference

Marcel Amirault requested to merge docs-ci-reference-style-guide into master

What does this MR do?

As part of our effort to improve the YAML reference, we need a simple style that engineers can easily copy and reused throughout the reference. We also want a style that helps make the page more scannable, which improves the usability for our users. This style is based on the final style used in !58880 (merged), and can be seen for only and except right now.

The style should make the page drier, and much more similar to an API reference, with only the basic details about the keyword syntax and use. Extra details, use cases, and complicated examples should be documented separately. For example, only/except now has a separate page with more use cases and examples: https://docs.gitlab.com/ee/ci/jobs/job_control.html#onlyrefs--exceptrefs-examples

Related issues

Resolves #324798 (closed)

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.

For suggestions that you are confident don't need to be reviewed, change them locally and push a commit directly to save others from unneeded reviews. For example:

  • Clear typos, like this is a typpo.
  • Minor issues, like single quotes instead of double quotes, Oxford commas, and periods.

For more information, see our documentation on Merging a merge request.

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.
Edited by Marcel Amirault

Merge request reports

Loading