readme: improvements to documentation, add gif of diagrams #37
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
conorsch
approved these changes
May 2, 2019
There was a problem hiding this comment.
What a GIF 😍 No question that these changes clarify the at-present-very-complicated workflow surrounding the package build process, so happy to merge!
You mention that the README makes the bold claim:
The README you are currently reading is the canonical reference for SecureDrop Workstation packagers.
It's worth considering that we merge the out-of-band packaging RTD docs into this repository. It'd take work to reconcile the two approaches to explaining, but may help to tie functional changes to docs updates where and when appropriate.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
The README currently states on
master: "The README you are currently reading is the canonical reference for SecureDrop Workstation packagers." - if the README is too terse (which I think it is given the complicated workflow) that people cannot easily understand what is happening - both at a high-level and operationally - then this README needs updating (or the process needs simplifying).I've added a gif that contains diagrams/explanation of one of the parts that is most confusing: namely what release managers versus people doing dependency updates are responsible for. See branch rendered here: https://github.com/freedomofpress/securedrop-debian-packaging/blob/readme-updates/README.md