kubernetes/minikube

Make website documentation versioned

Open

#6921 aperta il 6 mar 2020

Vedi su GitHub
 (6 commenti) (0 reazioni) (0 assegnatari)Go (5222 fork)batch import
help wantedkind/documentationlifecycle/frozenpriority/backlog

Metriche repository

Star
 (31.799 star)
Metriche merge PR
 (Merge medio 12g 19h) (43 PR mergiate in 30 g)

Descrizione

we recently updated docs that --vm-driver to --driver and that was true for head ! but not for the binary that people donwload and use.

so we need versioned documentation for HEAD and also for releases.

Guida contributor

Direzione di ricerca
Indaga il sistema di documentazione attuale nel repository di minikube (ad esempio, cerca una directory docs/, file di configurazione come config.toml o riferimenti a generatori di siti statici). Determina come viene costruita e distribuita la documentazione, in particolare come vengono gestite le versioni. Esplora se esiste un meccanismo di versioning esistente (ad esempio, utilizzando un parametro di versione in Hugo) o se è necessario implementare un nuovo sistema. Controlla i passaggi di distribuzione della documentazione nel Makefile e negli script CI/CD del repository. Esamina issue o commenti collegati per eventuali lavori o discussioni precedenti.
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.
Mezza giornata
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.
60