From 3c97679bb722421fa40c42033dba03a4a4e2d00f Mon Sep 17 00:00:00 2001 From: Tom van Woudenberg Date: Mon, 24 Feb 2025 21:30:42 +0100 Subject: [PATCH] WIP --- book/credits.md | 2 +- book/installation-and-setup/versioning.md | 2 -- book/installation-and-setup/versioning_changelog.md | 3 +++ 3 files changed, 4 insertions(+), 3 deletions(-) diff --git a/book/credits.md b/book/credits.md index ef9cdf1..c33d85c 100644 --- a/book/credits.md +++ b/book/credits.md @@ -60,7 +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` 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` 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): includes text from {cite:t}`semver` that has been modified. Original content licensed under CC BY 3.0. +- page [](./installation-and-setup/versioning_changelog.md): includes text from {cite:t}`semver` that has been modified. Original content licensed under CC BY 3.0. diff --git a/book/installation-and-setup/versioning.md b/book/installation-and-setup/versioning.md index 3a8a8fb..85eb2a2 100644 --- a/book/installation-and-setup/versioning.md +++ b/book/installation-and-setup/versioning.md @@ -1,7 +1,5 @@ # Versioning and URLs -> This page reuses adapted CC BY 3.0 content from Tom Preston-Werner {cite:t}`semver`. {fa}`quote-left`{ref}`Find out more here.` - ```{admonition} User types :class: tip This page is useful for user type 4-5. diff --git a/book/installation-and-setup/versioning_changelog.md b/book/installation-and-setup/versioning_changelog.md index d9fd37e..26aa67d 100644 --- a/book/installation-and-setup/versioning_changelog.md +++ b/book/installation-and-setup/versioning_changelog.md @@ -1,4 +1,7 @@ # TeachBooks versioning with changelog + +> This page reuses adapted CC BY 3.0 content from Tom Preston-Werner {cite:t}`semver`. {fa}`quote-left`{ref}`Find out more here.` + Versions combined with a changelog can be a very effective way to communicate book changes to the reader and allow reuse of specific versions. Inspired by versioning systems in software management (i.e. semantic and CalVer versioning) you can define a version guideline in which the version number tells the reader about the impact of the change. This might more suitable for your online books than the more traditional way of versioning paper books (version 1, 2, etc.), because of the amount of edits which online books allow. We recommend TeachBooks versioning, which comes in two flavors: 1. `academic_year.additions.errata` versioning for books tailed-made for courses in which content is added / adapted during the course and might be restructured extensively every year while remaining to be available in the original form.