You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 2 Next »

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

reStructuredText

This is the authoring language that is used while write individual topics.

Sphinx

This is the document production toolkit. It is used to create documents that include the topics written in reStructuredText.

 

git Repository

The documentation sources are held in git.

https://github.com/apachecloudstack/consolidated-documentation.git is the new consolidated documentation

https://github.com/apache/cloudstack-docs-admin.git is the current admin manual.

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

 

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.

 

  • No labels