Add reference

This commit is contained in:
Tom van Woudenberg 2025-02-22 11:09:44 +01:00
parent ac7051fc87
commit 5d253d440c
3 changed files with 13 additions and 2 deletions

View file

@ -60,6 +60,7 @@ The following pages contain content written by others, part of has been reused a
- Pages {ref}`copyright` and {ref}`copyright_considerations` include text from {cite:t}`tud_cip_24` that is used in the copyright checklist items. Original content licensed under CC BY.
- Page {ref}`copyright_licenses`: {numref}`Figure %s<fig_license_types>` is included unmodified, along with paraphrased and quoted text (including hyperlinks) from {cite:t}`hall21`. Work is licensed under CC BY.
- Page {ref}`copyright_licenses`: {numref}`Figure %s<fig_license_compatibility>` is included unmodified. Work is provided by Kennisland under a CC0 license. Accessed at [](https://wiki.creativecommons.org/wiki/File:CC_License_Compatibility_Chart.png) on December 17, 2024.
- page [](./installation-and-setup/versioning.md): include text from {cite:t}`semver` that has been modified. Original content licensed under CC BY 3.0.

View file

@ -1,5 +1,7 @@
# Versioning and URLs
> This page reuses adapted CC BY 3.0 content from Tom Preston-Werner {cite:p}`semver`. {fa}`quote-left`{ref}`Find out more here.<external_resources>`
```{admonition} User types
:class: tip
This page is useful for user type 4-5.
@ -23,7 +25,7 @@ Don't forget to explain how you organize these URLs in your README and eventuall
If you've many version of the book, at some point you might reach the 1 GB GitHub Pages limit. This is only expected for extremely large books with a lot of non-text-based (binary) content. To prevent going over that limit, store large content not used for building the website (like images) on an external server. This can be another GitHub repository or a (paid) object store
## Semantic versioning
Semantic versioning is used extensively in the world of software management to deal with versions. This is more suited than the more traditional way of versioning paper books (version 1, 2, etc.), because of the amount of edits which online books allow. There's [guidelines](https://semver.org/) about how to use a 'x.y.z' version numbers for software, for which we propose the following alternative for books:
Semantic versioning is used extensively in the world of software management to deal with versions {cite:p}`semver`. This is more suited than the more traditional way of versioning paper books (version 1, 2, etc.), because of the amount of edits which online books allow. There's [guidelines](https://semver.org/) about how to use a 'x.y.z' version numbers for software, for which we propose the following alternative for books:
1. A normal version number MUST take the form X.Y.Z where X, Y, and Z are non-negative integers, and MUST NOT contain leading zeroes. X is the major version or yearly version, Y is the minor version, and Z is the patch version. Each element MUST increase numerically. For instance: 1.9.0 -> 1.10.0 -> 1.11.0. or 2025.9.0 -> 2025.10.0 -> 2025.11.0
2. Once a versioned book has been released, the contents of that version MUST NOT be modified. Any modifications MUST be released as a new version.

View file

@ -133,4 +133,12 @@
url = {https://github.com/TeachBooks/Sphinx-Named-Colors},
year = {2024},
note = {Retrieved January 2025. MIT.}
}
}
@misc{semver,
author = {Tom Preston-Werner},
title = {Semantic Versioning specification},
url = {https://semver.org/},
year = {2025},
note = {Retrieved February 2025. CC BY 3.0.}
}