GoogleContainerTools/skaffold

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

Offen

#6.589 geöffnet am 10.09.2021

Auf GitHub ansehenContributor Guide
 (4 Kommentare) (0 Reaktionen) (1 zugewiesene Person)Go (1.416 Forks)batch import
area/docsdocs-fixitgood first issuehelp wantedkind/documentationkind/todopriority/p2

Repository-Metriken

Stars
 (12.822 Sterne)
PR-Merge-Metriken
 (Durchschn. Merge 3T 6h) (16 gemergte PRs in 30 T)

Beschreibung

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-Richtung
Scannen Sie das Verzeichnis docs/content/en nach inline skaffold.yaml Snippets, verschieben Sie jedes nach docs/content/en/samples mit geeigneter Benennung und ersetzen Sie das inline Snippet durch einen {{% readfile file="samples/path to file" %}} Shortcode. Überprüfen Sie vorhandene Beispiele auf Namenskonventionen.
Tech Stack
go
Domain
documentation
Issue Type
Dokumentation
SchwierigkeitGeschätzte Implementierungsschwierigkeit für neue Contributors, von 1 für sehr kleine Änderungen bis 5 für Expertenarbeit.
2
Geschätzte ZeitEin grober Zeitrahmen, um zu recherchieren, zu implementieren, zu testen und einen Pull Request vorzubereiten.
1-3 Stunden
AktivitätsstatusWie verfügbar das Issue gerade wirkt: frisch, aktiv, stale, blockiert oder wartet auf Maintainer-Input.
Aktiv
KlarheitWie klar das Issue die erwartete Änderung, Akzeptanzkriterien und den nächsten Schritt erklärt.
Klar
Voraussetzungen
GitMarkdownYAML
EinsteigerfreundlichkeitEin Score von 1 bis 100, der schätzt, wie zugänglich dieses Issue für First-Time Contributors ist.
80