Project

General

Profile

Edit History

Wiki ยป

Documentation project » History » Version 8

Tom Clegg, 04/09/2013 01:24 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
    5
    Ward Vandewege
    
There are three guides that will be developed to support the use of Arvados: 





    8
    1
    Anonymous
    





    9
    5
    Ward Vandewege
    
* [[User Guide]] - All of the information for anyone developing analysis or web applications using Arvados. 





    10
    1
    Anonymous
    





    11
    5
    Ward Vandewege
    
* [[Administration Guide]] - Instructions on how to administer and Arvados cluster for system administrators. 





    12
    1
    Anonymous
    





    13
    5
    Ward Vandewege
    
* [[Installation Guide]] - How to install and configure Arvados to run in different cloud environments. 





    14
    1
    Anonymous
    





    15
    6
    Tom Clegg
    
h2. Documentation Project





    16
    1
    Anonymous
    





    17
    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.





    18
    1
    Anonymous
    





    19
    6
    Tom Clegg
    
h2. Contributing





    20
    7
    Tom Clegg
    





    21
    
    
    
Bugs in the documentation can be submitted as "issues":/projects/arvados/issues.





    22
    6
    Tom Clegg
    





    23
    
    
    
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]]).





    24
    
    
    





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





    26
    
    
    





    27
    
    
    
References for contributors:





    28
    
    
    





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





    30
    8
    Tom Clegg
    
* "Jekyll usage":https://github.com/mojombo/jekyll/wiki/Usage (Note: Jekyll 0.12.1 auto-refresh "bug":https://github.com/mojombo/jekyll/issues/882 and "workaround":http://stackoverflow.com/questions/15591000/jekylls-auto-doesnt-work for devs.)





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