Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

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

Open
fiver-watson opened this issue Jun 2, 2023 · 0 comments
Labels
admin manual The issue affects content in the Administrator manual minor fix The change requested by the issue will be minor in scope new content This issue will add a new section or page to the documentation

Comments

@fiver-watson
Copy link
Contributor

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:

  • Option 1 is to install from the downloadable tarball
  • Option 2 is to install from the GitHub code repository

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.

@fiver-watson fiver-watson added admin manual The issue affects content in the Administrator manual new content This issue will add a new section or page to the documentation minor fix The change requested by the issue will be minor in scope labels Jun 2, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
admin manual The issue affects content in the Administrator manual minor fix The change requested by the issue will be minor in scope new content This issue will add a new section or page to the documentation
Projects
None yet
Development

No branches or pull requests

1 participant