...
- Clone the documentation repo
- Switch to the correct branch (master for a future version)
- Update (or add) the section that you're working on.
- Double check the .rst reStructured Text using a proofing tool (see resources) to ensure that it looks as you'd expect.
- Commit your changes locally
- Create a PR against the repo that you've updatedfrom your repo to the ACS documentation repo
- Ping people to get their attention to get it merged.
- (Possibly ping people again if required)
- Remember to merge to master AND the release branch if you've documented something in a release branch that will also be applicable to new versions of CloudStack as well.
...
.. _this-is-link-to-a-heading <-- marker
:ref;:`this-is-link-to-a-heading` <-- reference to marker
If you are linking to a 'bookmark' that does not precede a header you have to add a caption of your own:
.. _this-is-link-to-a-bookmark <-- marker
:ref:`section about bookmarks <this-is-link-to-a-bookmark>` <-- reference to marker + caption
Images
images are inserted by adding the required image file to /_static/images/ in the repo and linking as follows:
...