Update documents for ha-guide/operations-guide

Update contributor guide and release notes for retirement of ha-guide
and operations-guide. Also, update some minor bits noticed.

Change-Id: Ia51389b672fd45e54d7e6ece5cda56853714190e
This commit is contained in:
Andreas Jaeger 2016-05-06 10:38:37 +02:00 committed by Olena Logvinova
parent 1558048802
commit 48628cf575
6 changed files with 26 additions and 12 deletions

View File

@ -46,5 +46,5 @@ running: ``tox`` inside of each.
The repositories gated by ``openstack-doc-tools`` are:
* api-guide
* api-site
* openstack-manuals

View File

@ -13,7 +13,7 @@ build_environment directory (deprecated)
A Vagrant environment for working with the guides.
cleanup directory
Manually cleanup documentation files.
Manually clean up documentation files.
sitemap
Generate the sitemap.xml file.
@ -58,9 +58,8 @@ www-generator.py
Generate static, template-based html files for http://docs.openstack.org/.
sync-projects.sh
Synchronizes the **Glossary**, common files, entity files, and some
translations across multiple repos, including ``api-site``,
``security-doc``.
Synchronizes the **Glossary**, common files, and some translations
across multiple repos, including ``api-site`` and ``security-doc``.
publishdocs.sh
Publishdocs job uses this script to publish documentation to
@ -76,7 +75,7 @@ Notes
- There are many undocumented synchronizations (automated and manual) between
the various documentation repositories. These should be documented.
- There are a several jobs that must be run regularly, for example updating
- There are a several jobs that must be run regularly, for example, updating
the ``sitemap.xml`` file and the command line configuration reference. These
should be documented.

View File

@ -85,8 +85,8 @@ Guides for deployers and administrators
- http://docs.openstack.org/mitaka/networking-guide
* - Operations Guide
- http://git.openstack.org/cgit/openstack/openstack-manuals/tree/doc/ops-guide/
- http://docs.openstack.org/openstack-ops/content
- http://git.openstack.org/cgit/openstack/openstack-manuals/tree/doc/ops-guide
- http://docs.openstack.org/ops-guide
* - Security Guide
- http://git.openstack.org/cgit/openstack/security-doc/tree/security-guide

View File

@ -153,7 +153,8 @@ of the Infrastructure manual.
with ``openstack-manuals`` as the documentation is mostly stored in
the *openstack-manuals* repository. However, if you need specific
guide sources, refer to *openstack/api-site*,
*openstack/security-guide*, *openstack/training-guides* repository.
*openstack/security-guide*, or *openstack/training-guides*
repository.
See :ref:`troubleshoot_setup` if you have difficulty with a repository
setup.

View File

@ -9,9 +9,7 @@ Thus this file covers the content of the following repositories:
* api-site
* fairy-slipper
* ha-guide
* openstack-manuals
* operations-guide
* security-guide
* training-guide
* training-labs

View File

@ -2,4 +2,20 @@
Next release: Newton
====================
Nothing yet.
User visible changes
====================
None yet.
Internal changes
================
* The API reference documentation has been moved from the api-site
repository to project specific repositories.
* The Operations Guide is now using RST as source format.
* The content of the separate repositories operations-guide and
ha-guide has been moved into the openstack-manuals repository. The
repositories operations-guide and ha-guide have been retired.