Skip to content

Revamp rules docs to new style

Marcel Amirault requested to merge docs-move-rules-to-job-control into master

What does this MR do?

Revamp the rules documentation to align it with the new style guide.

This MR applies the standards from https://docs.gitlab.com/ee/development/cicd/cicd_reference_documentation_guide.html, which is already in use at https://docs.gitlab.com/ee/ci/yaml/README.html#only--except.

Similar to the previous only/except changes done in the related issue, the extra details were moved to the job_control.md doc, and crosslinked as needed. The content was moved with only minor edits, as the job_control.md doc will be updated in a separate step, to make this MR easier to review.

The bulk of the changes are in the YAML reference doc, with lots of simplifications and clarifications done along with the style update.

The TOC changes look like this:

Before After
Screen_Shot_2021-06-14_at_18.54.12 Screen_Shot_2021-06-14_at_18.53.47

Related issues

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