update student version with curriculum book changes

.github/actions/README.md

@@ -12,6 +12,9 @@ Steps to configure conda environment required to build the website.
 #### [buildresources](./actions/buildresources/action.yaml)
 Steps to build the hackweek landing webpage and JupyterBook.
 
+#### [studentversion](./actions/studentversion/action.yaml)
+Steps to push cleaned versions of the books to the student repo.
+
 
 ## Workflows
 
@@ -21,7 +24,10 @@ The `workflows/` subfolder contains continuous integration workflows
 Create [binder](https://mybinder.readthedocs.io/en/latest/howto/gh-actions-badges.html) badges with links to test tutorial notebooks
 
 #### [deploy.yaml](./actions/workflows/deploy.yaml)
-Render and publish the websites (JupyterBook and landing page) to GitHub Pages
+Render and publish the websites (JupyterBook and landing page) to GitHub Pages (runs only on teacher version of the repo)
+
+#### [clean.yaml](./actions/workflows/clean.yaml)
+If running on teacher repo, pushes cleaned books to student version. If running on student version, renders and publishes the website to GitHub Pages.
 
 #### [manual.yaml](./actions/workflows/manual.yaml)
 Bypass usage of the cache to manually trigger a full rebuild of the JupyterBook and landing page

.github/workflows/clean_book.py

@@ -90,14 +90,5 @@ def cleanBook(book_in, book_out):
 for book in books:
   cleanBook(book, book)
 
-  '''
-  # six for length of .ipynb extension
-  output = book[:-6] + "_cleaned.ipynb"
-  cleanBook(book, output)
-
-  # TODO: REMOVE LATER!! FOR TESTING PURPOSES ONLY!!
-  os.remove(output)
-  '''
-
 print("\n=================================================")
 print(f"Finished book cleaning for all {len(books)} books\n")

CHANGELOG.md

@@ -9,4 +9,7 @@ and this project adheres to [Calendar Versioning](https://calver.org)
 - Created skeleton repository from uwhackweek/jupyterbook-template
 
 ## 2022-09-28
-- Adapted Use Case book into new curriculum book with improved structure
+- Adapted Use Case book into new curriculum book with improved structure
+
+## 2022-11-15
+- Set up github actions and personal access token for CI with student version

CONTRIBUTING.md

@@ -19,7 +19,7 @@ To build our website, we need specific Python packages which are managed with th
 1. Clone your fork locally:
 
     ```sh
-    git clone https://github.com/geo-smart/book.git
+    git clone https://github.com/geo-smart/curriculum_book.git
     cd book
     ```
 
@@ -54,4 +54,4 @@ To build our website, we need specific Python packages which are managed with th
     git push origin name-of-your-bugfix-or-feature
     ```
 
-1. Open a pull request through the GitHub website: https://github.com/geo-smart/book
+1. Open a pull request through the GitHub website: https://github.com/geo-smart/curriculum_book

README.md

@@ -3,5 +3,6 @@
 [![Deploy](https://github.com/geo-smart/curriculum-book/actions/workflows/deploy.yaml/badge.svg)](https://github.com/geo-smart/curriculum-book/actions/workflows/deploy.yaml)
 [![Jupyter Book Badge](https://jupyterbook.org/badge.svg)](https://geo-smart.github.io/curriculum-book)
 [![Binder](https://mybinder.org/badge_logo.svg)](https://mybinder.org/v2/gh/geo-smart/curriculum-book/HEAD?urlpath=lab)
+[![Student Version](./student_version_badge.svg)](https://geo-smart.github.io/curriculum-book-student/)
 
 This repository stores configuration for GeoSMART curriculum content.