GoogleContainerTools/skaffold

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

Open

#6,589 opened on Sep 10, 2021

View on GitHub
 (4 comments) (0 reactions) (1 assignee)Go (1,416 forks)batch import
area/docsdocs-fixitgood first issuehelp wantedkind/documentationkind/todopriority/p2

Repository metrics

Stars
 (12,822 stars)
PR merge metrics
 (Avg merge 3d 6h) (16 merged PRs in 30d)

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 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

Research direction
Scan the docs/content/en directory for inline skaffold.yaml snippets, move each to docs/content/en/samples with proper naming, and replace the inline snippet with a {{% readfile file="samples/path to file" %}} shortcode. Check existing samples for naming conventions.
Tech stack
go
Domain
documentation
Issue type
Documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
GitMarkdownYAML
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
80