search

cncf / glossary

The CNCF Cloud Native Glossary Project aims to define cloud native concepts in clear and simple language, making them accessible to anyone — whether they have a technical background or not (https://glossary.cncf.io).
https://glossary.cncf.io/
Apache License 2.0
651 stars 540 forks source link

Links from Kubernetes docs to Glossary #1793

Open CathPag opened 1 year ago

CathPag commented 1 year ago

Cross-post of this Kubernetes docs issue. Please refer to the original issue to work on this.

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.

Adi9235 commented 1 year ago

Hey @CathPag can I work on this issue but as I am beginner so need some guidance little bit.

Coderayush13 commented 1 year ago

@CathPag I am working in this issue Please assign this to me

CathPag commented 1 year ago

Thanks, all. Please do not ask to be assigned to an issue if someone else has already requested it. Unless you see that we have established that that person won't work on it, we'll go with first come, first serve.

Also, this issue is just reposting the Kubernetes issue for visibility. The original issue is the one that matters, but someone has already asked to be assigned to it. Feel free to follow it and see what happens, but wait until a Kubernetes docs maintainer responds.

sftim commented 1 year ago

On the Kubernetes docs side, we have an explicit “no cookie licking” policy. So, for the changes on the Kubernetes side you're welcome to work on this even if someone else has said they intend to.

That said, it's absolutely the helpful thing to do that you first reach out to other people who might have started work. We work best as a collaborative group.

Finally, remember that https://github.com/kubernetes/website/issues/39792 is the best place to comment.