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

Condense and clarify v3 onion services migration docs #136

Merged
merged 2 commits into from
Jan 22, 2021

Conversation

rocodes
Copy link
Contributor

@rocodes rocodes commented Jan 21, 2021

Status

Ready for review

Description of Changes

  • Description:

  • Remove initial v3 preamble and reference glossary for further details about onion services

  • Clarify onion services migration requirements/consequences for failing to migrate

  • Link to glossary for clarification of terms

  • Tweak 'onion service' subheading in glossary, for clarity

  • Fixes Update v2/v3 Onion Page Text #122

Testing

  • manual review + linting

Release

  • n/a / with 1.7.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

@rocodes
Copy link
Contributor Author

rocodes commented Jan 21, 2021

cc @ninavizz : Thank you for your feedback, welcome your review!

@@ -111,8 +115,11 @@ service address for the SecureDrop website.
Read more about `onion services in Tor's glossary
<https://support.torproject.org/onionservices/>`__.

Onion Service v2
""""""""""""""""
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 changed this because previously, it said "Onion Service v2" and then the first sentence started "The third generation of onion services (v3) provides stronger... " etc; I found that slightly confusing.

---------------------------------------------------
SecureDrop administrators should enable v3 onion services as soon as possible.
This action will not affect sources or journalists, since the v2 onion
URLs will continue to work. Then, administrators should ensure that the
Copy link
Contributor Author

Choose a reason for hiding this comment

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

This action will not affect sources or journalists, since the v2 onion
URLs will continue to work

I feel like we need to say something like this so that administrators are aware they can take the first migration step without having to coordinate with journalists.

Copy link
Member

Choose a reason for hiding this comment

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

Makes sense, I just tweaked this slightly to avoid misinterpretation of "will continue to work".

@rocodes
Copy link
Contributor Author

rocodes commented Jan 22, 2021

I've left this in about as decent shape as I can :) I'm off for the rest of the day but @eloquence has said he'll push any changes he sees fit due to time-sensitive nature.

@eloquence eloquence self-assigned this Jan 22, 2021
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.

Very sensible changes, thanks @rocodes (and @ninavizz for suggestions incorporated here). I only pushed a tiny commit, so will go ahead and merge.

@eloquence eloquence merged commit 9dd1cae into freedomofpress:main Jan 22, 2021
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.

Update v2/v3 Onion Page Text
2 participants