admin2/manual_teachbooks
1
0
Fork 0
mirror of https://github.com/TeachBooks/manual.git synced 2026-11-12 22:35:51 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

Merge branch 'release' of https://github.com/TeachBooks/manual into release

Browse source
This commit is contained in:
Tom van Woudenberg 2025-11-03 13:58:28 +01:00
commit 4311f11d16
2 changed files with 3 additions and 3 deletions
Download patch file Download diff file Expand all files Collapse all files

4
book/features/release_book_online.md
View file

@ -18,7 +18,7 @@ This section is useful for user type 3-5.
[{octicon}`mark-github` Repository deploy book workflow](https://github.com/TeachBooks/deploy-book-workflow)
[{octicon}`book` Documentation](../installation-and-setup/versions_URLs.md)
[{octicon}`book` Publish version on separate (fixed) URLs](../installation-and-setup/versions_URLs.md)
{octicon}`pencil` Exercises:
- [Your version of the book](https://teachbooks.io/template/exercises/004.html)
@ -254,4 +254,4 @@ Unlike the virtual environments (next subsection), caches of the book build do n
### Effect of Caching on Virtual Environment
In particular, note that older branches may have been built with cached environments that are different than those in a newer branch, leading to (undesired) differences in book appearance or functionality---often without the author being aware! This occurs if a package in `requirements.txt` is updated in the time between the creation of environments on different branches, as `pip` will use the newest version when downloading a package (the first time a venv cache is created in the DBW), but it will not always automatically update a package if `pip install -r requirements.txt` is used on an existing environment (this happens every time an existing cache is used!). This means that, when compared to the venv on a newer branch, a frequently used branch (where the cache has not expired) may retain old and out of date packages long after an updated version is available; however, since the week number is included in the venv file hash, this will last for a maximum of 1 week. A best practice to avoid this situation is to pin version numbers explicitly (e.g., `teachbooks==0.2.0`) if you want book builds to remain consistent. In addition, a feature like dependabot can be used to automatically notify you when an update is made; this is [here](./update_env.md).
In particular, note that older branches may have been built with cached environments that are different than those in a newer branch, leading to (undesired) differences in book appearance or functionality---often without the author being aware! This occurs if a package in `requirements.txt` is updated in the time between the creation of environments on different branches, as `pip` will use the newest version when downloading a package (the first time a venv cache is created in the DBW), but it will not always automatically update a package if `pip install -r requirements.txt` is used on an existing environment (this happens every time an existing cache is used!). This means that, when compared to the venv on a newer branch, a frequently used branch (where the cache has not expired) may retain old and out of date packages long after an updated version is available; however, since the week number is included in the venv file hash, this will last for a maximum of 1 week. A best practice to avoid this situation is to pin version numbers explicitly (e.g., `teachbooks==0.2.0`) if you want book builds to remain consistent. In addition, a feature like dependabot can be used to automatically notify you when an update is made; this is [here](./update_env.md).

2
book/features/write_online.md
View file

@ -18,7 +18,7 @@ This section is useful for user type 3-5.
[{octicon}`mark-github` Repository template](https://github.com/TeachBooks/template)
[{octicon}`book` Documentation](../workflows/collaboration.md)
[{octicon}`book` Collaborative book-editing](../workflows/collaboration.md)
{octicon}`pencil` Exercises:
- [First file edit](https://teachbooks.io/template/exercises/001.html)