The following products are used in the maintenance of the documentation:
Source Git Repository
The documentation sources are held in git.
https://github.com/apache/cloudstack-docs-install.git is the install guide
https://github.com/apache/cloudstack-docs-admin.git is the current admin manual.
https://github.com/apache/cloudstack-docs-rn.git is the release notes for individual releases
A plan to consolidate the install and admin guides has been created but not worked on.
https://github.com/apachecloudstack/consolidated-documentation.git is the new consolidated documentation
Read The Docs
The CloudStack documentation is built with the ReadTheDocs service. Access is not strictly required in order to write/update the source documentation. Only to build the documentation for a new version.
If you would like access, please contact the dev list.
reStructuredText
This is the authoring language that is used while write individual topics.
Rest Editor for Eclipse
This is the plug-in that supports the maintenance and production of documents in Eclipse.
It is called Rest Editor and the group name is org.psem2m.eclipse.rest.editor.feature.group
It can be downloaded from the Eclipse Marketplace as the Rest Editor 1.0.5
Online RST Editors/Viewers
http://rst.ninjs.org/ - Helpful to have a semi-WYSIWYG experience. The 'Nature' theme most closely resembles the theme used in the CloudStack documentation
Open Office for drawing creation
The drawings for the new documentation are created using Open Office Draw.
The sources are now kept with the text in the git repo under source/_static/image_sources.
The sources for the drawings in the previous manual are lost.
VRT Network drawing extensions
VRT network drawing extension for Open Office are used to create the drawings. This may be downoaded and added to OpenOffice as an extension. The symbols will appear in Draw's Gallery.
There is an explanation about how to use them on Artifact Software's technical blog.
Logos
There are a number of resources related to trademarks and other graphics.
The guidelines for using the Cloudstack trademark can be found here.
Resources for preparing marketing materials and presentations can be found here.
The logo can be found at Apache CloudStack Logo with Cloud Monkey
Overview
Content Tools
Apps