[documentation] protocols db - format for user guides on gitlab pages
The just-the-docs
theme for jekyll gitlab pages allows only for a maximum of 3 levels in the section hierarchy. For the MR protocols database, the first and second level are already taken by Open WIN Tools > Open MR Protocols.
This means that the user guides live on the third level (e.g. Open WIN Tools > Open MR Protocols > Guide for WIN Users) and can't have any further subsections.
So I was thinking about a couple of possible options:
- Publish each guide as a one long, self-contained page.
- Split off the step-by-step db access guides from other thematically distinct topics (e.g. why make protocols public, how to create a DOI, etc.) and indicate on each page whether this applies to all users or internal users only.
- Create a pseudo-hierarchy by adding numbered sections in the title of individual pages. For example:
-
Open WIN Tools
-
Open MR Protocols
- 1. Guide for WIN Users
- 1.1 Why make your protocol public
- 1.2 How to add a DOI
- 1.3 How to access the database
- ...
- 2. Guide for External Users
- 2.1 How to access the database
-
Open MR Protocols
I'm leaning towards option 3 but it might look a bit messy / clumsy. Any preferences or other suggestions?