Skip to content

Reorder ci yaml reference doc

Marcel Amirault requested to merge docs-ci-reference-revamp-1 into master

What does this MR do?

This MR is attempting to organize the massive ci reference doc into more logical groupings/orderings.

No content was edited, it was moved as-is. A few headers were slightly adjusted to match the topic better.

The biggest changes:

  • Separate global parameters and regular (job-based) parameters into their own sections (since they work differently)
  • Separate Variable-related parameters into their own section as well.
  • Move related parameters to be next to each other
  • Move some parameters higher on the list, for example:
    • rules higher than only/except, which is no longer recommended
  • Nest a few parameters under "parent" parameters that they depend on, for example:
    • dependencies doesn't work without artifacts
    • services is related to images
  • Move deprecations to the end.

TOC Before / After

(sorry for the size/color)

Screen_Shot_2020-04-21_at_0.02.00

Related issues

#205397 (closed)

Author's checklist

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

  • Optional: 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.

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 🤖 GitLab Bot 🤖

Merge request reports