2i2c-org / docs

Documentation for 2i2c community JupyterHubs.
https://docs.2i2c.org
9 stars 17 forks source link

Re-organize our top-level organization around hub roles #160

Closed choldgraf closed 1 year ago

choldgraf commented 1 year ago

Context

Right now our documentation has three top-level sections: "About", "Hub administration", and "User guide". The latter two have a mixture of content that covers a few different use-cases.

Our service documentation describes a more nuanced collection of roles in the hub. Off the top of my head I think these are the major roles:

Proposal

We should explore using each of these roles to define a top-level section to organize content in our hub service documentation. That way, we can separate our pages based on the kind of person that might be interested in them. This might make our documentation easier to navigate, and with more natural grouping of information. It might also make it easier to extend and improve.

Updates and actions

No response

choldgraf commented 1 year ago

cc @jmunroe curious what you think about this

colliand commented 1 year ago

I am responding here while considering the related documentation improvements in this PR.

I like the idea to present our docs using a structure tailored to reader personas! This structure should also allow us to improve on the shared responsibility model #144 since we can describe and assign responsibilities to personas using the documentation.