-
Notifications
You must be signed in to change notification settings - Fork 27
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
Conversation
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 | |||
"""""""""""""""" |
There was a problem hiding this comment.
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.
c3cd88c
to
c1922c4
Compare
c1922c4
to
a7a0bd0
Compare
docs/v3_services.rst
Outdated
--------------------------------------------------- | ||
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 |
There was a problem hiding this comment.
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.
There was a problem hiding this comment.
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".
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. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
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
Release
Checklist (Optional)
make docs-lint
) passed locallymake docs-linkcheck
) passedmake docs
) docs at http://localhost:8000