Skip to content

Revamp CI/CD cache reference docs

Marcel Amirault requested to merge docs-cache-reference-update into master

What does this MR do?

Related to #333941 (closed)

Updates the CI/CD cache reference material to use the new style: https://docs.gitlab.com/ee/development/cicd/cicd_reference_documentation_guide.html

Moves the Use multiple caches section and the Fallback cache key section to /doc/ci/caching/index.md. As a result, I moved the two Share caches... example sections down to the #common-use-cases section, which seemed to work better after I copied the other sections over.

I also adds some crosslinks that make it easier to find additional examples and related information.

Before After
Screen_Shot_2021-06-17_at_22.44.38 Screen_Shot_2021-06-17_at_22.50.22

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