From e14b8d8b775d1cd410e23896afa1e3232592ea86 Mon Sep 17 00:00:00 2001 From: Erik Sundell Date: Thu, 10 Aug 2023 15:17:03 +0200 Subject: [PATCH] docs: add section on whats done during upgrades --- docs/topic/index.md | 1 + docs/topic/installer-upgrade-actions.md | 30 +++++++++++++++++++++++++ 2 files changed, 31 insertions(+) create mode 100644 docs/topic/installer-upgrade-actions.md diff --git a/docs/topic/index.md b/docs/topic/index.md index 90e7e9c..dc38061 100644 --- a/docs/topic/index.md +++ b/docs/topic/index.md @@ -12,6 +12,7 @@ three-environments security customizing-installer installer-actions +installer-upgrade-actions tljh-config authenticator-configuration escape-hatch diff --git a/docs/topic/installer-upgrade-actions.md b/docs/topic/installer-upgrade-actions.md new file mode 100644 index 0000000..f367434 --- /dev/null +++ b/docs/topic/installer-upgrade-actions.md @@ -0,0 +1,30 @@ +(topic-installer-upgrade-actions)= + +# What is done during an upgrade of TLJH? + +Once TLJH has been installed, it should be possible to upgrade the installation. +This documentation is meant to capture the changes made during an upgrade. + +```{versionchanged} 1.0.0 +Ensuring upgrades work has only been done since 1.0.0 upgrading from version +0.2.0. +``` + +## Changes to the system environment + +The [system environment](system-environment) is not meant to be influenced +unless explicitly mentioned in the changelog, typically only during major +version upgrades. + +## Changes to the hub environment + +The [hub environment](hub-environment) gets several packages upgraded based on +version ranges specified in [tljh/requirements-hub-env.txt]. + +## Changes to the user environment + +The [user environment](user-environment) gets is `jupyterhub` package upgraded, +but no other packages gets upgraded unless explicitly mentioned in the +changelog, typically only during major version upgrades. + +[tljh/requirements-hub-env.txt]: https://github.com/jupyterhub/the-littlest-jupyterhub/blob/HEAD/tljh/requirements-hub-env.txt