[docs] Add UPDATING documenting important and breaking changes

The first example of these changes relates to the latest Nextcloud
upgrades to major version 24.

Operators are now expected to read the latest version this file before
updating their instances.
merge-requests/62/head
Evilham 2022-12-23 10:54:37 +01:00
parent f55e830e2c
commit 3cfa0630d6
No known key found for this signature in database
GPG Key ID: AE3EE30D970886BF
3 changed files with 49 additions and 0 deletions

47
UPDATING.md Normal file
View File

@ -0,0 +1,47 @@
# Updating
It is quite important for operators to check this file before updating their
production instances, as it may contain information that is critical for good
continuity of the services.
# Kinds of breaking changes
## Nextcloud upgrades
Nextcloud upgrades must be carried out in a very specific order, if you follow
DD closely you should not have issues with this on 2023 and beyond.
However, if you run an older instance, please find the
**2022-12 - Nextcloud 24** section on this document, and follow the commands
closely.
Further major upgrades will be documented here too, but they should have
little to no impact.
# Important changes in reverse chronological order
## 2022
### 2022-12 - Nextcloud 24
Starting with commits in december, DD's blessed Nextcloud version is 24.0.8.
Work is already being carried out to upgrade this to major version 25.
In order to safely upgrade to major version 24, the upgrade must be performed
step-wise:
# Latest commit with NC major version 21 by default
./dd-ctl update db4a6d14e9a05ee1b0334aaf87af31703a4ae4d0
# Upgrade to NC version 22
./dd-ctl update cbb4e06e896da40430d66435589ab5ea8cf71420
# Upgrade to NC version 23
./dd-ctl update 57c87d7172579b8fbe0d8249f47ee0966621e252
# Upgrade to NC version 24.0.8 (latest minor on december 2022)
./dd-ctl update f55e830e2cd3071aceb604642fcfb5fdd8d5df17
#
# Upgrade to latest state of DD
# (read more recent notices of important changes before running this)
#./dd-ctl update

1
docs/updating.md Symbolic link
View File

@ -0,0 +1 @@
../UPDATING.md

View File

@ -58,6 +58,7 @@ nav:
- index.ca.md - index.ca.md
- index.es.md - index.es.md
- install.ca.md - install.ca.md
- updating.md
- customising.ca.md - customising.ca.md
- integrations.ca.md - integrations.ca.md
- post-install.ca.md - post-install.ca.md