Recommend workstation backup as step in the install guide #4302
Conversation
There was a problem hiding this comment.
Hi @cji, thanks for putting this together! (The root cause of the CI failure has been resolved.)
This wasn't stated in the issue you're resolving (my bad!), but I think we should recommend backing up all Tails drives after the installation: the Admin Workstation, the Journalist Workstation, and the SVS. The backup doc covers all three, as well.
The Admin Workstation setup chapter may also not be the best time to mention an Admin Workstation backup, as there's still a post-install step the admin has to perform, see https://docs.securedrop.org/en/release-0.12.1/configure_admin_workstation_post_install.html
I think that post-install chapter may be the best one to add the backup section to. I think it's okay to lengthen the chapter title a bit beyond the pain threshold to make that work ("Configure the Admin Workstation Post-Install and Create Backups"). What do you think?
|
Thanks for the clarification @eloquence! That totally makes sense. I'll re-work this PR to address those changes. |
|
looks like some additional unrelated CI failures? At least, I don't think this PR should affect grsec kernel things 😅 |
Aye! Caused by #4308, specifically. FYI, it's possible to skip the full CI run if you prefix your branch name with No need to resubmit, just mentioning it in case it saves you time on a future contribution. 🙂 We'll kick CI to get the updated logic running for you, hopefully getting to green across the board. |
|
@conorsch oh cool! I will keep that in mind for next time. Thank you! |
| Back Up The Workstations | ||
| ------------------------------------ | ||
|
|
||
| USB drives can wear out, get lost, or otherwise become corrupted, making it very important to be sure to keep current backups. Follow the :ref:`Backup the Workstations <backup_workstations>` document to create a backup of your Secure Viewing Station, Admin Workstation, and Journalist Workstations after you've completed the installation and post-installation steps. |
There was a problem hiding this comment.
Nit: We italicize SecureDrop-specific terminology (see https://docs.securedrop.org/en/release-0.12.1/development/documentation_guidelines.html and https://docs.securedrop.org/en/release-0.12.1/terminology.html ).
| @@ -63,3 +63,8 @@ of the authenticated hidden services, restart Tails and make | |||
| sure to enable persistence. | |||
|
|
|||
| .. _Authenticated Tor Hidden Services: https://www.torproject.org/docs/tor-manual.html.en#HiddenServiceAuthorizeClient | |||
|
|
|||
| Back Up The Workstations | |||
There was a problem hiding this comment.
Nit: The -> the (title case per https://docs.securedrop.org/en/release-0.12.1/development/documentation_guidelines.html although we're admittedly not super-consistent about this).
|
LGTM, couple of nits noted inline if you have time, if not, we can fix in follow-up. :) |
|
@eloquence Thanks for the review (and for pointing out the style doc, I embarrassingly missed it 😅). I think I addressed your latest comments. Please let me know if I missed anything! |
|
Lovely. Thank you for the contribution, and for your patience while we got it in, @cji! |
|
@conorsch no problem, my pleasure! Thanks for all the feedback! |
Status
Ready for review
Description of Changes
Fixes #4265.
Changes proposed in this pull request: recommend workstation backup as step in the install guide
Testing
Check for grammar, placement of instructions in the guide.
Deployment
Any special considerations for deployment? No.
Checklist
If you made changes to documentation:
make docs-lint) passed locally