From cd7093e1d4634979ae42adab9b2b8f953cc75dbd Mon Sep 17 00:00:00 2001 From: Tom van Woudenberg Date: Mon, 24 Feb 2025 21:44:09 +0100 Subject: [PATCH] Final stuff for today --- book/installation-and-setup/versioning.md | 2 +- book/installation-and-setup/versioning_archived.md | 2 +- book/installation-and-setup/versions_URLs.md | 2 +- 3 files changed, 3 insertions(+), 3 deletions(-) diff --git a/book/installation-and-setup/versioning.md b/book/installation-and-setup/versioning.md index 85eb2a2..0d9fbb4 100644 --- a/book/installation-and-setup/versioning.md +++ b/book/installation-and-setup/versioning.md @@ -21,7 +21,7 @@ Finally, you might consider publishing your book at an online publisher. This co So, there's a few use-cases for which different (combinations) of solutions exist. These are summarized in the table below in order of increasingly effort and impact. You can combine use-cases to your liking: -| Use-case | [Publish versions on separate URLs](./versions_URLs.md) | [Publish source code of all versions](./versioning_archived.md) | [Use TeachBooks versioning with a changelog](versioning_changelog) | [Publish your book officially](./publisher.md) | +| Use-case | [Publish versions on separate URLs](./versions_URLs.md) | [Publish source code of all versions](./versioning_archived.md) | [Use TeachBooks versioning with a changelog](versioning_changelog) | [Publish your book with a publisher](./publisher.md) | |:---:|:---:|:---:|:---:|:---:| | Book changes over time, but you don't want to deal with versioning | | | | | | Occasionally releasing a new version while keeping the previous version, with minimal effort for versioning | Recommended | Can be considered | | | diff --git a/book/installation-and-setup/versioning_archived.md b/book/installation-and-setup/versioning_archived.md index af3899f..1b6746b 100644 --- a/book/installation-and-setup/versioning_archived.md +++ b/book/installation-and-setup/versioning_archived.md @@ -1,4 +1,4 @@ -# Keep source code and website of all versions +# Publish source code of all versions In case you'd like other to use your source code and you've different versions, it might be useful to have the source code of those versions somewhere too. Don't be afraid, git makes it very easy to make this possible. diff --git a/book/installation-and-setup/versions_URLs.md b/book/installation-and-setup/versions_URLs.md index f40266d..8cc7e53 100644 --- a/book/installation-and-setup/versions_URLs.md +++ b/book/installation-and-setup/versions_URLs.md @@ -12,7 +12,7 @@ To share the built book / website of old versions for your book on GitHub you've - If you're using tags (as will be explained in [later](./versioning_changelog.md)), you can create a branch from a tag locally by running: `git branch `. - 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. - add a zip of the built book to the release in GitHub as binary asset. This requires readers to download the zip and open the html files locally, but doesn't require you to host it somewhere. This zip can be easily downloaded as an artifact from [the GitHub action](../external/deploy-book-workflow/README.md). An example can be found [here](https://github.com/TUDelft-books/CME4501/releases/tag/v2024.1.0). Note that this requires you to set up tags and releases, as explained in [](versioning_changelog.md) -- Use [Read the Docs](../features/pull_request_build.md) to build a website for all your branches, forks and tags as Read the docs doesn't have a 1 GB limit, but has a very different URL structure. In case you're using tags and release, refer to the URL of this built from your GitHub release. +- Use [Read the Docs](../features/pull_request_build.md) to build a website for all your branches, forks and tags as Read the docs doesn't have a 1 GB limit, but has a very different URL structure and the free community version has advertisement. In case you're using tags and releases, refer to the URL of this built from your GitHub release to make sure that GitHub visitors find their way to Read the Docs. If you've your own webserver, you can publish each version on it manually.