Ship Your First (or Next) Open Source Docs PR
Hey fellow Writing Day people!
Want to leave Portland with a real contribution to a big name open-source project? Come work through pre-vetted documentation issues from projects that actually need the help. I’ve coordinated in advance with maintainers from Mautic, Vitess, and Helm (with more pending) to label “good first issue” docs tasks: information architecture, confusing instructions, fuzzy contributor guides, missing pages.
Bring a laptop, pick an issue, ship a PR.
| Project | Good First Docs Issues |
|---|---|
| Mautic | https://github.com/mautic/developer-documentation-new/issues?q=is%3Aissue+state%3Aopen+label%3A%22good+first+issue%22 |
| Vitess | https://github.com/vitessio/website/issues?q=is%3Aissue%20state%3Aopen%20label%3A%22help%20wanted%22%20label%3Adocumentation |
| Helm | https://github.com/helm/helm-www/issues?q=is%3Aissue+state%3Aopen+label%3A%22good+first+issue%22 |
| … | adding more as docs maintainers get back to me |
Mautic
Section titled “Mautic”I talked to Ayu Adiati on Slack. She has labeled a bunch of Good First Issue for us to work on.
The user docs so far is a bit behind with Ul screenshots. Most of them are still for version before 5.2. The most important docs to update is version 7.0 and 7.1 (they have the same UI), then 6.0 and 5.2 as some folks are still using these versions as well.
I was focusing in building the guidelines for contributing, so it takes me some time to update them myself bit by bit.
In my own experience, I sometimes found missing instructions or any other features that need to be added and updated while updating the screenshots.
Dev docs is the one that definitely need some love. Folks has been asking for clarity as the contents are outdated. […]
Vitess
Section titled “Vitess”There are 15 issues open looking for help, but when I talked with Matt Lord at Vitess, he mentioned
Honestly, stepping back would probably be more helpful.
What the website -> docs experience is like for a newcomer and how it could be improved.
Where to start, how to find things, etc. Organization more than content
So Vitess is looking for more Information Architecture recommendations and guidance. Open a new issue explaining what you find. They are happy to take PRs for anything, so happy hunting!
Helm has 6 open docs issues labeled as good first issues. One of them is from 2021, so maybe I’ll claim getting that one knocked out.