Documentation project » History » Revision 6
Revision 5 (Ward Vandewege, 04/08/2013 04:52 PM) → Revision 6/42 (Tom Clegg, 04/09/2013 01:15 PM)
h1. Documentation The documentation project is a part of the overall Arvados effort. h2. 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. h2. Documentation Project Authoring Environment The All of the Arvados documentation is being written in Markdown, Textile, and HTML. The source code is in the Arvados source tree. We use Jekyll to render HTML pages. 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. h2. Contributing Documentation To contribute to the documentation, clone documentation you should work with do documentation files in the Arvados source repository, edit, and send pull requests just as same way that you would when contributing program work with source code (see in GIT. (See more information about [[Contributing to the Project]]). We do Project]].) At this stage we are not yet maintain maintaining a separate documentation mailing list, list so we encourage people who want to contribute to the documentation contributors to join the main developer mailing list. References for contributors: * "Markdown syntax":http://daringfireball.net/projects/markdown/syntax * "Jekyll usage":https://github.com/mojombo/jekyll/wiki/Usage * "Liquid for designers":https://github.com/shopify/liquid/wiki/liquid-for-designers (template engine)