Skip to content

Commit 2a9f65e

Browse files
update repo branch structure in README
1 parent 0843410 commit 2a9f65e

File tree

1 file changed

+7
-7
lines changed

1 file changed

+7
-7
lines changed

README.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -17,10 +17,10 @@ See [the license file](LICENSE.md) for more information.
1717
Building the book requires Docker (instructions here: [https://docs.docker.com/get-docker/](https://docs.docker.com/get-docker/)).
1818

1919
### 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`.
20+
Primary development in this repository happens on the `main` branch. If you want to contribute to the book,
21+
please branch off of `main` and make a pull request into `main`.
2222

23-
The `main` branch contains the source material for the live, publicly viewable HTML book.
23+
The `production` branch contains the source material for the live, publicly viewable HTML book.
2424

2525
### Build locally
2626

@@ -32,13 +32,13 @@ in the root directory of this repository. The book can be viewed in your browser
3232

3333
### Update build environment
3434

35-
You can update the build environment for the book by making changes to `Dockerfile` in the root of the repository in the `dev` branch.
36-
If you push any changes to the `Dockerfile` on the `dev` branch, GitHub will trigger a rebuild of the docker image,
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,
3737
push it to DockerHub, and update the `build_html.sh` script and book deploy GitHub action with the new image tag.
3838

3939
### Update public html
4040

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.
41+
You can update the live, publicly viewable HTML book by making changes to the `source/` folder in the `production` branch.
42+
If you push any changes to the `source/` folder on the `production` branch, GitHub will trigger a rebuild of the public HTML site.
4343

4444

0 commit comments

Comments
 (0)