Skip to content
Snippets Groups Projects
Commit 283411d8 authored by sheepmax's avatar sheepmax
Browse files

Small tweaks to READMEs

parent 9257bb43
No related branches found
No related tags found
2 merge requests!37Publish current website,!23Build and deploy with Docker
Pipeline #205481 passed
......@@ -172,3 +172,7 @@ Mostly I copied files, but also:
- find/replace to add sub-dir references
- added `_dont_execute` wildcard to config (change toc and filename for 3 nb's)
- need to move up one extra dir for figure and code includes
### Running `.sh` files on Windows
To run a `.sh` in Windows, make sure you have Git installed. If Windows still doesn't recognize the file as executable, right click it and select `Open With`, then click `Git for Windows`, and set it as the default too.
......@@ -38,7 +38,7 @@ The typical workflow is:
- Open Docker Desktop and make sure the empty container page loads. This means the Docker Engine is ready to build your book.
- Run the `deploy-docker.sh` script. You should see the book build output in the terminal window.
- _Note: after you run_ `deploy-docker.sh` _successfully for the first time, you can start the container directly in Docker Desktop._
- View the book at [http://localhost:8000/](http://localhost:8000/) (_not_ the local build at `./book/_build/html/index.html`---the interactive features won't work!). You can also open this by clicking the link in the Container tab
- By default you can view the book at [http://localhost:8000/](http://localhost:8000/) (_not_ the local build at `./book/_build/html/index.html`---the interactive features won't work!). You can also open this by clicking the link in the Container tab. To turn off this feature, run the `deploy-docker.sh` from the command line and pass in `false` as the first argument - you will have to run a HTTP server manually.
- once the book is successfully deployed, press Ctrl-C to exit back to terminal so you can run further commands (e.g. `stop-deployment.sh` discussed below). The container will keep running in the background.
- Do whatever book tasks you have: read, edit, use, etc
- If you need to rebuild the book to check your changes, run `deploy-docker.sh` again. You may also need to refresh the page you're viewing, and potentially clear the browser cache to see the changes (contact Robert if there is a problem).
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment