-
Notifications
You must be signed in to change notification settings - Fork 697
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
[docs] updated documentation to include references to v3 services #4763
[docs] updated documentation to include references to v3 services #4763
Conversation
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.
Thanks for taking this one on @zenmonkeykstop! Just a first round of comments based on visual review only.
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.
these docs look great, just a few comments inline
bcba152
to
ae189c6
Compare
59359d4
to
bdb328f
Compare
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.
LGTM. My only comment is that people who are not familiar with onion services (for example, a journalist trying to back up their Tails USB and encountering the term in the docs, or potentially an Admin taking over care of the instance from someone else) might not know what this means to them or if it matters. ("What's an onion service? How can I tell if mine is v2 or v3?"). The 'how can I tell' in v3_services
is fairly clear, but the document definitely goes quickly into advanced territory.
This note aside, I'd say really clear and looking good.
@rocodes thanks, adding a bit more explanatory text re onion services. |
bdb328f
to
0dcf7f9
Compare
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.
Went through a visual review of these docs, they look great. I left a couple of small comments inline, though shouldn't block merge.
Has anyone performed a functional review of the instructions as part of their review? Else, I will perform a functional review first thing tomorrow, but it nothing stands out based on this visual review.
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.
A few small changes requested.
Lemme know when it's good and I'll flatten this PR before merge. |
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.
Issues resolved. Approved.
Status
Ready for review
Description of Changes
Fixes #4632 .
Adds upgrade documentation for v3 onion services.
Updates installation and onboarding documentation to refer to v3 services
Updates development documentation to refer to v3 services.
Note: The documentation for the instance restore and workstation rebuild process has not been addressed in this PR, as it's unclear to me how they will work under v3. More investigation required. Notes have been added to those docs temporarily, to let admins know that they're not applicable to instances running v3 services.
Testing
Docs-only PR:
Checklist
If you made non-trivial code changes:
If you made changes to documentation:
make docs-lint
) passed locally