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.

Sign up for GitHub

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

Jump to bottom

Add upgrade documentation for 1.4.1->1.5.0 #5414

Merged
merged 2 commits into from
Jul 28, 2020
Merged

Add upgrade documentation for 1.4.1->1.5.0 #5414

merged 2 commits into from
Jul 28, 2020

Conversation

rocodes
Copy link
Contributor

@rocodes rocodes commented Jul 27, 2020

  • Split Tails 4 upgrade docs into separate file to reference without referring to old upgrade documentation.
  • Update references to Tails 4 docs in past version upgrade guides (text does not change).

Status

Ready for Review

Description of Changes

  • Add upgrade documentation for 1.4.1->1.5.0
  • Split out Tails 3-> Tails 4 migration docs so that we can refer to the migration process without linking to text embedded in an old upgrade guide. (Note that the actual text/content of old upgrade guides will not be altered as a result of this PR.)

Testing

Manual review

Deployment

n/a

Checklist

If you made changes to documentation:

  • Doc linting (make docs-lint) passed locally

@rocodes
Copy link
Contributor Author

rocodes commented Jul 27, 2020 •
edited
Loading

@eloquence: Have split out the Tails 3-> Tails 4 migration documentation as we discussed. The downside however is that it is also included in the Topic Guide, which may be redundant.
Some possibilities for getting around this without annoying Sphinx are: add it to the "excludes" directive, or maybe put it in a subfolder of a greater depth than 2 (so that the toctree with maxDepth 2 for the upgrade documentation doesn't complain about files that are not in the index). Both of these seemed kind of hacky so I left it as is but welcome suggestions.

@rocodes rocodes marked this pull request as draft July 27, 2020 20:41
@rocodes
- Add upgrade documentation for 1.4.1->1.5.0.
e0d3b08 
- Split Tails 4 upgrade docs into separate file to reference without referring to old upgrade documentation.
- Update references to Tails 4 docs in past version upgrade guides (text does not change).
@rocodes rocodes force-pushed the upgrade_docs_1_5_0 branch from 55cfa63 to e0d3b08 Compare July 27, 2020 20:47
@rocodes rocodes marked this pull request as ready for review July 27, 2020 20:49
@eloquence eloquence self-assigned this Jul 27, 2020
eloquence
eloquence reviewed Jul 27, 2020
View reviewed changes
docs/upgrade_to_tails_4.rst Outdated
Before upgrading your *Admin Workstation* and your *Journalist Workstation*
to Tails 4, you must first ensure that the version of the SecureDrop code on
the workstation (which is used for administrative tasks and for configuring
the Tails desktop) is at 1.1.0 or a later version.
Copy link
Member

Choose a reason for hiding this comment

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

This would be a good opportunity to switch to |version| for all references to 1.1.0 in this chapter, and to instruct admins to simply ensure that they're using the latest version. (1.1.0 is most likely fine, but there's no particular reason to keep carrying forward a reference to such an old release for this upgrade procedure.)

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Of course! fixed in 60130e3

eloquence
eloquence reviewed Jul 27, 2020
View reviewed changes
docs/upgrade/1.0.0_to_1.1.0.rst Outdated
@@ -60,109 +60,8 @@ Finally, run the following commands: ::
./securedrop-admin setup
./securedrop-admin tailsconfig

.. _upgrade_to_tails_4:
.. include:: ../upgrade_to_tails_4.rst
Copy link
Member

Choose a reason for hiding this comment

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

The only reason we've kept this 1.0.0->1.1.0 upgrade guide around is that it includes the Tails 4 docs. Now that you've nicely split it off, we can do some pruning. I think you can safely prune all upgrade docs up to (not including) 1.3.0->1.4.0 as part of this PR.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Removed in 60130e3

@eloquence
Copy link
Member

This LGTM, suggested two small maintenance tweaks as part of this PR. I think it's fine that the Tails 4 guide appears in the messy "Topic Guides" section of the ToC; it's reasonable to have it included, and we're not going to keep it around for much longer, anyway.

@rocodes
Copy link
Contributor Author

rocodes commented Jul 28, 2020

Changes made as described above, and a couple slight wording tweaks for clarity.

@eloquence
Copy link
Member

(Kicking CI, re-reviewing)

@eloquence
Copy link
Member

Changes LGTM, one minor nit that can be cleaned up later, as well. Only two very distinct commits so no need to squash IMO.

zenmonkeykstop
zenmonkeykstop approved these changes Jul 28, 2020
View reviewed changes
Copy link
Contributor

@zenmonkeykstop zenmonkeykstop left a comment

Choose a reason for hiding this comment

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

LGTM based on Erik's feedback and visual review

@zenmonkeykstop zenmonkeykstop merged commit c338ef3 into freedomofpress:develop Jul 28, 2020
@emkll emkll mentioned this pull request Jul 28, 2020
Merged
1 task
@rmol rmol mentioned this pull request Jul 28, 2020
Closed
2 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@eloquence eloquence eloquence left review comments

@zenmonkeykstop zenmonkeykstop zenmonkeykstop approved these changes

@emkll emkll Awaiting requested review from emkll

@kushaldas kushaldas Awaiting requested review from kushaldas

@redshiftzero redshiftzero Awaiting requested review from redshiftzero

Assignees

@eloquence eloquence

Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@rocodes @eloquence @zenmonkeykstop