Tony, Ani and I discussed that it would be better if the documentation is designed in a way that directs the reader to different pages based on how they identify themselves (a general user -team member etc- or a producer (DevOps person).
-
Those with the need to customize qhub setup for a large team (DevOps is the persona we have in mind here) to do so in a more detailed and technical level.
-
Those who are simply general users of the tool and don't need to (or have authorization to) make changes in the deployment settings etc.
The landing page for docs will lead general users, which we assume would be a member of a team, to a documentation page that does not contain many of the low-level details about how qhub works in the backend (kubernetes, the entire cloud architecture, etc.).
A producer, on the other hand, is one who needs to maintain such deployment specifics would want to know and be able to customize to serve the needs of an entire team. Thus, their documentation page will entail more low-level technical details and "how to"s.
The documentation addressed to these two different audiences will be captured on two different pages.