elastic / elastic/crd-ref-docs
Docs generated in output-mode "group" are missing versions for multiversioned APIs
- Langage dominant
- Go
- Étoiles
- 173
- Forks
- 81
- Métriques de merge des PR
- Aucune PR mergée en 30 j
Description
For a multi versioned API type, when generating a output-mode "group" rendering, the generated one only contains 1 version of the api.
This is primarily becasue we are overwiting the same named file for all the versions one at a time, thus the last one is what is left generated
primarily due to the following code block we iterate over all the gvd without first grouping them based on the group. https://github.com/elastic/crd-ref-docs/blob/7de989285647936ac62ea1ff8887e25e0056bc58/renderer/renderer.go#L86-L96
Guide de contribution
Ouvrir le guide de contribution
Piste de recherche
Commencez dans renderer/renderer.go, autour des lignes 86-96, et suivez la façon dont le mode de sortie "group" traite les types d’API multiversionnés. Vérifiez que la documentation groupée générée conserve chaque version de l’API au lieu de ne laisser que la dernière version après des écritures répétées dans les fichiers.
Rédigé par le modèle d'indexation à partir du texte de l'issue.
Évaluation
- Stack technique
- go, kubernetes
- Domaine
- documentation
- Type d'issue
- Bug
- Difficulté
- 3/5
- Temps estimé
- 1-2 jours
- Activité
- À l'abandon
- Clarté
- Plutôt claire
- Accessibilité débutants
- 45/100