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.

Authoring Environment¶

All of the Arvados documentation is being written in Textile (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 Documentation¶

To contribute to the documentation you should work with do documentation files in the same way that you would work with source code in GIT. (See more information about Contributing to the Project.) At this stage we are not maintaining a separate documentation mailing list so we encourage people who want to contribute to the documentation to join the main developer mailing list.