zhangyiss/the-littlest-jupyterhub
1
0
Fork 0
mirror of https://github.com/jupyterhub/the-littlest-jupyterhub.git synced 2025-12-18 21:54:05 +08:00
Code Issues Packages Projects Releases Wiki Activity

docs: add section on whats done during upgrades

Browse Source
This commit is contained in:
Erik Sundell
2023-08-10 15:17:03 +02:00
parent cc00bf3a1a
commit e14b8d8b77
2 changed files with 31 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

1
docs/topic/index.md
View File

@@ -12,6 +12,7 @@ three-environments
security
customizing-installer
installer-actions
installer-upgrade-actions
tljh-config
authenticator-configuration
escape-hatch

30
docs/topic/installer-upgrade-actions.md Normal file
View File

@@ -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