GoogleContainerTools/skaffold

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

Aperta

#6589 aperta il 10 set 2021

Vedi su GitHubGuida contributor
 (4 commenti) (0 reazioni) (1 assegnatario)Go (1416 fork)batch import
area/docsdocs-fixitgood first issuehelp wantedkind/documentationkind/todopriority/p2

Metriche repository

Star
 (12.822 stelle)
Metriche merge PR
 (Merge medio 3g 6h) (16 PR mergiate in 30 g)

Descrizione

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.

Guida contributor

Direzione di ricerca
Esamina la directory docs/content/en per snippet skaffold.yaml inline, sposta ciascuno in docs/content/en/samples con una denominazione appropriata e sostituisci lo snippet inline con un shortcode {{% readfile file="samples/path to file" %}}. Controlla i campioni esistenti per le convenzioni di denominazione.
Tech stack
go
Dominio
documentation
Tipo issue
Documentazione
DifficoltàQuanto dovrebbe essere impegnativa per un nuovo contributor.
2
Tempo stimatoTempo stimato per completare e verificare uno scope piccolo.
1-3 ore
Stato attivitàQuanto è probabile che la issue sia ancora attiva e reviewable.
Attiva
ChiarezzaQuanto chiaramente la issue descrive problema, scope e risultato atteso.
Chiara
Prerequisiti
GitMarkdownYAML
Adatta ai principiantiQuanto la issue è adatta a contributor alla prima esperienza.
80