diff --git a/02-schedule.md b/02-schedule.md index a81c90a..94a3662 100644 --- a/02-schedule.md +++ b/02-schedule.md @@ -13,11 +13,11 @@ AGU! | Time | Duration | Topic | Presenter(s) | |-----------|-------------|-------------------------------------------------------------------------------------|-------------------| | 8:30 AM | 10 minutes | [Meet the instructors](00-instructors.md) | All | -| 8:40 AM | 45 minutes | [](materials/01-working-in-jupyterhub/index.md) | Tasha | +| 8:40 AM | 45 minutes | [](modules/01-working-in-jupyterhub/index.md) | Tasha | | 9:25 AM | 10 minutes | **Break** | | -| 9:35 AM | 60 minutes | [](materials/02-interactive-viz/index.md) | Qiusheng | +| 9:35 AM | 60 minutes | [](modules/02-interactive-viz/index.md) | Qiusheng | | 10:35 AM | 10 minutes | **Break** | | -| 10:45 AM | 60 minutes | [](materials/03-integrating-ai/index.md) | Qiusheng | +| 10:45 AM | 60 minutes | [](modules/03-integrating-ai/index.md) | Qiusheng | | 11:45 AM | 15 minutes | **Q&A** | All | @@ -34,10 +34,10 @@ We may do a group order for food delivery. | Time | Duration | Topic | Presenter(s) | |-----------|-------------|-----------------------------------------------------------------------------------|-------------------| -| 1:30 PM | 60 minutes | [](materials/04-data-in-the-cloud/index.md) | Max | +| 1:30 PM | 60 minutes | [](modules/04-data-in-the-cloud/index.md) | Max | | 2:30 PM | 10 minutes | **Break** | | -| 2:40 PM | 60 minutes | [](materials/05-sharing-and-publishing/index.md) | Fernando & Matt | +| 2:40 PM | 60 minutes | [](modules/05-sharing-and-publishing/index.md) | Fernando & Matt | | 3:40 PM | 10 minutes | **Break** | | -| 3:50 PM | 55 minutes | [](materials/06-geojupyter/index.md) | Fernando & Matt | +| 3:50 PM | 55 minutes | [](modules/06-geojupyter/index.md) | Fernando & Matt | | 4:45 PM | 15 minutes | **Closing Q&A** | All | | 5:00 PM | | **End of day** | | diff --git a/assets/images/cryocloud-hub-control-panel.png b/assets/images/cryocloud-hub-control-panel.png new file mode 100644 index 0000000..d2a59a1 Binary files /dev/null and b/assets/images/cryocloud-hub-control-panel.png differ diff --git a/assets/images/cryocloud-server-options.png b/assets/images/cryocloud-server-options.png new file mode 100644 index 0000000..7a7952f Binary files /dev/null and b/assets/images/cryocloud-server-options.png differ diff --git a/assets/images/cryocloud-server-starting.png b/assets/images/cryocloud-server-starting.png new file mode 100644 index 0000000..fe4e1fa Binary files /dev/null and b/assets/images/cryocloud-server-starting.png differ diff --git a/for-instructors/dogfooding.md b/for-instructors/dogfooding.md new file mode 100644 index 0000000..788764e --- /dev/null +++ b/for-instructors/dogfooding.md @@ -0,0 +1,22 @@ +# πŸ• Dogfooding our processes + +["Dogfooding" or "eating our own dog food"](https://en.wikipedia.org/wiki/Eating_your_own_dog_food) +refers to the practice of using our own product. +This is important because it enables us to continuously test the same experience that +our users will use on the day of the workshop. + + +## Setup + +You'll need to be familiar with the following processes: + +* [](../reference/01-starting-your-server.md) +* [](../reference/02-stopping-your-server.md) +* [](../reference/03-gh-auth.md) + +Once you've set up GitHub authentication, you can use Git normally. + + +## Previewing the MyST site + +TODO diff --git a/for-instructors/style-guide.md b/for-instructors/style-guide.md index 128837d..7b2b7b7 100644 --- a/for-instructors/style-guide.md +++ b/for-instructors/style-guide.md @@ -117,7 +117,7 @@ Follow the [DiΓ‘taxis](https://diataxis.fr) principles for your audience! ### Vocabulary -All vocabulary should be defined in the [](../03-vocabulary.md) page. +All vocabulary should be defined in the [](../reference/00-vocabulary.md) page. Follow the pre-existing pattern to add new terms. References should be conscious of case. diff --git a/materials/01-working-in-jupyterhub/index.md b/modules/01-working-in-jupyterhub/index.md similarity index 100% rename from materials/01-working-in-jupyterhub/index.md rename to modules/01-working-in-jupyterhub/index.md diff --git a/materials/01-working-in-jupyterhub/slides.png b/modules/01-working-in-jupyterhub/slides.png similarity index 100% rename from materials/01-working-in-jupyterhub/slides.png rename to modules/01-working-in-jupyterhub/slides.png diff --git a/materials/01-working-in-jupyterhub/stop_server.png b/modules/01-working-in-jupyterhub/stop_server.png similarity index 100% rename from materials/01-working-in-jupyterhub/stop_server.png rename to modules/01-working-in-jupyterhub/stop_server.png diff --git a/materials/02-interactive-viz/index.md b/modules/02-interactive-viz/index.md similarity index 100% rename from materials/02-interactive-viz/index.md rename to modules/02-interactive-viz/index.md diff --git a/materials/03-integrating-ai/index.md b/modules/03-integrating-ai/index.md similarity index 100% rename from materials/03-integrating-ai/index.md rename to modules/03-integrating-ai/index.md diff --git a/materials/04-data-in-the-cloud/index.md b/modules/04-data-in-the-cloud/index.md similarity index 100% rename from materials/04-data-in-the-cloud/index.md rename to modules/04-data-in-the-cloud/index.md diff --git a/materials/05-sharing-and-publishing/index.md b/modules/05-sharing-and-publishing/index.md similarity index 100% rename from materials/05-sharing-and-publishing/index.md rename to modules/05-sharing-and-publishing/index.md diff --git a/materials/06-geojupyter/index.md b/modules/06-geojupyter/index.md similarity index 100% rename from materials/06-geojupyter/index.md rename to modules/06-geojupyter/index.md diff --git a/myst.yml b/myst.yml index 1e4682a..56eb43a 100644 --- a/myst.yml +++ b/myst.yml @@ -14,9 +14,12 @@ project: toc: - file: "index.md" - pattern: "0*.md" - - title: "Materials" + - title: "Modules" children: - - pattern: "materials/0*/index.md" + - pattern: "modules/0*/index.md" + - title: "Reference" + children: + - pattern: "reference/*.md" - title: "For instructors" children: - pattern: "for-instructors/*.md" diff --git a/03-vocabulary.md b/reference/00-vocabulary.md similarity index 100% rename from 03-vocabulary.md rename to reference/00-vocabulary.md diff --git a/reference/01-starting-your-server.md b/reference/01-starting-your-server.md new file mode 100644 index 0000000..8299906 --- /dev/null +++ b/reference/01-starting-your-server.md @@ -0,0 +1,43 @@ +# πŸš€ Starting your server + +Everything in this workshop will be done on your own personal server on +[the CryoCloud JupyterHub](https://hub.cryointhecloud.com/). + +**Your server's disk space is persistent, meaning that any files you create will still +exist after you stop and restart your server.** + + +## Server options + +Once you're logged in to [the CryoCloud JupyterHub](https://hub.cryointhecloud.com), +you'll be presented with a screen like this: + +![](../assets/images/cryocloud-server-options.png) + +Select: + +* **Environment**: "Other..." +* **Custom image**: `ghcr.io/geojupyter/workshop-open-source-geospatial:latest` + * TODO: Update `latest` to a fixed tag +* **Resource allocation**: "~4GB RAM, ~0.5 CPUs" + +:::{important} +It's critical to only allocate the resources you need so that CryoCloud can sustain its +operations! + +If you find your analysis requires more resources than you allocated, you can +[stop your server](./02-stopping-your-server.md) and recreate it with more resources. + +It's also important to [stop your server](./02-stopping-your-server.md) when you're not +using it. +::: + + +## Click "Start" + +When you click start, CryoCloud will begin creating your personal server. +You should see a progress bar like this: + +![](../assets/images/cryocloud-server-starting.png) + +After a few moments, you'll be presented with the JupyterLab interface. diff --git a/reference/02-stopping-your-server.md b/reference/02-stopping-your-server.md new file mode 100644 index 0000000..78db7c1 --- /dev/null +++ b/reference/02-stopping-your-server.md @@ -0,0 +1,17 @@ +# πŸ›‘ Stopping your server + +**It's important to stop your server when you're not using it.** +This way CryoCloud can keep its cost down and remain available for you to use for free +in the future! + + +## Hub Control Panel + +Your "Hub Control Panel" allows you to manage your server. + +To access the control panel, click **File**, then **Hub Control Panel**. + +![](../assets/images/cryocloud-hub-control-panel.png) + +Click **Stop My Server**, and wait a few seconds. +Once your server is stopped, the **Stop My Server** button will disappear. diff --git a/reference/03-gh-auth.md b/reference/03-gh-auth.md new file mode 100644 index 0000000..7211a1d --- /dev/null +++ b/reference/03-gh-auth.md @@ -0,0 +1,33 @@ +# πŸ” Configuring GitHub authentication + +GitHub authentication on shared cloud infrastructure is complicated. + +Always remember, "cloud" is the same as "someone else's computer". +It's not a good idea to store your credentials on someone else's computer! + +For this reason, we use a special tool called `gh-scoped-creds` to provide a special +credential which grants restricted access to only certain GitHub resources for a limited +amount of time. + + +## Copy the GitHub authentication Notebook + +There's a special notebook titled `GHAUTH.ipynb` in the `shared/` directory. + +Right-click it, select "**Copy**", then return to your home directory by clicking the πŸ“ +icon at the top of your file browser. +Finally, right click in the empty space in your home directory and select "**Paste**". + +:::{hint} +Right-click this notebook and select "Add Favorite" to enable quick access in the +future! +::: + + +## Follow the instructions in the Notebook + +**The first time you use this Notebook, you should open the "First time setup" hint and +follow the instructions within.** + +After you've completed first-time setup, run the code cell at the end of the Notebook +and carefully follow the instructions output by this cell.