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

Update contributing.rst #4997

Open
wants to merge 1 commit into
base: develop
from
Open

Conversation

@ninavizz
Copy link
Member

ninavizz commented Nov 16, 2019

Change goals:

Make contrib guidelines more inclusive to any ux practitioners (vs simply 'designers'), to distinguish technical writers from UI copywriters, and UX research moderators from forum Moderators.

Details

  • Changed "Designers" to "UX Contributors"
  • Added a sentence to speak specifically to non-technical skillsets and the UX Repo as a go-to link
  • Added a blurb to alert copywriters that there are UI Copywriting needs spoken to in the UX Repo
  • Added "Forum" ahead of "Moderators" an support section, to distinguish from research moderators

Status

Ready for review / Work in progress

Description of Changes

Fixes #.

Changes proposed in this pull request:

Testing

How should the reviewer test this PR?
Write out any special testing steps here.

Deployment

Any special considerations for deployment? Consider both:

  1. Upgrading existing production instances.
  2. New installs.

Checklist

If you made changes to the server application code:

  • Linting (make lint) and tests (make test) pass in the development container

If you made changes to securedrop-admin:

  • Linting and tests (make -C admin test) pass in the admin development container

If you made changes to the system configuration:

If you made non-trivial code changes:

  • I have written a test plan and validated it for this PR

If you made changes to documentation:

  • Doc linting (make docs-lint) passed locally

If you added or updated a code dependency:

Choose one of the following:

  • I have performed a diff review and pasted the contents to the packaging wiki
  • I would like someone else to do the diff review
- Changed "Designers" to "UX Contributors"
- Added a sentence to speak specifically to non-technical skillsets and the UX Repo as a go-to link
- Added a blurb to alert copywriters that there are UI Copywriting needs spoken to in the UX Repo
- Added "Forum" ahead of "Moderators" an support section, to distinguish from research moderators
@@ -75,18 +75,20 @@ If you would like to contribute on a regular basis, you'll want to read the
development environment to preview changes, run tests locally, etc.


Writers
Technical Writers
~~~~~~~

This comment has been minimized.

Copy link
@eloquence

eloquence Nov 16, 2019

Contributor

Restructured Text (the format the docs are written in) is finicky about the way you declare headlines. The text underneath the headline (the ~~~~~~~ above) has to be the same length as the headline itself.

@@ -144,17 +146,19 @@ forum discussions are also welcome.
:alt: SecureDrop language status


Designers
UX Contributors
~~~~~~~~~

This comment has been minimized.

Copy link
@eloquence

eloquence Nov 16, 2019

Contributor

Same issue here with the headline formatting.



Moderators and Support
Forum Moderators and Support
~~~~~~~~~~~~~~~~~~~~~~

This comment has been minimized.

Copy link
@eloquence

eloquence Nov 16, 2019

Contributor

Same issue here with the headline formatting.


If this is your first time helping with SecureDrop documentation, consider
working on `low-hanging fruit`_ to become familiar with the process.

.. _`low-hanging fruit`: https://github.com/freedomofpress/securedrop/issues?q=is%3Aopen+label%3A%22good+first+issue%22+label%3Adocs

If you're looking to contribute to copywriting user-facing text within the UI itself, see _`these issues <https://github.com/freedomofpress/securedrop-ux/labels/NeedsCopywriting>`__ in `our separate User Experience repo <https://github.com/freedomofpress/securedrop-ux/>`__.

This comment has been minimized.

Copy link
@eloquence

eloquence Nov 16, 2019

Contributor

There should be no _ at the beginning of

_`these issues <https://github.com/freedomofpress/securedrop-ux/labels/NeedsCopywriting>`__
~~~~~~~

Technical writers and editors are invited to review the `documentation
<https://docs.securedrop.org/>`__ and fix any mistakes in accordance with the
:doc:`documentation guidelines <documentation_guidelines>`.

This comment has been minimized.

Copy link
@eloquence

eloquence Nov 16, 2019

Contributor

The :doc: here is important for the link to work and should not be removed, and no __ should be added at the end.

~~~~~~~~~

If you have web design or user experience design skills, take a look at these issues on GitHub:
If you have interaction or visual design skills, copywriting for UI skills, or have user research skills, check out `our separate User Experience repo <https://github.com/freedomofpress/securedrop-ux/>`__ for SecureDrop here on GitHub. There is a wiki with notes from weekly meetings, design standards, design principles, links-out to past research synthesis efforts, and ongoing and past project efforts documented as Issues, there.

This comment has been minimized.

Copy link
@eloquence

eloquence Nov 16, 2019

Contributor

Issues -> issues

@eloquence

This comment has been minimized.

Copy link
Contributor

eloquence commented Nov 16, 2019

Thanks for working on this @ninavizz and congrats on the PR! Looks pretty good to me, mainly formatting issues -- this is why there is a red "X" need to "ci/circleci: lint" in this box:

Screenshot from 2019-11-15 16-28-14

It means that the linter (which checks for formatting validity) is not happy. Once we got the formatting fixed, I think we're pretty close to merging this in. :)

Pro tip: Once you're more comfortable with branches in GitHub, it's best to name documentation branches something starting with docs-. (That's a specific thing for SecureDrop, not all GitHub projects work that way.) This tells our automated testing system to not run a bunch of tests on it that take a long time and don't have anything to do with the documentation.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
2 participants
You can’t perform that action at this time.