GoogleContainerTools/skaffold

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

Aperta

#6840 aperta il 11 nov 2021

Vedi su GitHubGuida contributor
 (2 commenti) (0 reazioni) (0 assegnatari)Go (1416 fork)batch import
area/docsarea/onboardingbugbash/q4-2022help wantedkind/documentationkind/todo

Metriche repository

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

Descrizione

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.

Guida contributor

Direzione di ricerca
Esamina la struttura della documentazione esistente per quickstart e tutorial per determinare dove aggiungere file skaffold.yaml di esempio e quali configurazioni comuni mostrare.
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
Git
Adatta ai principiantiQuanto la issue è adatta a contributor alla prima esperienza.
80