-
Notifications
You must be signed in to change notification settings - Fork 11
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
Improve docs #263
Improve docs #263
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This is great, but its an extension of our existing docs and I think one particular problem is that
- It gives the impression that you need an incredible amount of pre-existing knowledge to set up a cluster, while simultaneously saying: you only need to run 2 commands.
- It is very extensive, but I would not know to look here if I for example am interested in checking if kafka topics are loaded (something I learned how to do while reviewing this documentation.
I think what we need to resolve these is:
- A quickstart guide, which just a list of commands and links to this document.
- That we start to make pages in confluence whenever we come up with questions, and write the answer there with a link to the documentation. That way we have a way to index this documentation in a more granular and practical way.
Added some minor spelling suggestions, and a link, otherwise, LGTM |
I've updated the docs and mention that you can start with 2 commands but you really need the knowledge in order to be able to fully utilize the tools.
I saw it for the first time when I was revisiting the document as well, a document index might help, but it is also gonna become a giant list so I don't know how much it will be helpful.
Maintaining a shorter version of this document might add some extra overhead, we can provide links to essential sections but scrolling through the document shouldn't take a long time.
This can be done, just need to be aware of it and actively do it. |
@yatharthranjan @mpgxvii feel free to comment if you think there is anything that we can improve. |
This PR aims to improve docs on RADAR-Kubernetes with focus on contributors and how they can help to improve RADAR-Kubernetes.
It also tries to answer to following questions: