File tree Expand file tree Collapse file tree 1 file changed +21
-2
lines changed Expand file tree Collapse file tree 1 file changed +21
-2
lines changed Original file line number Diff line number Diff line change @@ -9,17 +9,36 @@ This textbook is offered under
9
9
the [ Attribution-NonCommercial-ShareAlike 4.0 International (CC BY-NC-SA 4.0) License] ( https://creativecommons.org/licenses/by-nc-sa/4.0/ ) .
10
10
See [ the license file] ( LICENSE.md ) for more information.
11
11
12
- ## Setup and Build
12
+ ## Development
13
+
14
+ ### Setup
13
15
14
16
In order to build the book, you need to first install Docker
15
17
(instructions here: [ https://docs.docker.com/get-docker/ ] ( https://docs.docker.com/get-docker/ ) ).
16
18
17
- You can then build the book by running
19
+ ### Contributing
20
+ Primary development in this repository happens on the ` dev ` branch. If you want to contribute to the book,
21
+ please branch off of ` dev ` and make a pull request into ` dev ` .
22
+
23
+ The ` main ` branch contains the source material for the live, publicly viewable HTML book.
24
+
25
+ ### Build locally
26
+
27
+ You can build the book on your own machine by running
18
28
```
19
29
./build_html.sh
20
30
```
21
31
in the root directory of this repository. The book can be viewed in your browser by opening the ` source/_build/html/index.html ` file.
22
32
33
+ ### Update build environment
34
+
35
+ You can update the build environment for the book by making changes to ` Dockerfile ` in the root of the repository in the ` main ` branch.
36
+ If you push any changes to the ` Dockerfile ` on the ` main ` branch, GitHub will trigger a rebuild of the docker image,
37
+ push it to DockerHub, and update the ` build_html.sh ` script and book deploy GitHub action with the new image digest.
38
+
39
+ ### Update public html
23
40
41
+ You can update the live, publicly viewable HTML book by making changes to the ` source/ ` folder in the ` main ` branch.
42
+ If you push any changes to the ` source/ ` folder on the ` main ` branch, GitHub will trigger a rebuild of the public HTML site.
24
43
25
44
You can’t perform that action at this time.
0 commit comments