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

Add upgrade guide for 2.11.0 #617

Open
wants to merge 3 commits into
base: main
Choose a base branch
from
Open

Add upgrade guide for 2.11.0 #617

wants to merge 3 commits into from

Conversation

nathandyer
Copy link
Contributor

Status

Ready for review

Description of Changes

  • Description: This adds an upgrade guide for 2.11.0. Notable changes here are that it also links out to the noble migration guide, and that it no longer specifies that users should upgrade to Tails 6 (we have been advising this in each release since 2.8.0, so I decided this is no longer necessary. If others feel we should include it again, I can add it back.)

  • Resolves Add upgrade guide for 2.11.0 #616

Testing

  • CI passes
  • Visual review

Release

  • To be released alongside SD 2.11.0

Checklist (Optional)

  • Doc linting (make docs-lint) passed locally
  • Doc link linting (make docs-linkcheck) passed
  • You have previewed (make docs) docs at http://localhost:8000

@legoktm legoktm self-assigned this Dec 12, 2024
Copy link
Member

@legoktm legoktm left a comment

Choose a reason for hiding this comment

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

Thanks, some notes inline

Update Workstations to SecureDrop 2.11.0
----------------------------------------

.. important:: We always recommend backing up your workstations prior to
Copy link
Member

Choose a reason for hiding this comment

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

Should this be removed now that the Tails 6 stuff was also removed?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I think it's generally good advice to recommend backups prior to updates (even relatively low-risk ones), so I'm inclined to leave it in

Copy link
Member

Choose a reason for hiding this comment

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

I agree with that sentiment, but I don't think the language matches, e.g. "but we especially recommend it before a major Tails version bump" even though we aren't telling them to do said bump. I'll defer to you on keeping it, but maybe the language can be further tweaked?

docs/upgrade/2.10.1_to_2.11.0.rst Show resolved Hide resolved
docs/upgrade/2.10.1_to_2.11.0.rst Show resolved Hide resolved
@nathandyer
Copy link
Contributor Author

Thank you for the review, @legoktm! Left one comment, and added your two suggestions; back to you.


After updating to SecureDrop 2.11.0 using the steps below, it's important
that you review our :doc:`Ubuntu 24.04 (Noble) migration guide <../admin/maintenance/noble_migration_prep>`,
and run the ``securedrop-noble-migration-check`` script prior to January 31st, 2025
Copy link
Member

Choose a reason for hiding this comment

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

Sorry for tweaking this again, now that we have the language in the pre-announcement post, can we reuse it here? (slightly tweaked to be post-release)

SecureDrop 2.11.0 will automatically run checks to ensure all servers are ready for migration to Ubuntu 24.04 (Noble). If issues are found, a banner will be displayed in the Journalist Interface to both admins and journalists. Administrators are encouraged to review the guide explaining how to resolve any errors and perform any necessary steps before Jan. 31st, 2025.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Status: Under Review
Development

Successfully merging this pull request may close these issues.

Add upgrade guide for 2.11.0
2 participants