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

Compare with Current View Page History

« Previous Version 3 Next »

Resources

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

Documentation Source Repos

https://github.com/apache/cloudstack-docs-install.git is the install guide

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

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

Writing Documentation Basics

Here are the steps to create a PR the 

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



  • No labels