Documentation¶

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

Guides¶

There are three guides that will be developed to support the use of Arvados:

• User Guide - All of the information for anyone developing analysis or web applications using Arvados.

• Administration Guide - Instructions on how to administer and Arvados cluster for system administrators.

• Installation Guide - How to install and configure Arvados to run in different cloud environments.

Documentation Project¶

The Arvados documentation is written in Markdown, Textile, and HTML. The source code is in the Arvados source tree. We use Jekyll to render HTML pages.

(the same language used for this wiki). The files are stored and organized in a directory with in the Repository with sub-directories for each of the guides. As part of the project there is a pipeline for generating the documentation based on Jekyll. Bugs in the documentation can be submitted to as Issues.

Contributing¶

To contribute to the documentation, clone the Arvados source repository, edit, and send pull requests just as you would when contributing program source code (see Contributing to the Project).

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
• Jekyll usage
• Liquid for designers (template engine)