GoogleContainerTools / GoogleContainerTools/skaffold

[Docs] Move all inline `skaffold.yaml` snippets to `docs/content/en/samples`

Open
#6,589 4 comments 0 reactions 1 assignee Assigned to @renzodavid9 View on GitHub
area/docs docs-fixit good first issue help wanted kind/documentation kind/todo priority/p2
Dominant language
Go
Stars
15.9k
Forks
1.7k
Avg merge
3d 9h
Merged PRs (30d)
10

Description

Currently there exist skaffold config snippets strewn inline with rest of the docs. These can get stale very quickly. The correct place for these snippets is in [docs/content/en/samples](https://github.com/GoogleContainerTools/skaffold/tree/main/docs/content/en/samples) directory which has schema validations run as part of unit tests; and referenced in markdown using:
```
{{% readfile file="samples/path-to-file" %}}
```

> This is a tracking issue to scan the docs and relocate these snippets.

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.