Skip to content

[RFE] Kubernetes jargon, plain language, and glossary descriptions #874

@illume

Description

@illume

Current situation

Kubernetes jargon is confusing and extensive. Making it hard to understand for users new and long term.

Like many usability issues, it's also an accessibility issue. See WCAG 2.1, which has requirements for plain language and has guidelines for Jargon.

For languages other than English we are currently using the English Kubernetes terms. This is for two reasons. Firstly there aren't always appropriate words, so the English word can be better. Secondly, even when there are words available they can be confusing when much of the tooling using the English terms only.

Impact

Headlamp (and Kubernetes) will become more usable and accessible.

Ideal future situation

There will be a way for K8s Jargon words to be understood by people without extensive Kubernetes jargon knowledge.

Implementation options

WCAG 2.1 and has some techniques about what to do when things like jargon are used. https://www.w3.org/WAI/WCAG21/quickref/?showtechniques=313#unusual-words

Kubernetes maintains a glossary here: https://kubernetes.io/docs/reference/glossary/?all=true
Some parts are translated, but not all that much. The French translation is https://kubernetes.io/fr/docs/reference/glossary/?all=true is one of the more complete glossary translations, but still misses much.

The translations inside Headlamp also have a list of non-translated k8s English terms. The existing Documentation tab should be considered to see if it can provide other language information.

Additional information

...

Metadata

Metadata

Labels

a11yAccessibility related issuesi18nlifecycle/frozenIndicates that an issue or PR should not be auto-closed due to staleness.needs designSome design work needs to be done on this. Not necessarily by a designer.

Type

No type

Projects

Status

Queued

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions