GoogleContainerTools/skaffold

docs: No example skaffold.yaml files users can copy/paste to get started

Offen

#6.840 geöffnet am 11.11.2021

Auf GitHub ansehenContributor Guide
 (2 Kommentare) (0 Reaktionen) (0 zugewiesene Personen)Go (1.416 Forks)batch import
area/docsarea/onboardingbugbash/q4-2022help wantedkind/documentationkind/todo

Repository-Metriken

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

Beschreibung

The skaffold.dev website is currently lacking any simple skaffold.yaml files that users can copy paste.

  • The quickstart points (without a hyperlink) to the examples repo by telling users to clone it.
  • Tutorials require users to "Run in Cloud Shell" etc. (except two of them with more advanced titles do have skaffold.yaml embedded in them).

I think we ought to show users a basic skaffold.yaml as part of the Getting Started experience.

Contributor Guide

Research-Richtung
Untersuche die bestehende Dokumentationsstruktur für Quickstart und Tutorials, um festzustellen, wo Beispiel skaffold.yaml Dateien hinzugefügt werden sollen und welche gängigen Konfigurationen gezeigt werden.
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
Git
EinsteigerfreundlichkeitEin Score von 1 bis 100, der schätzt, wie zugänglich dieses Issue für First-Time Contributors ist.
80