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.

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: proofread glossary.rst for typos and style problems #3012

Closed
ghost opened this issue Feb 14, 2018 · 6 comments
Closed

docs: proofread glossary.rst for typos and style problems #3012

ghost opened this issue Feb 14, 2018 · 6 comments

Comments

@ghost
Copy link

ghost commented Feb 14, 2018

Description

Read https://github.com/freedomofpress/securedrop/blob/develop/docs/glossary.rst and look for:

Rewording for clarity or adding content is not in the scope of this issue. When a typo or style problem is found, open a pull request fixing it and make sure to reference this issue so it is closed.

If no typo or style problem is found, add a comment to this issue. It will be closed after a few person report they did not find an issue.

@jroes
Copy link
Contributor

jroes commented May 16, 2019

Looks like terminology.rst doesn't exist on the develop branch anymore. Is it now in master? https://github.com/freedomofpress/securedrop/blob/master/docs/terminology.rst

@eloquence
Copy link
Member

eloquence commented May 16, 2019

@jroes
Copy link
Contributor

jroes commented May 16, 2019

Looks good to me, no typos! I also ran a grammar-checking tool against it as well with no errors.

@eloquence
Copy link
Member

eloquence commented May 16, 2019

Thanks, @jroes! Leaving this issue open to allow for a second pass by another volunteer; much appreciate the review :). Also updated the link to the new filename.

@eloquence eloquence changed the title docs: proofread terminology.rst for typos and style problems docs: proofread glossary.rst for typos and style problems May 16, 2019
@DrGFreeman
Copy link
Contributor

Hello, I proofread the glossary and found no typos or violations of the documentation guidelines.

In the process, I reviewed the SecureDrop workflow diagram linked at the top of the glossary for consistency of terms and found two issues in the diagram:

  1. The diagram uses Document Interface whereas the glossary uses "Journalist Interface" (with mention of the change.
  2. The term "Journalist workstation" should be capitalized ("Journalist Workstation") in the diagram.

These two issues appear to be addressed by 948039b, ref. #4670.

@eloquence
Copy link
Member

Closing; we'll highlight opportunities to proofread the docs at a higher level instead of having individual issues for proofreading sections.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

3 participants