diff --git a/README.md b/README.md index fae783b..f7d9577 100644 --- a/README.md +++ b/README.md @@ -5,4 +5,3 @@ A short introduction to Git, VSCode and Jupyter Books for teachers and TA's. Cur ## Contributing Feedback is always welcome. If something doesn't work, or if you have suggestions, you can always make an issue on the Issue Board or make a Merge Request. - diff --git a/book/workflows/git-branch.md b/book/workflows/git-branch.md index e14f894..0366f57 100644 --- a/book/workflows/git-branch.md +++ b/book/workflows/git-branch.md @@ -50,10 +50,6 @@ The branch selection menu, where our new branch has shown up. 5. Now that we've created and checked out our new branch, we can start {ref}`making and committing changes `. -## Predefined branches +## The `publish` branch -If your repository is located in the [Interactive Textbooks CiTG](https://gitlab.tudelft.nl/interactivetextbooks-citg) group on GitLab, it is likely that it already has some predefined branches in addition to `main`, namely `publish` and `publish-html`. These branches serve the following purposes: - -- `main`: this is the main development branch on which new changes are collected. When the work on your own branch is done, you make a merge request to add your changes to `main`. This branch is protected, meaning that all changes to this branch have to be done via merge requests and you cannot push to it directly. -- `publish`: this is the version of the book that is visible to the public (i.e., the version that the students will see). Again, you cannot push directly to this branch. -- `publish-html`: this branch contains the HTML of the version of the book that lives on the `publish` branch. When a new version of the book is merged in the `publish` branch, the new book is built using the `jupyter book build` command and the HTML is uploaded to `publish-html`. The webserver is constantly fetching this branch and pulling any incoming changes. +If your repository is located in the [Interactive Textbooks CiTG](https://gitlab.tudelft.nl/interactivetextbooks-citg) group on GitLab, you will see that it already has a branch called `publish`. This branch is where the student version of your book should go. The idea behind this is that the student version of your book should only change a few times per year at most (and certainly not right before an exam!) to prevent confusion. This way, you can still make frequent changes to the `main` branch.