Merge pull request #6409 from ryanlovett/docs-move-howto

Un-nest admin tasks.
berkeley-dsep-infra · Oct 24, 2024 · 63f6938 · 63f6938
2 parents 0c1d074 + b175c53
commit 63f6938
Show file tree

Hide file tree

Showing 21 changed files with 62 additions and 23 deletions.
diff --git 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 → docs/tasks/calendar-scaler.qmd b/docs/admins/howto/calendar-scaler.qmd → 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 → docs/tasks/cheatsheet.qmd b/docs/admins/howto/cheatsheet.qmd → 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 → docs/tasks/clusterswitch.qmd b/docs/admins/howto/clusterswitch.qmd → docs/tasks/clusterswitch.qmd
@@ -1,13 +1,15 @@
 ---
 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.
 
 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 → docs/tasks/core-pool.qmd b/docs/admins/howto/core-pool.qmd → 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 → docs/tasks/course-config.qmd b/docs/admins/howto/course-config.qmd → 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 → docs/tasks/delete-hub.qmd b/docs/admins/howto/delete-hub.qmd → 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 → docs/tasks/dns.qmd b/docs/admins/howto/dns.qmd → 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 → docs/tasks/documentation.qmd b/docs/admins/howto/documentation.qmd → 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 → docs/tasks/github-token.qmd b/docs/admins/howto/github-token.qmd → docs/tasks/github-token.qmd
@@ -1,5 +1,7 @@
 ---
 title: Create Finely Grained Access Token
+aliases:
+  - ../admins/howto/github-token.html
 ---
 
 At <https://github.com/settings/personal-access-tokens/new>:

diff --git a/docs/admins/howto/google-sheets.qmd → docs/tasks/google-sheets.qmd b/docs/admins/howto/google-sheets.qmd → 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 → docs/tasks/index.qmd b/docs/admins/howto/index.qmd → docs/tasks/index.qmd
@@ -1,3 +1,5 @@
 ---
 title: Common Administrator Tasks
+aliases:
+  - ../admins/howto/index.html
 ---
diff --git a/...to/managing-multiple-user-image-repos.qmd → ...ks/managing-multiple-user-image-repos.qmd b/...to/managing-multiple-user-image-repos.qmd → ...ks/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 → docs/tasks/new-hub.qmd b/docs/admins/howto/new-hub.qmd → 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 → docs/tasks/new-image.qmd b/docs/admins/howto/new-image.qmd → 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 → docs/tasks/new-packages.qmd b/docs/admins/howto/new-packages.qmd → 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 → docs/tasks/prometheus-grafana.qmd b/docs/admins/howto/prometheus-grafana.qmd → 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 → docs/tasks/rebuild-hub-image.qmd b/docs/admins/howto/rebuild-hub-image.qmd → 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 → docs/tasks/rebuild-postgres-image.qmd b/docs/admins/howto/rebuild-postgres-image.qmd → 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 → docs/tasks/remove-users-orm.qmd b/docs/admins/howto/remove-users-orm.qmd → 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 → docs/tasks/transition-image.qmd b/docs/admins/howto/transition-image.qmd → 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.