Skip to content

Commit

Permalink
Merge pull request #5937 from ryanlovett/docs-structure-docs
Browse files Browse the repository at this point in the history
Update information about documentation.
  • Loading branch information
ryanlovett authored Aug 11, 2024
2 parents 9539a2e + a27634b commit de7f412
Showing 1 changed file with 19 additions and 23 deletions.
42 changes: 19 additions & 23 deletions docs/admins/structure.qmd
Original file line number Diff line number Diff line change
Expand Up @@ -18,24 +18,24 @@ 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.

### 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
Expand All @@ -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`

Expand All @@ -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
<https://uc-berkeley-jupyterhubs.readthedocs.io/> and
<https://docs.datahub.berkeley.edu/>. 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 <https://docs.datahub.berkeley.edu/> via a
[GitHub Action workflow](https://github.com/berkeley-dsep-infra/datahub/actions/workflows/quarto-docs.yml).

0 comments on commit de7f412

Please sign in to comment.