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 doc and make generic #457

Merged
merged 3 commits into from
Jan 29, 2018

Conversation

willingc
Copy link
Collaborator

Partially addresses #392.

  • Reordered some sections starting with tips and warnings
  • Shorten specific release sections
    • refer 0.6 upgrade to CHANGELOG
    • refer 0.5 upgrade to 0.5 docs and remove 0.5 specific information
  • Make subtopics/subsystems generic
  • Add a very brief troubleshooting tip for upgrading

@choldgraf
Copy link
Member

choldgraf commented Jan 29, 2018

This looks great! Made some very small type-o edits and added an extra link in there, thanks @willingc ! (will merge when travis is happy)

@choldgraf choldgraf merged commit af30856 into jupyterhub:master Jan 29, 2018
staging cluster first before applying it to production. Feel free to reach out
to us on [gitter](http://gitter.im/jupyterhub/jupyterhub) or the [mailing
list](https://groups.google.com/forum/#!forum/jupyter) for upgrade help!
- We **recommend** a full fresh installation instead of upgrade if you can,
Copy link
Collaborator

Choose a reason for hiding this comment

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

I don't think we recommend this in general, only for specific cases (such as for 0.4 - 0.5). I don't think we should mark this as a general recommendation.

Copy link
Collaborator

Choose a reason for hiding this comment

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

I think I'll actually just send a followup PR instead of nitpicking here! Didn't realize it got merged :)

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

Makes sense.

but recognize that it is not possible all the time.
- Minor revisions: It should be safe to upgrade a minor revision of the chart to
receive bugfixes and improvements.
- Major chart upgrades (e.g. v0.5 to 0.6): This is more challenging than a
Copy link
Collaborator

Choose a reason for hiding this comment

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

We also try to make these as easy as possible, and put a bit of effort into it. I don't think we should call this challenging.

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

Lol. That was left over wording from before.. Please strike.

@choldgraf
Copy link
Member

(I can spot-check @yuvipanda comments in the upcoming changelog PR if that works for you all)

@willingc willingc deleted the update-upgradedoc branch January 29, 2018 21:28
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants