Skip to content

What Should I Contribute?

Justin Pease edited this page Mar 25, 2015 · 2 revisions

You want to contribute, have completed the Getting Started guide, and have taken a look at the Anatomy of the Docs. Now what?! Here are some possibilities:

  1. Help fix existing docs. Changes can be large or small. We're happy to have even minor typos or grammar corrected. Could a topic be explained with greater clarity? Other than looking for issues to fix yourself, the two major sources of problems in need of solutions are GitHub issues and the Riak mailing list. We want to keep the number of open issues as close to zero as possible. By monitoring the mailing list you may find user issues that arise as a result of incomplete or otherwise deficient documentation. Don't be afraid to ask users to submit GitHub issues, as most are quite happy to.
  2. Writing new documentation for new features, expanding documentation for long-standing functionality that's not well covered, etc.

Other Ideas

  1. PDF generation --- This would be very nice to have.
  2. More visual materials --- There are a fair number of diagrams in the docs already, but we could use more. The distributed systems and other concepts in Riak are hard. Visual diagrams can make them easier.
  3. Better mobile experience --- At the moment, the Basho docs look pretty all right on mobile, but you can't change versions, meaning that only the latest version is available.
Clone this wiki locally