Documentation¶

The documentation project is a part of the overall Arvados effort.

Guides¶

There are four guides that are being developed to support the use of Arvados:

• User Guide - Introductory and tutorial materials for developers building analysis or web applications using Arvados.

• API Reference - Details of REST API methods and resources, the MapReduce job execution environment, permission model, etc.

• Admin Guide - Instructions to system administrators for maintaining an Arvados installation.

• Install Guide - How to install and configure Arvados on the cloud management platform of your choice.

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.

Contributing¶

Bugs in the documentation can be submitted as 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
• Textile syntax
• Jekyll usage (Note: Jekyll 0.12.1 auto-refresh bug and workaround for devs.)
• Liquid for designers (template engine)

Contributor quick-start:

git clone git://github.com/clinicalfuture.com/arvados.git
cd arvados/doc
jekyll --server --auto

# point browser to http://localhost:4000/doc/

vi api/index.md