Join Our Second Documentation Hackathon March 22-30
by ggus | March 17, 2020
Documentation is extremely valuable to the health of open source software projects, but it is often overlooked. We are a small team at Tor, and as a nonprofit organization with a big mission, we rely on volunteer contributions around the world to keep up with an ever-changing internet freedom landscape with the appropriate tools to navigate it. Keeping Tor's documentation up-to-date, organized, and accessible is a way to potentially help millions of people access a private, secure, and uncensored internet by using our tools.
Between 22 and 30 March, the Tor Project will host the second edition of our user documentation hackathon, the DocsHackathon. The DocsHackathon is a totally remote and online event.
If you've never volunteered with us before, this is an opportunity for you to become involved in the community, get closer to our work, and make meaningful contributions. During our first DocsHackathon last September, we had 70 registrations, 8 contributors, and over 70 pull requests to the support portal, Tor Browser manual, our main website, and other repositories. If you helped out last year, we hope you can join us again or help spread the word. Once the DocsHackathon is completed, we'll reward the top 3 contributors with official Tor swag.
So if you're a copywriter, front-end dev, tester, or content reviewer, we'd appreciate your help improving our documentation, updating our support portal, and ensuring their relevancy. Don't feel like any of these apply to you but still want to help out? Chat with us on IRC (#tor-www - irc.oftc.net) or the community team mailing list to join us and find out where you could add value.
To participate in the DocsHackathon:
- Register to get access to create and comment on issues in our Gitlab.
- Join the Community Team mailing list.
- Take a look at all of the tickets marked with the "DocsHackathon" keyword on Trac and Gitlab.
- If you have a documentation issue that is not currently reflected in Trac, create it, tag it, and let one of us know on IRC channel #tor-www.
- Choose a ticket and start working on it! You can submit Pull Requests on our GitHub or from your own git instance.
- This isn't a requirement, but: If you talk about the the hackathon on social media, we're using #DocsHackathon.
A contribution will be counted when your PR or merge request is merged to the master branch of the relevant repository. The awards to contributors will be announced after all the merges are done.
For more details on how you can contribute, check out our DocsHackathon wiki.
We are a small nonprofit with a big mission, and we sincerely appreciate your help getting our documentation up to speed. We look forward to working with you soon.