Project

General

Profile

Edit History

Wiki ยป

Documentation project » History » Version 27

Tom Clegg, 03/04/2014 01:45 PM

1 1 Anonymous 
h1. Documentation
2 





    3
    5
    Ward Vandewege
    
The documentation project is a part of the overall Arvados effort. 





    4
    1
    Anonymous
    





    5
    
    
    
h2. Guides





    6
    
    
    





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





    8
    1
    Anonymous
    





    9
    16
    Anonymous
    
* "User Guide":http://doc.arvados.org/user/ - Introductory and tutorial materials for building analysis or web applications using Arvados. 





    10
    1
    Anonymous
    





    11
    15
    Anonymous
    
* "API Reference":http://doc.arvados.org/api/ - REST API methods and resources, the MapReduce job execution environment, permission model, etc.





    12
    1
    Anonymous
    





    13
    14
    Anonymous
    
* "Admin Guide":http://doc.arvados.org/admin/ - Instructions to system administrators for maintaining an Arvados installation.





    14
    12
    Anonymous
    





    15
    1
    Anonymous
    
* "Install Guide":http://doc.arvados.org/install/ - How to install and configure Arvados on the cloud management platform of your choice. 





    16
    15
    Anonymous
    





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





    18
    1
    Anonymous
    





    19
    6
    Tom Clegg
    
h2. Documentation Project





    20
    1
    Anonymous
    





    21
    7
    Tom Clegg
    
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.





    22
    1
    Anonymous
    





    23
    7
    Tom Clegg
    
h2. Contributing





    24
    1
    Anonymous
    





    25
    7
    Tom Clegg
    
Bugs in the documentation can be submitted as "issues":/projects/arvados/issues.





    26
    6
    Tom Clegg
    





    27
    12
    Anonymous
    
To contribute to the documentation, clone the Arvados source repository, edit, and send pull requests just as you would when contributing program source code.





    28
    6
    Tom Clegg
    





    29
    
    
    
We do not yet maintain a separate documentation mailing list, so we encourage documentation contributors to join the main developer mailing list.





    30
    
    
    





    31
    
    
    
References for contributors:





    32
    
    
    





    33
    
    
    
* "Markdown syntax":http://daringfireball.net/projects/markdown/syntax





    34
    25
    Peter Amstutz
    
* "Textile syntax":http://redcloth.org/textile





    35
    
    
    
* "Zenweb":http://www.zenspider.com/projects/zenweb.html





    36
    6
    Tom Clegg
    
* "Liquid for designers":https://github.com/shopify/liquid/wiki/liquid-for-designers (template engine)





    37
    11
    Tom Clegg
    





    38
    
    
    
Contributor quick-start:





    39
    1
    Anonymous
    





    40
    26
    Peter Amstutz
    
<pre><code>git clone git://github.com/curoverse/arvados.git





    41
    11
    Tom Clegg
    
cd arvados/doc





    42
    25
    Peter Amstutz
    
bundle install





    43
    
    
    
rake





    44
    
    
    
# documentation will be generated in .site/





    45
    
    
    
</code></pre>





    46
    27
    Tom Clegg
    





    47
    
    
    
To generate Python SDK docs, install @epydoc@ and @arvados-python-client@ before running @rake@ in @arvados/doc@:





    48
    
    
    





    49
    
    
    
<pre><code>sudo apt-get install python-pip python-virtualenv





    50
    
    
    
virtualenv /tmp/z





    51
    
    
    
PATH=/tmp/z/bin:$PATH





    52
    
    
    
pip install epydoc arvados-python-client





    53
    
    
    
rake





    54
    
    
    
</code></pre>