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

Update upgrade notes in CONTRIBUTING.md, README.md, values.yaml #602

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

jessebot
Copy link
Collaborator

@jessebot jessebot commented Jul 25, 2024

Description of the change

Adds a section about upgrades to clarify we should only do one major version at a time.

Benefits

just a little doc change to prevent gotchya :)

Possible drawbacks

open to feedback but I think this is minor enough that it's fine.

Applicable issues

Additional information

Checklist

@jessebot jessebot added the enhancement New feature or request label Jul 25, 2024
@jessebot jessebot self-assigned this Jul 25, 2024
@jessebot jessebot added the documentation Improvements or additions to documentation label Jul 25, 2024
@jessebot
Copy link
Collaborator Author

I could improve this PR by also making a note in the values.yaml for the image.tag parameter as mentioned in #103 if you agree that's a good idea?

Copy link
Member

@provokateurin provokateurin left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Upgrading to the latest minor version before upgrading to the next major version should probably also be documented: https://docs.nextcloud.com/server/latest/admin_manual/maintenance/upgrade.html#approaching-upgrades
This is not only for creating PRs to update the default version but also for the people who deploy the updates.

@provokateurin
Copy link
Member

I could improve this PR by also making a note in the values.yaml for the image.tag parameter as mentioned in #103 if you agree that's a good idea?

Yeah that would be nice too, just to prevent people ending up in broken states...

@jessebot
Copy link
Collaborator Author

Wait, the docs are confusing, due to grammar:

Before you can upgrade to the next major release, Nextcloud upgrades to the latest point release.

If it's what you're saying here:

Upgrading to the latest minor version before upgrading to the next major version should probably also be documented

Then shouldn't it be this?:

Before you can upgrade to the next major release, you need to upgrade to the latest minor for your current major version.

If I can find the repo I need to change this in, I can go update that grammar 🤷

Happy to document that here as well though :)

@jessebot jessebot force-pushed the fix-20-by-adding-upgrades-section branch from b4b6f22 to a6e0d90 Compare July 25, 2024 18:41
@jessebot jessebot changed the title Update CONTRIBUTING.md - fix #20 by adding a section on version upgrades Update upgrade notes in CONTRIBUTING.md, README.md, values.yaml Jul 25, 2024
@jessebot jessebot changed the title Update upgrade notes in CONTRIBUTING.md, README.md, values.yaml Update upgrade notes in CONTRIBUTING.md, README.md, values.yaml Jul 25, 2024
@provokateurin
Copy link
Member

Yes that sounds wrong indeed, you can fix it in https://github.com/nextcloud/documentation

@jessebot
Copy link
Collaborator Author

PR here :) nextcloud/documentation#12062

@jessebot jessebot force-pushed the fix-20-by-adding-upgrades-section branch from a6e0d90 to b1aef0d Compare July 26, 2024 12:53
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation enhancement New feature or request upgrades
Projects
None yet
2 participants