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

Full copyedit & updates pass #17

Merged
merged 1 commit into from
Mar 19, 2020
Merged

Full copyedit & updates pass #17

merged 1 commit into from
Mar 19, 2020

Conversation

eloquence
Copy link
Member

@eloquence eloquence commented Mar 5, 2020

  • flesh out security FAQ
  • updater now runs on login
  • single click, not double click on files
  • "Awaiting key" message and behavior updated per recent findings
    and changes
  • updater slowness a known issue
  • misc. other edits

docs/admin/known_issues.rst Outdated Show resolved Hide resolved
docs/index.rst Outdated Show resolved Hide resolved
at this time we request that you leave the workstation configured the way it was
provisioned, and hold off on installing additional software or changing the
functionality or configuration of any of the VMs. If you have specific needs
that you would like to discuss with us, pelase open an issue `in our support portal`_
Copy link
Contributor

Choose a reason for hiding this comment

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

please

Copy link
Member Author

Choose a reason for hiding this comment

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

haha, good catch

Copy link
Member

Choose a reason for hiding this comment

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

Request using a simpler word than "provision" in all journalist-facing content.

Copy link
Member Author

Choose a reason for hiding this comment

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

in this instance, changed to "change the configuration of the workstation or install additional software on it"

conversation view. You may send it, or leave it in the box without sending to
save it as a draft.
conversation view. Click the paper airplane icon or press "Ctrl+Enter" to send
a reply. Any replies you did not send will be discarded when you exit the
Copy link
Contributor

Choose a reason for hiding this comment

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

Maybe: "Any unsent replies"

Copy link
Member Author

Choose a reason for hiding this comment

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

This is where it gets a bit tricky. If the user submitted a reply but it failed to send, it will not be discarded -- the failed message will still be visible on the next client start. That's why I went with "you did not send", but let me know if you have other ideas in this regard.

docs/journalist/submissions.rst Outdated Show resolved Hide resolved
@eloquence
Copy link
Member Author

eloquence commented Mar 13, 2020

Thanks @pierwill and @ninavizz for the first look, this is ready for another pass or another pair of eyes :)

@eloquence eloquence force-pushed the copyedit-and-misc-updates branch from 7ac31d8 to 014141a Compare March 13, 2020 21:19
@rocodes rocodes self-assigned this Mar 16, 2020
Copy link
Contributor

@rocodes rocodes left a comment

Choose a reason for hiding this comment

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

LGTM - just one small nit regarding consistency of docs url.


.. _`flag sources for reply`: https://docs.securedrop.org/en/release-1.2.0/journalist.html#flag-for-reply
.. _`flag the source for reply`: https://docs.securedrop.org/en/release-1.2.1/journalist.html#flag-for-reply
Copy link
Contributor

Choose a reason for hiding this comment

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

should this point to https://docs.securedrop.org/en/latest/journalist.html#flag-for-reply to avoid being bitten by the docs version thing?

Copy link
Member Author

Choose a reason for hiding this comment

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

Good catch! latest references the develop branch which I try to avoid if possible, because it's documentation for an unreleased version (it may reference functionality or behavior that are different than what the user sees in their production install, and this is a good case in point -- the "flag for reply" feature will be removed in develop before that removal lands in users' installs).

I tend to prefer stable which reflects the state of the latest release tag (not branch) - but nothing after it, for better and for worse. Hopefully we'll be able to have a better option soon by having docs build from master and always referencing that; see discussion in freedomofpress/securedrop#5081

If you are logged into the SecureDrop Client, and the reply feature for a
source is disabled for more than a minute, they must be flagged for reply in
the *Journalist Interface* - see the `SecureDrop "Flag for Reply"
documentation <https://docs.securedrop.org/en/stable/journalist.html#flag-for-reply>`_ for more information.
Copy link
Contributor

Choose a reason for hiding this comment

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

Copy link
Member Author

Choose a reason for hiding this comment

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

Using stable for both URLs now.

rocodes
rocodes previously approved these changes Mar 18, 2020
Copy link
Contributor

@rocodes rocodes left a comment

Choose a reason for hiding this comment

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

All LGTM!

@eloquence eloquence closed this Mar 19, 2020
@eloquence eloquence force-pushed the copyedit-and-misc-updates branch from 5c83179 to cc9db5f Compare March 19, 2020 16:43
- updater now runs on login
- single click, not double click on files
- "Awaiting key" message and behavior updated per recent findings
  and changes
- updater slowness a known issue
- Flesh out FAQ
- Address review comments
@rocodes rocodes merged commit 1c06030 into master Mar 19, 2020
@rocodes rocodes deleted the copyedit-and-misc-updates branch March 19, 2020 17:04
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants