search

opendatacube / datacube-conference-2021

A repository of ODC Conference sprint materials.
Apache License 2.0
7 stars 2 forks source link

Introduce role based documentation: end-user (scientist) vs. operator (sys-admin) #14

Open EHJ-52n opened 3 years ago

EHJ-52n commented 3 years ago

End-users require different documentation than operators. This might be a collection of already existing resources like the k8s repo, videos from DEA(frica|ustralia) admins (mentioned in the zoom call by @andrewdhicks).

rowanwins commented 3 years ago

Yeah I think this would be really interesting.

I think one of the challenges at the moment is that the side navigation is very dense, and it only exposes child pages when you're within the parent page, so the nav isn't always very scannable.

Being able to move to a navigation structure that was a bit more tailored for particular users would be really helpful... what is less clear is whether that would be easily achievable with a custom sphinx template...

rowanwins commented 3 years ago

@EHJ-52n Check out my new ticket #14 where I've started playing around with a new layout based around users & uses. I'm just trying some technical pieces to see how achievable it is, but once I get it vaguely working it would be great to get feedback on some specifics on what doco should be where.