Links to Cloud Native Glossary to become more newbie-friendly

[CathPag]

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!

[sftim]

/language en
/priority backlog
/triage accepted

[XDRAGON2002]

Hi @CathPag @sftim I'm a new contributor to the project, can I take this up? It seems like I'd just have to add links to the glossary for the definitions that exist in it?

[sftim]

Anyone is welcome to work on issues - see https://kubernetes.io/docs/contribute/ and https://www.kubernetes.dev/docs/ for tips.

Remember to cover:

2. Update the docs contributor guide reminding contributors to link to the CN Glossary whenever feasible/beneficial.

in your change, as well as adding some links. In fact, that should be the first commit in your PR.

@XDRAGON2002 if you aren't sure what those terms mean - some are jargon - it's OK to start with a different change and revisit this when you're more confident.

/help

[k8s-ci-robot]

@sftim:
This request has been marked as needing help from a contributor.

Guidelines

Please ensure that the issue body includes answers to the following questions:

• Why are we solving this issue?
• To address this issue, are there any code changes? If there are code changes, what needs to be done in the code and what places can the assignee treat as reference points?
• Does this issue have zero to low barrier of entry?
• How can the assignee reach out to you for help?

For more details on the requirements of such an issue, please see here and ensure that they are met.

If this request no longer meets these requirements, the label can be removed
by commenting with the /remove-help command.

In response to this:

Anyone is welcome to work on issues - see https://kubernetes.io/docs/contribute/ and https://www.kubernetes.dev/docs/ for tips.

Remember cover:

2. Update the docs contributor guide reminding contributors to link to the CN Glossary whenever feasible/beneficial.

in your change, as well as adding some links. In fact, that should be the first commit in your PR.

@XDRAGON2002 if you aren't sure what those terms mean - some are jargon - it's OK to start with a different change and revisit this when you're more confident.

/help

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.

[KhushPatibandha]

/assign

[krol3]

I would like to help too!

[KhushPatibandha]

@krol3 sure, you can also work on this.

[MaryamTavakkoli]

@KhushPatibandha @krol3 Are you working on this?

[CathPag]

I believe anyone can just jump on this task and submit PRs for missing links, @MaryamTavakkoli. At least, I think that's what @sftim said. There are probably many different places where we can link to, more than one person would catch in one PR.

[MaryamTavakkoli]

I believe anyone can just jump on this task and submit PRs for missing links, @MaryamTavakkoli. At least, I think that's what @sftim said. There are probably many different places where we can link to, more than one person would catch in one PR.

Great! Thanks @CathPag

[krol3]

yeah! I'm agree @CathPag I will try to create a PR to have a sample here for the next contributors @MaryamTavakkoli

[vaibhav2107]

Is there someone who is working on this issue?

[kumarankit999]

I don't think someone is working on this issue still!!!
Go further @vaibhav2107 .
Let me know if you need any help !!