[docs] Standardize Submission Key language and usage #4413
Merged
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
This also revises the SVS description slightly (nowhere else do we explicitly instruct people to use the SVS for _generating_ journalist keys, and in this context it feels more confusing than helpful). It renames a file that used the old "application key" term. I chose to use the shorter "Submission Key" instead of "SecureDrop Submission Key" since other terms like *Journalist Workstation* are also SecureDrop-specific, and the convention to italicize such terms makes it reasonably clear that they carry a context-specific meaning. Resolves #2579 Resolves #4122
eloquence
requested review from
emkll,
kushaldas,
redshiftzero and
zenmonkeykstop
as code owners
|
If this looks good, I recommend we open a follow-up issue to similarly standardize references to the OSSEC keypair. One remaining inconsistency is that we refer to the Submission Key as the "journalist key" (in the |
Big fan of cleaning up here. 👌
Totally agree. |
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.
This also revises the SVS description slightly (nowhere else do we explicitly instruct people to use the SVS for generating journalist keys, and in this context it feels more confusing than helpful). It renames a file that used the old "application key" term.
I chose to use the shorter "Submission Key" instead of "SecureDrop Submission Key" since other terms like Journalist Workstation are also SecureDrop-specific, and the convention to italicize such terms makes it reasonably clear that they carry a context-specific meaning.
I've not disabled whitespace trimming for this PR as we should IMO generally avoid trailing whitespace, but note that this introduces some whitespace removal along the way.
Resolves #2579
Resolves #4122
Status
Ready for review
Checklist
make docs-lint) passed locally