Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Pre-requisite knowledge of terms #48

Open
Gbahdeyboh opened this issue Jun 28, 2021 · 4 comments
Open

Pre-requisite knowledge of terms #48

Gbahdeyboh opened this issue Jun 28, 2021 · 4 comments

Comments

@Gbahdeyboh
Copy link

The documentation assumes that I, as a first-time reader(or beginner), have pre-requisite knowledge of certain terms and concepts widely used across the documentations. For example, I saw the use of terms like “GitOps”, “CRDs”, "CRs", “Operators”, “Schedulers”, “kubeconfig”, etc in different places. I am familiar with some of this terms, but I had to Google my way through some of them or reference the 1.x docs.

It would be useful to add hyperlinks to such terms, these hyperlinks would link to a page explaining these terms.

Additionally, if no such pages exist(yet). We could create a glossary page that lists all of these terms and gives a short and concise explanation of what they mean with possible links to where you could read more about them.

@mehabhalodiya
Copy link

Hey
I would like to contribute!
We can have a glossary page for all the terms with various categories/filters i.e. according to their tags.

@gdsoumya
Copy link
Member

This might be helpful https://docs.litmuschaos.io/docs/concepts/overview

@uditgaurav
Copy link
Member

Feel free to take this up @mehabhalodiya!

@anshikavashistha
Copy link

@uditgaurav may I work on this issue?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

5 participants