Skip to content

Commit

Permalink
Merge pull request berkeley-dsep-infra#5938 from ryanlovett/docs-links
Browse files Browse the repository at this point in the history
Restore old action, and fix links.
  • Loading branch information
ryanlovett authored Aug 11, 2024
2 parents de7f412 + 5713f78 commit 797f79d
Show file tree
Hide file tree
Showing 4 changed files with 8 additions and 33 deletions.
26 changes: 1 addition & 25 deletions .github/workflows/quarto-docs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -18,34 +18,10 @@ jobs:
- name: Set up Quarto
uses: quarto-dev/quarto-actions/setup@v2

## We could render and publish in one step, however we need to, at
## least temporarily, preserve the old en/latest/ paths from the
## readthedocs version. So we render, create the link, then publish.
#- name: Render and Publish
# uses: quarto-dev/quarto-actions/publish@v2
# with:
# path: ./docs
# target: gh-pages
# env:
# GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

- name: Render
uses: quarto-dev/quarto-actions/render@v2
with:
path: ./docs
to: html

- name: Create en/latest symlink
run: |
mkdir ./docs/_site/en
cd docs/_site/en
ln -s ../../_site latest
- name: Publish
- name: Render and Publish
uses: quarto-dev/quarto-actions/publish@v2
with:
path: ./docs
target: gh-pages
render: false
env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
6 changes: 2 additions & 4 deletions docs/admins/howto/calendar-scaler.qmd
Original file line number Diff line number Diff line change
Expand Up @@ -131,8 +131,7 @@ functions.
When you're ready, create a PR. The deployment workflow is as follows:

1. Get all authed-up for `chartpress` by performing the
steps listed
[here](https://docs.datahub.berkeley.edu/en/latest/admins/howto/rebuild-hub-image.html#).
[documented steps](rebuild-hub-image.qmd).
2. Run `chartpress --push` from the root
`datahub/` directory. If this succeeds, check your `git
status` and add
Expand All @@ -155,8 +154,7 @@ to change/add/update any packages, you'll need to do the following:
5. Check your git status and diffs, and create a pull request if
necessary.
6. Get all authed-up for `chartpress` by performing the
steps listed
[here](https://docs.datahub.berkeley.edu/en/latest/admins/howto/rebuild-hub-image.html#).
[documented steps](rebuild-hub-image.qmd).
7. Run `chartpress --push` from the root
`datahub/` directory. If this succeeds, check your `git
status` and add
Expand Down
5 changes: 2 additions & 3 deletions docs/admins/howto/clusterswitch.qmd
Original file line number Diff line number Diff line change
Expand Up @@ -7,8 +7,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 specifications here:
https://docs.datahub.berkeley.edu/en/latest/admins/cluster-config.html
1. Create a new cluster using the specified [configuration](../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 CircleCI is using.
Expand Down Expand Up @@ -47,7 +46,7 @@ configured on the new cluster. Until this is done, `hubploy` and `helm` will fa
4. Change the corresponding entry in `support/requirements.yaml` to `$cert-manager-version` and commit the changes (do not push).

## Create the node-placeholder k8s namespace
The [calendar autoscaler](https://docs.datahub.berkeley.edu/en/latest/admins/howto/calendar-scaler.html) requires the `node-placeholder` namespace. Run the following command to create it:
The [calendar autoscaler](calendar-scaler.qmd) requires the `node-placeholder` namespace. Run the following command to create it:

```bash
kubectl create namespace node-placeholder
Expand Down
4 changes: 3 additions & 1 deletion docs/admins/howto/new-hub.qmd
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
---
title: Create a New Hub
aliases:
- ../../en/latest/admin/howto/new-hub.html
---

## Why create a new hub?
Expand Down Expand Up @@ -386,7 +388,7 @@ prometheus-node-exporter

Besides setting defaults, we can dynamically change the placeholder
counts by either adding new, or editing existing, [calendar
events](https://docs.datahub.berkeley.edu/en/latest/admins/howto/calendar-scaler.html).
events](calendar-scaler.qmd).
This is useful for large courses which can have placeholder nodes set
aside for predicatable periods of heavy ramp up.

Expand Down

0 comments on commit 797f79d

Please sign in to comment.