GoogleContainerTools/skaffold

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

Ouverte

#6 589 ouverte le 10 sept. 2021

Voir sur GitHubGuide contributeur
 (4 commentaires) (0 réaction) (1 personne assignée)Go (1 416 forks)batch import
area/docsdocs-fixitgood first issuehelp wantedkind/documentationkind/todopriority/p2

Métriques du dépôt

Stars
 (12 822 étoiles)
Métriques de merge PR
 (Merge moyen 3j 6h) (16 PRs mergées en 30 j)

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.

Guide contributeur

Direction de recherche
Scannez le répertoire docs/content/en pour les extraits skaffold.yaml en ligne, déplacez chacun dans docs/content/en/samples avec un nom approprié et remplacez l'extrait en ligne par un shortcode {{% readfile file="samples/path to file" %}}. Vérifiez les exemples existants pour les conventions de nommage.
Stack technique
go
Domaine
documentation
Type d'issue
Documentation
DifficultéDifficulté estimée pour un nouveau contributeur, de 1 pour un très petit changement à 5 pour un travail expert.
2
Temps estiméFourchette de temps approximative pour investiguer, implémenter, tester et préparer une pull request.
1-3 heures
Statut d'activitéDisponibilité apparente de l'issue : fraîche, active, ancienne, bloquée ou en attente d'un mainteneur.
Active
ClartéClarté avec laquelle l'issue explique le changement attendu, les critères d'acceptation et la prochaine étape.
Claire
Prérequis
GitMarkdownYAML
Accessibilité débutantScore de 1 à 100 estimant l'accessibilité de cette issue pour un premier contributeur.
80