kubernetes/minikube

Make website have versions matching releases

Aperta

#12.391 aperta il 2 set 2021

Vedi su GitHubGuida contributor
 (3 commenti) (0 reazioni) (0 assegnatari)Go (5222 fork)batch import
help wantedkind/documentationlifecycle/frozenpriority/backlog

Metriche repository

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

Descrizione

I just addressed a PR (#12387) where a user was proposing to remove a flag from the documentation because when they ran --help on the latest version of minikube that flag wasn't present. This was because the PR (#11553) that added the flag was merged after last release, so the documentation was updated but the feature doesn't yet exist in the latest version of minikube.

Thought this was worth discussing since this can be confusing to users if they read a flag or new command in the documentation but it's not actually available in the latest version of minikube. Maybe we cam have a way to only update documentation on the website after a release.

Guida contributor

Direzione di ricerca
Esplora come versionare la documentazione del sito web di minikube per abbinarla ai rilasci. Cerca modi per taggare le versioni della documentazione nel repository o utilizzare un branch separato per ogni rilascio. Indaga come altri progetti gestiscono questo aspetto.
Tech stack
go
Dominio
documentation
Tipo issue
Funzionalità
DifficoltàQuanto dovrebbe essere impegnativa per un nuovo contributor.
3
Tempo stimatoTempo stimato per completare e verificare uno scope piccolo.
1-2 giorni
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.
40