Skip to content
This repository was archived by the owner on Dec 12, 2025. It is now read-only.

Commit

Permalink
Build instructions
Browse files Browse the repository at this point in the history
  • Loading branch information
tmiddelkoop committed Nov 3, 2021
1 parent bbaa351 commit 3e0ee4d
Show file tree
Hide file tree
Showing 2 changed files with 21 additions and 1 deletion.
20 changes: 19 additions & 1 deletion Build.md
Original file line number Diff line number Diff line change
@@ -1,14 +1,32 @@
# Book Build Instructions

## Building and Publishing the Book

To build the book for local development run
```
./build-book.sh
```
This will create a local Python venv environment in `.venv/`, install Jupyter Book and dependcies and build it. The Jupyter Book content is located in `content`. The build process does not reevaluate the Jupyter Notbooks due to the complexity of building across all the providers in a single run. Development for each provider should be done in a `provider-dev` branch (`gcp-dev`, `aws-dev` and `azure-dev` branch).

To copy results to the `gh-pages` branch and push run
The resulting book is a set of static html pages found in [`content/_build/html/`](content/_build/html/). If development is being done remotly these pages can be exposed on port 8080 by running.
```
./preview-book.html
```
This runs a local http server enabling the "preview" feature of the Cloud Shell to view the rendered book. Visual Cloud Studio, when used in a remote shell, will also redirect this port to the local developmen machine and the previw can be found on [localhost:8080](http://localhost:8080).

To use GitHub pages to preview or publish run
```
./push-book.sh
```
THis will copy rendered content to the `gh-pages` branch and push to the `private` remote.

To publish to the `gh-pages` of the `origin` (or other) remote run.
```
./push-book.sh origin
```

This copies the contents of `content/_build/html/` to `docs/` so GitHub Pages will render the document. GitHub pages should be set to the `gh-pages` and `docs/` folder. The script pushes a new branch overwriting the old branch and will not track changes.


## GCP

Expand Down
2 changes: 2 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,2 +1,4 @@
# CLASS-core
Curriculum development for Cloud for Researchers, A Primer

For development see the [build instructions](Build.md).

0 comments on commit 3e0ee4d

Please sign in to comment.