The page is about writing or updating the source 'text' of the CloudStack documentation. If you are interested in publish (updating) the public visible rendering of the source, please see the Publishing Documentation Via Read The Docs guide.

Resources

Please see here for an overview of the resources that you may need to use to create or update documentation.

...

https://github.com/apache/cloudstack-docs-rn.git is the release notes for individual releases

What and Why Documentation

The CloudStack community is great at adding new features to CloudStack that make it more useable and flexible with every release.  However, it is almost just as important to inform the users of cloudstack that these features exist and how to use them.  Especially when features have been changed to include new functionality or cause changes the previous way of working.

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  step-by-step instructions explaining  what a feature does and how to use it.

Writing Documentation Basics

...

1. Clone the documentation repo that you wish to update
2. Update (or add) the section that you're working on.
3. Double check the .rst using a proofing tool (see resources) to ensure that it looks as you'd expect.
4. Commit your changes locally
5. Create a PR against the repo that you've updated
6. Ping people to get their attention to get it merged.
7. (Possibly ping people again if required)

...