Describe the feature you'd like to have.
We need to have a set of well organized documentation for both users and developers.
What is the value to the end user? (why is it a priority?)
Well organized documentation would make it easy for users to get started using the operator to deploy a Gluster cluster. They should also be able to read about how to perform day 2 operations and troubleshoot their installation.
In addition to end-user documentation, new developers can use the resource as a friendly way to learn about how to contribute to the project
How will we know we have a good solution? (acceptance criteria)
Documentation should be a part of the source tree, so that it can be updated with each user-visible change
Documentation should be automatically built and published with each change
CI should fail if there is a problem with the docs
Developers should be able to build/preview/debug their documentation on their local system
Additional context
My suggestion is to use readthedocs for documentation
Describe the feature you'd like to have. We need to have a set of well organized documentation for both users and developers.
What is the value to the end user? (why is it a priority?) Well organized documentation would make it easy for users to get started using the operator to deploy a Gluster cluster. They should also be able to read about how to perform day 2 operations and troubleshoot their installation. In addition to end-user documentation, new developers can use the resource as a friendly way to learn about how to contribute to the project
How will we know we have a good solution? (acceptance criteria)
Additional context My suggestion is to use readthedocs for documentation