Project

General

Profile

Actions

Documentation project » History » Revision 23

« Previous | Revision 23/42 (diff) | Next »
Ward Vandewege, 12/18/2013 09:16 AM


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 building analysis or web applications using Arvados.
  • API Reference - 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.

A web version of the documentation is available at http://doc.arvados.org.

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:

Contributor quick-start:

gem install jekyll RedCloth
git clone git://github.com/curoverse.com/arvados.git
cd arvados/doc
jekyll serve --watch

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

vi api/index.md

Updated by Ward Vandewege over 10 years ago · 23 revisions