Docs feedback: CI Cache edge cases not described

Everyone can contribute. Help move this issue forward while earning points, leveling up and collecting rewards.

• Close this issue

Problem to solve

• Setting up CI pipeline - docs have outdated examples
• CI caching documentation seem insufficent

Further details

• Getting Started with CI/CD in official docs ends with an example file - but viewing the docs for the YAML settings says many of the global keys in the example are outdated and could be deprecated
• the example file for Caching: How Archiving and Extracting Works shows a cache entry with no paths key - this doesn't appear to be valid syntax, since without it, the cache appears to not be pulled down, contrary to what is described
• the docs say that the cache: policy defined in a default block will apply to jobs that do not override it, but the docs fail to mention that if you include paths, the policy reverts back to pull-push

Proposal

• fix the getting started guide to not use outdated global keys
• fix the example file to explain how caching works with and with paths defined (i.e. it doesn't?)
• fix the docs to indicate that policy must always be defined in a local job, and won't be inherited from a default block, if paths are included

Who can address the issue

Someone with more knowledge of the inner workings of the YAML file than I.

Other links/references