Documentation project » History » Revision 27
Revision 26 (Peter Amstutz, 02/12/2014 02:56 PM) → Revision 27/42 (Tom Clegg, 03/04/2014 01:45 PM)
h1. Documentation The documentation project is a part of the overall Arvados effort. h2. Guides There are four guides that are being developed to support the use of Arvados: * "User Guide":http://doc.arvados.org/user/ - Introductory and tutorial materials for building analysis or web applications using Arvados. * "API Reference":http://doc.arvados.org/api/ - REST API methods and resources, the MapReduce job execution environment, permission model, etc. * "Admin Guide":http://doc.arvados.org/admin/ - Instructions to system administrators for maintaining an Arvados installation. * "Install Guide":http://doc.arvados.org/install/ - How to install and configure Arvados on the cloud management platform of your choice. A web version of the documentation is available at http://doc.arvados.org. h2. Documentation Project The Arvados documentation is written in Markdown, Textile, and HTML. The source code is in the @doc@ directory in the Arvados source tree. We use Jekyll to render HTML pages. h2. Contributing Bugs in the documentation can be submitted as "issues":/projects/arvados/issues. To contribute to the documentation, clone the Arvados source repository, edit, and send pull requests just as you would when contributing program source code. We do not yet maintain a separate documentation mailing list, so we encourage documentation contributors to join the main developer mailing list. References for contributors: * "Markdown syntax":http://daringfireball.net/projects/markdown/syntax * "Textile syntax":http://redcloth.org/textile * "Zenweb":http://www.zenspider.com/projects/zenweb.html * "Liquid for designers":https://github.com/shopify/liquid/wiki/liquid-for-designers (template engine) Contributor quick-start: <pre><code>git clone git://github.com/curoverse/arvados.git cd arvados/doc bundle install rake # documentation will be generated in .site/ </code></pre> To generate Python SDK docs, install @epydoc@ and @arvados-python-client@ before running @rake@ in @arvados/doc@: <pre><code>sudo apt-get install python-pip python-virtualenv virtualenv /tmp/z PATH=/tmp/z/bin:$PATH pip install epydoc arvados-python-client rake </code></pre>