search

archesproject / arches-docs

official repo for Arches documentation
https://arches.readthedocs.io
9 stars 20 forks source link

Create a section for upgrade paths #453

Open whatisgalen opened 1 month ago

whatisgalen commented 1 month ago

describe the issue

If someone's instance is on Arches 6.2 and they want to upgrade to the latest (7.6 right now, for example), the only way to know how to upgrade would be to look at every major and minor release note between to ensure that no steps were missed in upgrading their project and dependencies. Some steps are repeated between release notes, and some indicate that no major changes are needed for that version. In short: there's redundancy, and there's unneeded navigation, creating a less than ideal path.

An improvement on this would be to create a section in the docs that outlines singular paths from an origin version to a target version. Some versions could be clustered together as an origin version indicating that path would be the same, e.g. 5.1-5.2, 6.0-6.1, 7.0-7.3. Having one authoritative place with a linear path of upgrade steps would make it significantly easier for projects that need to upgrade versions.

please add links to existing docs or code (if relevant)
which release does this issue concern?

4+

chiatt commented 1 month ago

This could be a very large undertaking. To pare it down to something more manageable, I would suggest starting with instructions to move from one LTS to the latest version of the next major release (e.g. 6.2 LTS to 7.6 LTS). Then we can work on 7.6 to 8.0 and just update it as v8 minor versions are released (7.6 - 8.0 gets updated to become 7.6 - 8.1 and so on).

ekansa commented 4 weeks ago

@chiatt @whatisgalen Upgrading from LTS to LTS sounds like a good approach. How exactly does one do this? Does one need to use the release notes to go from one 6.2 to 7.0 then 7.1, 7.2, 7.3, 7.4, 7.5, then finally 7.6?