Refactor Charmed Kubeflow documentation to make it clear which docs are aimed at administrators vs users

[ca-scribner]

Context

While completing https://github.com/canonical/notebook-operators/issues/337, it became clear that our documentation is not explicit about the persona it caters to. Some of our documentation is aimed at administrators (ex: how to install), and other docs aim at users (how to create a notebook using a gpu). Which docs fit which persona is hard to discern in the table of contents of our docs website

What needs to get done

We should make the user journey through the docs for each persona easier. This could be refactoring the headings, or forking the docs at the top level like snap and kubernetes

Definition of Done

The user journey through our docs for administrators and users is simplified, and documentation for each persona is easier to find

[syncronize-issues-to-jira[bot]]

Thank you for reporting us your feedback!

The internal ticket has been created: https://warthogs.atlassian.net/browse/KF-5609.

This message was autogenerated

[ca-scribner]

Notes from talking with Nick Veitch:

• separating the user/admin personas at the top level requires having enough content for each. If we don't, separating them at a deeper level (maybe in how-to guide headings) might work better
  • First step would be listing all the documentation and capturing whether each has user, admin, or both content. From that list it would be easier to assess what to do next
• In general, the how-to guide subheadings feel like they could have a refactor. Likely the headings were set long ago and they no longer reflect the content in them. It would be worth a rethink of what headings we should have