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

Modify v3 migration instructions to emphasize concurrent upgrade path #71

Merged
merged 1 commit into from
Nov 9, 2020

Conversation

rocodes
Copy link
Contributor

@rocodes rocodes commented Oct 21, 2020

Status

Ready for review

Description of Changes

  • Simplify explanation of onion services as much as possible
  • Update v3 migration docs to emphasize concurrent v2+v3 migration path
  • Update information on v2 support timeline in SecureDrop
  • Clearly enumerate upgrade steps
  • Add note about human-readable onion URLs and link to blog post

Testing

  • visual review + linting

Release

  • n/a

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

docs/v3_services.rst Show resolved Hide resolved
- If your instance uses HTTPS, you will need to provision a new certificate for
the v3 *Source Interface* address - this will need to be done `after` the new
address has been generated.

.. note:: If your certificate provisioning process requires validation of the
Copy link
Contributor

Choose a reason for hiding this comment

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

Again, this is overly simple IMO, we should be upfront with folks about why they need to contact us.

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 just switched the order of these sentences, nothing was removed. Do you still feel like it's too simplistic? If so I can revert, but I think the note/callout reads clearer this way.

docs/v3_services.rst Outdated Show resolved Hide resolved
docs/v3_services.rst Show resolved Hide resolved
docs/v3_services.rst Outdated Show resolved Hide resolved
docs/v3_services.rst Outdated Show resolved Hide resolved
@eloquence
Copy link
Member

Thanks @rocodes, I quite like the improved organization of the procedural steps; once comments are resolved, I think this is good to go.

@rocodes rocodes force-pushed the v3-migration-clarify branch 2 times, most recently from 0a6c02f to 61fa02a Compare November 7, 2020 00:14
Copy link
Member

@eloquence eloquence left a comment

Choose a reason for hiding this comment

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

LGTM, thanks @rocodes!

@zenmonkeykstop zenmonkeykstop dismissed their stale review November 9, 2020 18:19

fair points were made.

@zenmonkeykstop zenmonkeykstop merged commit 9a2829d into freedomofpress:main Nov 9, 2020
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