kubernetes/minikube

Make website documentation versioned

Open

#6 921 ouverte le 6 mars 2020

Voir sur GitHub
 (6 commentaires) (0 réactions) (0 assignés)Go (5 222 forks)batch import
help wantedkind/documentationlifecycle/frozenpriority/backlog

Métriques du dépôt

Stars
 (31 799 stars)
Métriques de merge PR
 (Merge moyen 12j 19h) (43 PRs mergées en 30 j)

Description

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.

Guide contributeur

Direction de recherche
Étudiez le système de documentation actuel dans le dépôt minikube (par exemple, recherchez un répertoire docs/, des fichiers de configuration comme config.toml ou des références à des générateurs de sites statiques). Déterminez comment la documentation est construite et déployée, en particulier comment les versions sont gérées. Explorez s'il existe un mécanisme de versionnage existant (par exemple, en utilisant un paramètre de version dans Hugo) ou si un nouveau système doit être implémenté. Vérifiez les étapes de déploiement de la documentation dans le Makefile et les scripts CI/CD du dépôt. Examinez les issues ou commentaires liés pour tout travail ou discussion antérieure.
Stack technique
go
Domaine
documentation
Type d'issue
Documentation
DifficultéDifficulté estimée pour un nouveau contributeur, de 1 pour un très petit changement à 5 pour un travail expert.
2
Temps estiméFourchette de temps approximative pour investiguer, implémenter, tester et préparer une pull request.
Une demi journée
Statut d'activitéDisponibilité apparente de l'issue : fraîche, active, ancienne, bloquée ou en attente d'un mainteneur.
Active
ClartéClarté avec laquelle l'issue explique le changement attendu, les critères d'acceptation et la prochaine étape.
Claire
Prérequis
Git
Accessibilité débutantScore de 1 à 100 estimant l'accessibilité de cette issue pour un premier contributeur.
60