diff --git a/docs/_quarto.yml b/docs/_quarto.yml index 92c57cfee..f8759eee9 100644 --- a/docs/_quarto.yml +++ b/docs/_quarto.yml @@ -16,7 +16,7 @@ website: - text: "Contributing" href: admins/pre-reqs.qmd - text: "Admin Tasks" - href: admins/howto/documentation.qmd + href: tasks/documentation.qmd - text: "Policy" href: policy/create_policy.qmd page-navigation: true @@ -35,27 +35,27 @@ website: - admins/storage.qmd - admins/cluster-config.qmd - admins/credentials.qmd - - section: "Common Administrator Tasks" - contents: - - admins/howto/documentation.qmd - - admins/howto/dns.qmd - - admins/howto/core-pool.qmd - - admins/howto/new-hub.qmd - - admins/howto/rebuild-hub-image.qmd - - admins/howto/rebuild-postgres-image.qmd - - admins/howto/managing-multiple-user-image-repos.qmd - - admins/howto/new-image.qmd - - admins/howto/transition-image.qmd - - admins/howto/new-packages.qmd - - admins/howto/course-config.qmd - - admins/howto/calendar-scaler.qmd - - admins/howto/prometheus-grafana.qmd - - admins/howto/remove-users-orm.qmd - - admins/howto/delete-hub.qmd - - admins/howto/clusterswitch.qmd - - admins/howto/github-token.qmd - - admins/howto/google-sheets.qmd - - admins/howto/cheatsheet.qmd + - section: "Common Administrator Tasks" + contents: + - tasks/documentation.qmd + - tasks/dns.qmd + - tasks/core-pool.qmd + - tasks/new-hub.qmd + - tasks/rebuild-hub-image.qmd + - tasks/rebuild-postgres-image.qmd + - tasks/managing-multiple-user-image-repos.qmd + - tasks/new-image.qmd + - tasks/transition-image.qmd + - tasks/new-packages.qmd + - tasks/course-config.qmd + - tasks/calendar-scaler.qmd + - tasks/prometheus-grafana.qmd + - tasks/remove-users-orm.qmd + - tasks/delete-hub.qmd + - tasks/clusterswitch.qmd + - tasks/github-token.qmd + - tasks/google-sheets.qmd + - tasks/cheatsheet.qmd - section: "Policy" contents: - policy/create_policy.qmd diff --git a/docs/admins/howto/calendar-scaler.qmd b/docs/tasks/calendar-scaler.qmd similarity index 99% rename from docs/admins/howto/calendar-scaler.qmd rename to docs/tasks/calendar-scaler.qmd index 0f4bc2eb2..cdfe4c132 100644 --- a/docs/admins/howto/calendar-scaler.qmd +++ b/docs/tasks/calendar-scaler.qmd @@ -1,5 +1,7 @@ --- title: Calendar Node Pool Autoscaler +aliases: + - ../admins/howto/calendar-scaler.html --- ## Why scale node pools with Google Calendar? diff --git a/docs/admins/howto/cheatsheet.qmd b/docs/tasks/cheatsheet.qmd similarity index 96% rename from docs/admins/howto/cheatsheet.qmd rename to docs/tasks/cheatsheet.qmd index d63df3f6c..f5ce191b6 100644 --- a/docs/admins/howto/cheatsheet.qmd +++ b/docs/tasks/cheatsheet.qmd @@ -1,5 +1,7 @@ --- title: Operations Cheatsheet +aliases: + - ../admins/howto/cheatsheet.html --- We periodically need to perform various tasks that can be quickly described by short shell fragments. This page is meant to be a dumping ground for them. It may be useful on occasion to move such fragments into more relevant pages. diff --git a/docs/admins/howto/clusterswitch.qmd b/docs/tasks/clusterswitch.qmd similarity index 98% rename from docs/admins/howto/clusterswitch.qmd rename to docs/tasks/clusterswitch.qmd index 233f03b61..ed82dce5d 100644 --- a/docs/admins/howto/clusterswitch.qmd +++ b/docs/tasks/clusterswitch.qmd @@ -1,5 +1,7 @@ --- title: Switching over a hub to a new cluster +aliases: + - ../admins/howto/clusterswitch.html --- This document describes how to switch an existing hub to a new cluster. The example used here refers to moving all UC Berkeley Datahubs. @@ -7,7 +9,7 @@ This document describes how to switch an existing hub to a new cluster. The exa You might find it easier to switch to a new cluster if you're running a [very old k8s version](https://cloud.google.com/kubernetes-engine/docs/release-notes), or in lieu of performing a [cluster credential rotation](https://cloud.google.com/kubernetes-engine/docs/how-to/credential-rotation). Sometimes starting from scratch is easier than an iterative and potentially destructive series of operations. ## Create a new cluster -1. Create a new cluster using the specified [configuration](../cluster-config.qmd). +1. Create a new cluster using the specified [configuration](../admins/cluster-config.qmd). 2. Set up helm on the cluster according to the instructions here: http://z2jh.jupyter.org/en/latest/setup-helm.html - Make sure the version of helm you're working with matches the version Github Actions is using. diff --git a/docs/admins/howto/core-pool.qmd b/docs/tasks/core-pool.qmd similarity index 97% rename from docs/admins/howto/core-pool.qmd rename to docs/tasks/core-pool.qmd index a91f5eaed..dd8f55167 100644 --- a/docs/admins/howto/core-pool.qmd +++ b/docs/tasks/core-pool.qmd @@ -1,5 +1,7 @@ --- title: Core Node Pool Management +aliases: + - ../admins/howto/core-pool.html --- ## What is the core node pool? diff --git a/docs/admins/howto/course-config.qmd b/docs/tasks/course-config.qmd similarity index 99% rename from docs/admins/howto/course-config.qmd rename to docs/tasks/course-config.qmd index bced44e6c..774ffb0d9 100644 --- a/docs/admins/howto/course-config.qmd +++ b/docs/tasks/course-config.qmd @@ -1,5 +1,7 @@ --- title: Course Configuration +aliases: + - ../admins/howto/course-config.html --- ## Allocating Resources diff --git a/docs/admins/howto/delete-hub.qmd b/docs/tasks/delete-hub.qmd similarity index 97% rename from docs/admins/howto/delete-hub.qmd rename to docs/tasks/delete-hub.qmd index 880680050..3888d1782 100644 --- a/docs/admins/howto/delete-hub.qmd +++ b/docs/tasks/delete-hub.qmd @@ -1,5 +1,7 @@ --- title: Delete or spin down a Hub +aliases: + - ../admins/howto/delete-hub.html --- ## Why delete or spin down a hub? diff --git a/docs/admins/howto/dns.qmd b/docs/tasks/dns.qmd similarity index 97% rename from docs/admins/howto/dns.qmd rename to docs/tasks/dns.qmd index 6919291ee..22091b4ae 100644 --- a/docs/admins/howto/dns.qmd +++ b/docs/tasks/dns.qmd @@ -1,5 +1,7 @@ --- title: Update DNS +aliases: + - ../admins/howto/dns.html --- Some staff have access to make and update DNS entries in the diff --git a/docs/admins/howto/documentation.qmd b/docs/tasks/documentation.qmd similarity index 98% rename from docs/admins/howto/documentation.qmd rename to docs/tasks/documentation.qmd index a0cb29d5b..2161b2dd4 100644 --- a/docs/admins/howto/documentation.qmd +++ b/docs/tasks/documentation.qmd @@ -1,5 +1,7 @@ --- title: Documentation +aliases: + - ../admins/howto/documentation.html --- ## Overview diff --git a/docs/admins/howto/github-token.qmd b/docs/tasks/github-token.qmd similarity index 90% rename from docs/admins/howto/github-token.qmd rename to docs/tasks/github-token.qmd index b4ad1800c..b0ef2a9c3 100644 --- a/docs/admins/howto/github-token.qmd +++ b/docs/tasks/github-token.qmd @@ -1,5 +1,7 @@ --- title: Create Finely Grained Access Token +aliases: + - ../admins/howto/github-token.html --- At : diff --git a/docs/admins/howto/google-sheets.qmd b/docs/tasks/google-sheets.qmd similarity index 98% rename from docs/admins/howto/google-sheets.qmd rename to docs/tasks/google-sheets.qmd index 45b8f8bdd..2a7dd6f04 100644 --- a/docs/admins/howto/google-sheets.qmd +++ b/docs/tasks/google-sheets.qmd @@ -1,5 +1,7 @@ --- title: Reading Google Sheets from DataHub +aliases: + - ../admins/howto/google-sheets.html --- Available in: DataHub diff --git a/docs/admins/howto/index.qmd b/docs/tasks/index.qmd similarity index 51% rename from docs/admins/howto/index.qmd rename to docs/tasks/index.qmd index f6a765d36..ad75d5ec0 100644 --- a/docs/admins/howto/index.qmd +++ b/docs/tasks/index.qmd @@ -1,3 +1,5 @@ --- title: Common Administrator Tasks +aliases: + - ../admins/howto/index.html --- diff --git a/docs/admins/howto/managing-multiple-user-image-repos.qmd b/docs/tasks/managing-multiple-user-image-repos.qmd similarity index 99% rename from docs/admins/howto/managing-multiple-user-image-repos.qmd rename to docs/tasks/managing-multiple-user-image-repos.qmd index 0056f2f9d..7e0436e60 100644 --- a/docs/admins/howto/managing-multiple-user-image-repos.qmd +++ b/docs/tasks/managing-multiple-user-image-repos.qmd @@ -1,5 +1,7 @@ --- title: Managing multiple user image repos +aliases: + - ../admins/howto/managing-multiple-user-image-repos.html --- ## Managing user image repos diff --git a/docs/admins/howto/new-hub.qmd b/docs/tasks/new-hub.qmd similarity index 99% rename from docs/admins/howto/new-hub.qmd rename to docs/tasks/new-hub.qmd index fa3a39869..a59f5e0ae 100644 --- a/docs/admins/howto/new-hub.qmd +++ b/docs/tasks/new-hub.qmd @@ -2,6 +2,7 @@ title: Create a New Hub aliases: - ../../en/latest/admins/howto/new-hub.html + - ../admins/howto/new-hub.html --- ## Why create a new hub? diff --git a/docs/admins/howto/new-image.qmd b/docs/tasks/new-image.qmd similarity index 99% rename from docs/admins/howto/new-image.qmd rename to docs/tasks/new-image.qmd index 03c014693..c15fc0d74 100644 --- a/docs/admins/howto/new-image.qmd +++ b/docs/tasks/new-image.qmd @@ -1,5 +1,7 @@ --- title: Create a New Single User Image +aliases: + - ../admins/howto/new-image.html --- You might need to create a new user image when deploying a new hub, or changing diff --git a/docs/admins/howto/new-packages.qmd b/docs/tasks/new-packages.qmd similarity index 99% rename from docs/admins/howto/new-packages.qmd rename to docs/tasks/new-packages.qmd index eae812e52..cec2f4b68 100644 --- a/docs/admins/howto/new-packages.qmd +++ b/docs/tasks/new-packages.qmd @@ -1,5 +1,7 @@ --- title: Testing and Upgrading New Packages +aliases: + - ../admins/howto/new-packages.html --- It is helpful to test package additions and upgrades for yourself before diff --git a/docs/admins/howto/prometheus-grafana.qmd b/docs/tasks/prometheus-grafana.qmd similarity index 94% rename from docs/admins/howto/prometheus-grafana.qmd rename to docs/tasks/prometheus-grafana.qmd index 50249223d..29cbe9239 100644 --- a/docs/admins/howto/prometheus-grafana.qmd +++ b/docs/tasks/prometheus-grafana.qmd @@ -1,5 +1,7 @@ --- title: Prometheus and Grafana +aliases: + - ../admins/howto/prometheus-grafana.html --- # Accessing the Prometheus Server diff --git a/docs/admins/howto/rebuild-hub-image.qmd b/docs/tasks/rebuild-hub-image.qmd similarity index 96% rename from docs/admins/howto/rebuild-hub-image.qmd rename to docs/tasks/rebuild-hub-image.qmd index 5df136ff4..314f86b5c 100644 --- a/docs/admins/howto/rebuild-hub-image.qmd +++ b/docs/tasks/rebuild-hub-image.qmd @@ -1,5 +1,7 @@ --- title: "Customize the Hub Docker Image" +aliases: + - ../admins/howto/rebuild-hub-image.html --- We use a customized JupyterHub docker image so we can install extra packages diff --git a/docs/admins/howto/rebuild-postgres-image.qmd b/docs/tasks/rebuild-postgres-image.qmd similarity index 94% rename from docs/admins/howto/rebuild-postgres-image.qmd rename to docs/tasks/rebuild-postgres-image.qmd index 37a9ab46e..07f8484a9 100644 --- a/docs/admins/howto/rebuild-postgres-image.qmd +++ b/docs/tasks/rebuild-postgres-image.qmd @@ -1,5 +1,7 @@ --- title: "Customize the Per-User Postgres Docker Image" +aliases: + - ../admins/howto/rebuild-postgres-image.html --- We provide each student on `data100` with a postgresql server. We want the diff --git a/docs/admins/howto/remove-users-orm.qmd b/docs/tasks/remove-users-orm.qmd similarity index 96% rename from docs/admins/howto/remove-users-orm.qmd rename to docs/tasks/remove-users-orm.qmd index 46c90a2a7..6440f0476 100644 --- a/docs/admins/howto/remove-users-orm.qmd +++ b/docs/tasks/remove-users-orm.qmd @@ -1,5 +1,7 @@ --- title: JupyterHub ORM Maintenance +aliases: + - ../admins/howto/remove-users-orm.html --- ## Performance diff --git a/docs/admins/howto/transition-image.qmd b/docs/tasks/transition-image.qmd similarity index 99% rename from docs/admins/howto/transition-image.qmd rename to docs/tasks/transition-image.qmd index 66404c6fa..b2ba0bb5e 100644 --- a/docs/admins/howto/transition-image.qmd +++ b/docs/tasks/transition-image.qmd @@ -1,5 +1,7 @@ --- title: Transition Single User Image to GitHub Actions +aliases: + - ../admins/howto/transition-image.html --- Single user images have been maintained within the main datahub repo since its inception, however we decided to move them into their own repositories. It will make testing notebooks easier, and we will be able to delegate write access to course staff if necessary.