Versions Compared

Key

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

...

When writing documentation, one must put oneself in the shoes of the user is trying to use CloudStack to achieve an objective or is exploring cloudstack to understand what it does and how it does it.  Many users will not have the wider background of either the developer or the document writer, and therefore will need clear and concise  concise step-by-step instructions explaining  what a feature does and how to use it.

Read The Docs

rather than an instruction, read the docs is a service which publishes versioned documentation.  It is linked to the cloudstack Github documentation repositories, and will build the documentation in the form seen at 'http://docs.cloudstack.apache.org/projects/cloudstack-administration/en/latest/' from the source 'text' which we commit to Github.  Read the docs applies a theme to the source text, as well as generating navigation menus for viewers of the site.

reStructuredText

The authoring language that is used in the ACS CloudStack Documentation is reStructuredText (RST), the resources page has some links to help you getting started writing in that format.  

Writing Documentation Basics

...