Documentation project » History » Version 4
Tom Clegg, 04/08/2013 12:03 PM
| 1 | 1 | Anonymous | h1. Documentation |
|---|---|---|---|
| 2 | |||
| 3 | The documentation project is a part of the overall Orvos effort. |
||
| 4 | |||
| 5 | h2. Guides |
||
| 6 | |||
| 7 | There are three guides that will be developed to support the use of Orvos: |
||
| 8 | |||
| 9 | 4 | Tom Clegg | * [[User Guide]] - All of the information for anyone developing analysis or web applications using Orvos. |
| 10 | 1 | Anonymous | |
| 11 | 4 | Tom Clegg | * [[Administration Guide]] - Instructions on how to administer and Orvos cluster for system administrators. |
| 12 | 1 | Anonymous | |
| 13 | 4 | Tom Clegg | * [[Installation Guide]] - How to install and configure Orvos to run in different cloud environments. |
| 14 | 1 | Anonymous | |
| 15 | h2. Authoring Environment |
||
| 16 | |||
| 17 | 3 | Anonymous | All of the Orvos 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. |
| 18 | 1 | Anonymous | |
| 19 | h2. Contributing Documentation |
||
| 20 | |||
| 21 | 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. |