Skip to content

Move extra includes examples out of reference

Marcel Amirault requested to merge docs-includes-examples into master

What does this MR do?

The includes section of the yaml reference had far too many examples, so I'm moving this large list of variations into their own page, reducing the bulk of the reference.

The content was not edited, except the addition of an introduction. No files were linking to these sections, so I added links to the new page from the reference.

This will remove the 4 includes example sections, which will clean up the TOC as well:

Screen_Shot_2020-04-27_at_15.22.02

Related issues

Related to #205397 (closed)

Author's checklist (required)

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

  • 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