From a27634b6786e27b4ba6b54c9ad2a55e251d93ce7 Mon Sep 17 00:00:00 2001 From: Ryan Lovett Date: Sat, 10 Aug 2024 21:24:58 -0700 Subject: [PATCH] Update information about documentation. Doc docs need to be moved into their own section, along with the local development information. --- docs/admins/structure.qmd | 42 ++++++++++++++++++--------------------- 1 file changed, 19 insertions(+), 23 deletions(-) diff --git a/docs/admins/structure.qmd b/docs/admins/structure.qmd index 3e3a9cafb..5cc715872 100644 --- a/docs/admins/structure.qmd +++ b/docs/admins/structure.qmd @@ -18,7 +18,7 @@ provided to the user. For example, it controls: 2. Libraries installed, and which versions of those are installed 3. Specific config for Jupyter Notebook or IPython -[repo2docker](https://repo2docker.readthedocs.io/en/latest/) is used to +[repo2docker](https://repo2docker.readthedocs.io) is used to build the actual user image, so you can use any of the [supported config files](https://repo2docker.readthedocs.io/en/latest/config_files.html) to customize the image as you wish. @@ -26,16 +26,16 @@ to customize the image as you wish. ### Hub Config (`config/` and `secrets/`) All our JupyterHubs are based on [Zero to JupyterHub -(z2jh)](http://z2jh.jupyter.org/). z2jh uses configuration files in +(z2jh)](https://z2jh.jupyter.org/). z2jh uses configuration files in [YAML](https://en.wikipedia.org/wiki/YAML) format to specify exactly how the hub is configured. For example, it controls: -1. RAM available per user -2. Admin user lists -3. User storage information -4. Per-class & Per-user RAM overrides (when classes or individuals need - more RAM) -5. Authentication secret keys +1. RAM available per user +2. Admin user lists +3. User storage information +4. Per-class & Per-user RAM overrides (when classes or individuals need + more RAM) +5. Authentication secret keys These files are split between files that are visible to everyone (`config/`) and files that are visible only to a select few illuminati @@ -44,12 +44,12 @@ illuminati. Files are further split into: -1. `common.yaml` - Configuration common to staging and production - instances of this hub. Most config should be here. -2. `staging.yaml` - Configuration specific to the staging instance of - the hub. -3. `prod.yaml` - Configuration specific to the production instance of - the hub. +1. `common.yaml` - Configuration common to staging and production + instances of this hub. Most config should be here. +2. `staging.yaml` - Configuration specific to the staging instance of + the hub. +3. `prod.yaml` - Configuration specific to the production instance of + the hub. ### `hubploy.yaml` @@ -63,12 +63,8 @@ under `secrets/` and referred to from `hubploy.yaml`. ## Documentation -Documentation is under the `docs/` folder, and is generated with the -[sphinx](http://www.sphinx-doc.org/) project. It is written with the -[reStructuredText -(rst)](http://www.sphinx-doc.org/en/master/usage/restructuredtext/basics.html) -format. Documentation is automatically published to - and -. This is performed via a -[webhook](https://github.com/berkeley-dsep-infra/datahub/settings/hooks) -in the github repo. +Documentation is under the `docs/` folder, and is generated with +[Quarto](https://quarto/), where content is written in +[markdown](https://quarto.org/docs/authoring/markdown-basics.html). +Documentation is published to via a +[GitHub Action workflow](https://github.com/berkeley-dsep-infra/datahub/actions/workflows/quarto-docs.yml).