artefactual / atom-docs

Access to Memory (AtoM) documentation
https://www.accesstomemory.org/docs
Creative Commons Attribution Share Alike 4.0 International
17 stars 26 forks source link

Suggestion: Add upgrade in-place instructions for code repository installations performing minor upgrades #219

Open fiver-watson opened 1 year ago

fiver-watson commented 1 year ago

Documentation version

2.7, 2.8

Relevant documentation pages

Description

A suggestion from the User Forum, 2023-06-02: https://groups.google.com/g/ica-atom-users/c/f5_Qw_Mhfuk/m/U1AIyIEHAwAJ

We offer 2 methods of installing in our primary documentation:

Because Artefactual has consistently avoided including database schema migrations in point releases, it is generally possible to upgrade in place when Option 2 is followed. However, this is not well documented or clear to end-users with varying degrees of experience with software maintenance and git, and there are numerous examples in the forum (including in the link above) of users seeking guidance on how to perform minor upgrades in place and avoid needing to do an entire install for some generally minor fixes.

Recommended fix

As is correctly noted in the forum post, since we support Option 2 as an installation method, we should consider including a brief section in the Upgrade page about how to upgrade in place for those who followed the code repository installation method originally.