Links to Cloud Native Glossary to become more newbie-friendly
#39 792 ouverte le 5 mars 2023
Métriques du dépôt
- Stars
- (4 127 stars)
- Métriques de merge PR
- (Merge moyen 16j 13h) (160 PRs mergées en 30 j)
Description
This is a Feature Request
What would you like to be added
- Link cloud native terms in the Kubernetes docs (including the Glossary) to Cloud Native Glossary definitions.
- Update the docs contributor guide reminding contributors to link to the CN Glossary whenever feasible/beneficial.
Why is this needed Reading the docs can be overwhelming for users new to Kubernetes, as so many terms and concepts are new. While the Kubernetes docs do a great job at explaining lots of these terms, they are still quite advanced. The Cloud Native Glossary assumes little to no context and could help ease new users' early Kubernetes learning journey. Hyperlinks to the CN Glossary would provide more context to newbies without disrupting the reading experience of more advanced users.
Once implemented, it would be ideal if the CN Glossary would be on the radar of new doc contributors, so future iterations also link to it.
Comments If the K8s maintainers agreed that this would be beneficial, I would also create a CN Glossary issue. This could be a great project for a new contributor. (UPDATE: CN Glossary issue cross-promoting this one)
Thanks for considering!