update student version with curriculum book changes

README.md

@@ -1,10 +1,43 @@
 # GeoSMART Curriculum Jupyter Book (ESS 469/569)
 
-[![Deploy](https://github.com/geo-smart/mlgeo-book/actions/workflows/deploy.yaml/badge.svg)](https://github.com/geo-smart/mlgeo-book/actions/workflows/deploy.yaml)
-[![Jupyter Book Badge](https://jupyterbook.org/badge.svg)](https://geo-smart.github.io/mlgeo-book)
-[![Binder](https://mybinder.org/badge_logo.svg)](https://mybinder.org/v2/gh/geo-smart/mlgeo-book/HEAD?urlpath=lab)
+[![Deploy](https://github.com/geo-smart/mlgeo-instructor/actions/workflows/deploy.yaml/badge.svg)](https://github.com/geo-smart/mlgeo-instructor/actions/workflows/deploy.yaml)
+[![Jupyter Book Badge](https://jupyterbook.org/badge.svg)](https://geo-smart.github.io/mlgeo-instructor)
+[![Binder](https://mybinder.org/badge_logo.svg)](https://mybinder.org/v2/gh/geo-smart/mlgeo-instructor/HEAD?urlpath=lab)
 [![GeoSMART Library Badge](book/img/curricula_badge.svg)](https://geo-smart.github.io/curriculum)
+[![Student Version](book/img/student_version_badge.svg)](https://geo-smart.github.io/mlgeo-book/)
 
-## About
+## Repository Overview
 
-This repository stores configuration for GeoSMART curriculum content, specifically the student version of the book. This version of the book should never be directly edited, as the student version is automatically generated on push.
+This repository stores configuration for GeoSMART curriculum content, specifically the teacher version of the book. Only this version of the book should ever be edited, as the student version is automatically generated on push by github actions.
+
+## Making Changes
+
+Edit the book content by modifying the `_config.yml`, `_toc.yml` and `*.ipynb` files in the `book` directory. The book is hosted on Github Pages and will be automatically updated on push, and the student book will also be created automatically on push.
+
+Making changes requires that you set up a conda environment and build locally before making sure that it will build with github actions. We accepted rendered notebooks, but some oddities, such as kernels different than python, will make it crash. So we recommend that contributors first build the book with the added notebooks.
+
+```sh
+    conda env create -f ./conda/environment.yml
+    conda activate curriculum_book
+
+```
+
+To modify the exact differences between this book and the student book, edit `.github/workflows/clean_book.py`. When you push, a github action will clone the repo and run this python file which modifies certain parts of `*.ipynb` file contents, then pushes to the student repo. To edit the student repo's README, edit `STUDENT_README.md`. The Github Actions workflow also automatically replaces `README.md` with `STUDENT_README.md` in the student repo.
+
+### `Student Response Sections`
+
+One modifications made by the `clean_book.py` workflow is to clear sections marked for student response. Code cells marked for student response may contain code in the teacher version of the book, but will have their code removed and replaced with a TODO comment in the student version.
+
+To mark a code cell to be cleared, insert a markdown cell directly preceding it with the following content:
+
+````markdown
+```{admonition} Student response section
+This section is left for the student to complete.
+```
+````
+
+## Serving Locally
+
+Activate the `curriculum_book` conda environment (or any conda environment that has the necessary jupyter book dependencies). Navigate to the root folder of the curriculum book repository in anaconda prompt, then run `python server.py`.
+
+On startup, the server will run `jb build book` to build all changes to the notebook and create the compiled HTML. The server code can take a `--no-build` flag (or `--nb` shorthand) if you don't want to build any changes you've made to the notebooks. In the case that you don't want to build changes made to the notebooks, you can just run `python serer.py --nb` from any terminal with python installed.

STUDENT_README.md

@@ -0,0 +1,10 @@
+# GeoSMART Curriculum Jupyter Book (ESS 469/569)
+
+[![Deploy](https://github.com/geo-smart/mlgeo-book/actions/workflows/deploy.yaml/badge.svg)](https://github.com/geo-smart/mlgeo-book/actions/workflows/deploy.yaml)
+[![Jupyter Book Badge](https://jupyterbook.org/badge.svg)](https://geo-smart.github.io/mlgeo-book)
+[![Binder](https://mybinder.org/badge_logo.svg)](https://mybinder.org/v2/gh/geo-smart/mlgeo-book/HEAD?urlpath=lab)
+[![GeoSMART Library Badge](book/img/curricula_badge.svg)](https://geo-smart.github.io/curriculum)
+
+## About
+
+This repository stores configuration for GeoSMART curriculum content, specifically the student version of the book. This version of the book should never be directly edited, as the student version is automatically generated on push.

book/Chapter1-GettingStarted/1.5_version_control_git.md

@@ -271,10 +271,10 @@ Further discussions [here](https://rewind.com/blog/best-practices-for-using-gith
 ```tree
 your-repo/ 
 ├── .github/ # GitHub-specific files (e.g., issue templates, workflows) 
-│ ├── ISSUE_TEMPLATE/ 
-│ ├── PULL_REQUEST_TEMPLATE.md 
+│ ├── ISSUE_TEMPLATE/ # for sophisticated community package
+│ ├── PULL_REQUEST_TEMPLATE.md  # for sophisticated community package
 │ └── workflows/ 
-│ └── ci.yml # Continuous Integration configuration 
+│ └── ci.yml # Continuous Integration configuration, publish package, build container, test, build github-pages
 ├── docs/ # Documentation files 
 │ ├── conf.py # Sphinx configuration file 
 │ ├── index.rst # Main documentation file 
@@ -292,11 +292,20 @@ your-repo/
 ├── .gitignore # Git ignore file 
 ├── environment.yml # Conda environment file 
 ├── requirements.txt # Pip requirements file 
-├── setup.py # Setup script for packaging 
+├── pyproject.toml # project TOML file for packaging 
 ├── README.md # Project README file 
 ├── LICENSE # License file 
 └── CONTRIBUTING.md # Contribution guidelines
 ```
+:::{note}
+Github actions allow for automated workflows such as:
+* Build and Publish GitHub Pages (a tool for HTML)
+* Build and push Docker Container (a tool for containers)
+* Testing codes
+* Set up, test, publish a Pypi package
+
+:::
+
 
 
 ### Explanation of Key Files and Directories
@@ -310,7 +319,7 @@ your-repo/
 - **`requirements.txt`**: Lists the pip dependencies for the project.
 - **`setup.py`** or **``pyproject.toml``**: Python packages have standards for packaging projects. ``setup.py`` is the traditional way of defining a python package. Because of new standard, we only detail the ``pyproject.toml`` below. You may find other examples of ``setup.py`` projects online.
 - **[`README.md`](https://github.com/matiassingers/awesome-readme)**: The main README file that provides an overview of the project.
-- **[`LICENSE`]()**: The license file for the project. Licensing is very important, you may find additional explanation for licensing on [ChooseALicense](https://choosealicense.com/).
+- **`LICENSE`**: The license file for the project. Licensing is very important, you may find additional explanation for licensing on [ChooseALicense](https://choosealicense.com/). You may need a specific language for a **software license** and for a **data license**.
 - **[`CONTRIBUTING.md`](https://github.com/geo-smart/mlgeo-book/blob/main/CONTRIBUTING.md)**: Guidelines for contributing to the project. [Awesome contributing guides](https://github.com/mntnr/awesome-contributing) can be used for inspiration!
 
 ### Example `pyproject.toml`