Not only does the ThinkUp community want to create a great software platform, we want to make it accessible to everyone with clear and thorough documentation. You’re reading the very beginning of that effort, but we’ve got a lot of work to do.

If you’re a ThinkUp user and know how to write clear descriptions and tutorials on technical topics, we need your help.

How to Contribute Documentation

We write documentation in plain text files using a format called reStructuredText (RST). We store those source files in ThinkUp source code repository’s docs folder. Then, the HTML pages you are reading right now are generated by a tool called Sphinx. To see what the RST source of this page looks like, navigate to the file hosted on GitHub and click on the “Raw” button at the top of the file.

To contribute new documentation, fork ThinkUp’s source code and issue a pull request for your changes.

Alternately, edit an existing page without leaving your browser using GitHub’s new “Fork and edit this file” feature.

See also

The reStructuredText primer is a good reference while you write rST. Also, this reStructuredText online editor lets you preview your work live on the web.

If you’re not comfortable using Git but want to contribute documentation, author your pages in ThinkUp’s Community Wiki and then email them to the ThinkUp community mailing list for review and inclusion in this documentation.

We want to make contributing documentation as easy as possible. Get in touch with your ideas.