Versions Compared

Key

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

...

To try to avoid too much confusion we will refer to releases and branches when talking about the documentation source, and versions when talking about published documentation.
We will refer to the Read The Docs service as RTD.

Versioning (Tags and Branches)

...

Read The Docs

To start with, you will need to create an account on Read The Docs (https://readthedocs.org/accounts/signup/) and then ask on the dev@ mailing list for someone to add you to the CloudStack Docs Projects.

Versioning (Tags and Branches)

The RTD uses the branches and tags to link versions of the documentation to moments in time in the source, to update the tags and branches seen by RTD, run a build of master

...

The reading of tags is dynamic, so you can remove and re-add a tag and then rebuild that 'version'.

...

If the versions of documentation are linked to branches (ie Installation Docs) then :

  1. *TO DO not sure if this bit is true yet* create a branch using the version as the name of the branch.
  2. Update the available tags in RTD by running a build of master.
  3. Then create a version linked to the tag that you added previously
  4. Then build that version.

Merging a pull request into that branch will cause the version to be built and updated online automatically

...