kubernetes/website

Links to Cloud Native Glossary to become more newbie-friendly

Open

#39,792 opened on Mar 5, 2023

View on GitHub
 (18 comments) (6 reactions) (2 assignees)HTML (13,918 forks)batch import
help wantedkind/featurelanguage/enpriority/backlogtriage/accepted

Repository metrics

Stars
 (4,127 stars)
PR merge metrics
 (Avg merge 16d 13h) (160 merged PRs in 30d)

Description

This is a Feature Request

What would you like to be added

  1. Link cloud native terms in the Kubernetes docs (including the Glossary) to Cloud Native Glossary definitions.
  2. 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!

Contributor guide