Update contributing.rst #4997
Update contributing.rst #4997
Conversation
- 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
ninavizz
requested review from
emkll,
kushaldas,
redshiftzero and
zenmonkeykstop
as code owners
| @@ -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 | |||
| ~~~~~~~ | |||
There was a problem hiding this comment.
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 | |||
| ~~~~~~~~~ | |||
There was a problem hiding this comment.
Same issue here with the headline formatting.
|
|
||
|
|
||
| Moderators and Support | ||
| Forum Moderators and Support | ||
| ~~~~~~~~~~~~~~~~~~~~~~ |
There was a problem hiding this comment.
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/>`__. |
There was a problem hiding this comment.
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>`. |
There was a problem hiding this comment.
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. |
|
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:
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 |
|
Hi @ninavizz, this PR from last year will require some follow-up work from you to get over the finish line. Fortunately the file hasn't been changed since you worked on it, so it should just be a matter of addressing the comments above. Do you still want to take a stab at this? |
|
Picked this up via #5350. |
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
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:
Checklist
If you made changes to the server application code:
make lint) and tests (make test) pass in the development containerIf you made changes to
securedrop-admin:make -C admin test) pass in the admin development containerIf you made changes to the system configuration:
If you made non-trivial code changes:
If you made changes to documentation:
make docs-lint) passed locallyIf you added or updated a code dependency:
Choose one of the following: