From f06a0ca8fc0e3098ad6e966534ba6a82b281855d Mon Sep 17 00:00:00 2001 From: Timothy Middelkoop Date: Wed, 3 Nov 2021 18:24:56 +0000 Subject: [PATCH] Update build instructions for path change --- Build.md | 12 +++++++----- scripts/{jupyter.sh => jupyter-lab.sh} | 0 2 files changed, 7 insertions(+), 5 deletions(-) rename scripts/{jupyter.sh => jupyter-lab.sh} (100%) diff --git a/Build.md b/Build.md index 8789c36..852be0a 100644 --- a/Build.md +++ b/Build.md @@ -2,27 +2,29 @@ ## Building and Publishing the Book +All the build scripts must be run from the top of the repository. + To build the book for local development run ``` -./build-book.sh +./scripts/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). +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 branch (`gcp-dev`, `aws-dev` and `azure-dev` branch). 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 +./scripts/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 +./scripts/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 +./scripts/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. diff --git a/scripts/jupyter.sh b/scripts/jupyter-lab.sh similarity index 100% rename from scripts/jupyter.sh rename to scripts/jupyter-lab.sh