openstack/openstack-manuals
Code Issues Proposed changes

Explain continous and versioned publishing

Browse Source 
Explain which guides are continously published and which are versioned,
explain the concepts as well.

Use liberty instead of kilo as example.

Change-Id: I3f3b76bc5f3e663ae88df650d762a11c2227201c
This commit is contained in:
Andreas Jaeger 2015-12-27 10:36:05 +01:00
parent 5fc64af57a
commit d4d965f9c6
1 changed files with 17 additions and 11 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

28
doc/contributor-guide/source/docs-builds.rst
View File

@ -7,12 +7,18 @@ Documentation builds
Documentation source and target locations Documentation source and target locations
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Most documents are continously published, they are published only from the
master branch and there is no specific version for a stable release,
instead they document the releases that the OpenStack community
currently maintains. There are also version dependent documents.
In addition to this page, the `release`_ and master branches of the In addition to this page, the `release`_ and master branches of the
openstack-manuals and other repositories indicate where docs are published. openstack-manuals and other repositories indicate where docs are
For example, from the stable/kilo release branch, doc source files are published. For example, from the stable/liberty release branch, doc
published to docs.openstack.org/kilo, and from the master branch, doc source files are published to docs.openstack.org/liberty, and from the
source files are published to docs.openstack.org/draft by our lovely Jenkins master branch, doc source files are published for versioned documents to
butlers always at the ready. docs.openstack.org/draft and for continously published documents to
docs.openstack.org/ by our lovely Jenkins butlers always at the ready.
Some content is completely generated using openstack-doc-tools, such as the Some content is completely generated using openstack-doc-tools, such as the
configuration option tables and the CLI reference information. You will see configuration option tables and the CLI reference information. You will see
@ -26,12 +32,8 @@ config tables`_ or CLI references.
Installation guides Installation guides
------------------- -------------------
These guides are only built from the release branches (stable/release_name) These guides are versioned and only built from the release branches
like the example above of stable/kilo. (stable/release_name) like the example above of stable/liberty.
.. note::
Installation guides are being migrated to RST/Sphinx. See
`Documentation/Migrate`_ for more information.
.. list-table:: .. list-table::
:header-rows: 1 :header-rows: 1
@ -98,6 +100,10 @@ Guides for deployers and administrators
- http://git.openstack.org/cgit/openstack/openstack-manuals/tree/doc/image-guide - http://git.openstack.org/cgit/openstack/openstack-manuals/tree/doc/image-guide
- http://docs.openstack.org/image-guide/ - http://docs.openstack.org/image-guide/
.. note::
The Configuration Reference and the Networking Guide are versioned,
all other guides are continously published.
Guides for end users Guides for end users
-------------------- --------------------