Glossary Redux

[chenopis]

TL;DR

This project will standardize Kubernetes terms (as well as their definitions and other metadata), so that their content can be reused consistently throughout the K8s docs (e.g. in concepts, diagrams, etc.). [project proposal] [project tracker]

Tasks

• Create a /_includes/glossary/ directory for snippets of glossary terminology that can be reused throughout the documentation. [done]
• Docs for a topic that match a glossary term should use the glossary snippet as the summary at the top of the doc.
• There may be a complete list and/or smaller curated lists of glossary terminology for specific levels of understanding.
• Docs tying together concepts using the glossary terminology should have tooltips that use the snippets.
• Interactive diagrams that use any of the glossary terms should also use the snippets.

[chenopis]

cc @abiogenesis-now

[chenopis]

This is related to #1191

[chenopis]

/assign @heidecke

[k8s-ci-robot]

@chenopis: GitHub didn't allow me to assign the following users: heidecke.

Note that only kubernetes members can be assigned.

In response to this:

/assign @heidecke

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes/test-infra repository.

[chenopis]

@heidecke We need to get you on the road to being a sig-docs-maintainer.

[jesscodez]

@heidecke I had an idea about kubernetes visualizations---not sure how feasible so I'll think about it more and discuss with @chenopis tomorrow. If it seems reasonable can I make an addition to the bottom of your google doc?

[heidecke]

@abiogenesis-now Definitely, feel free to add/comment.

[chenopis]

This has been completed and is now live: https://kubernetes.io/docs/reference/glossary/?fundamental=true