Skip to content

Improve CI/CD script documentation

Marcel Amirault requested to merge docs-yaml-ing-words into master

What does this MR do?

I started to work on a copy edit to improve CI YAML doc, focusing on "ing" words, based on the related issue below. During this edit, I realized there was a long overdue change I needed to make to the script documentation (see other issue):

  • before_script and after_script needed to be split into their own sections. They are keywords on their own, and they work differently, so they should be documented separately. This makes the examples clearer as well.
  • "tricks" to get code coloring and multi-line commands in script sections should be moved into their own docs, as they aren't really explaining how to use the script CI/CD keywords themselves. This will allow more extensive examples in the new doc as well, as some of the details are different for different shells/OSes.
  • The YAML anchors for the different types of scripts can all be combined into one.

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