Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

The following products are used in the maintenance of the documentation:

Source Git Repository

The documentation sources are held in git.

...

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

https://readthedocs.org

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

...