openstack/openstack-manuals
Code Issues Proposed changes

Update Contributor Guide for changed guides

Browse Source 
Update for removal of user-guide-admin and rename of admin-guide-cloud
to admin-guide.

Change-Id: I33297bea86e57b744d52b095b61bec12526182ad
This commit is contained in:
Andreas Jaeger 2016-04-06 11:15:55 +02:00
parent 7263c35331
commit 89e23dc0cd
5 changed files with 5 additions and 15 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
doc/contributor-guide/source/build-locally.rst
View File

@ -97,7 +97,7 @@ To get the ``.html`` output locally, switch to the directory containing a
The RST source is built into HTML using Sphinx, so that it is displayed on
the *docs.openstack.org/<guide-name>*, for example,
http://docs.openstack.org/user-guide-admin.
http://docs.openstack.org/user-guide.
The DocBook source is built into HTML (webhelp) and PDF using XSLT transforms
included to the DocBook project.

10
doc/contributor-guide/source/content-specs.rst
View File

@ -69,9 +69,6 @@ Guides for end users
* `OpenStack End User Guide`_: Shows OpenStack end users how to create and
manage resources in an OpenStack cloud with the OpenStack dashboard and
OpenStack client commands.
* `OpenStack Admin User Guide`_: Shows OpenStack administrators how to create
and manage resources in an OpenStack cloud with the OpenStack dashboard and
OpenStack client commands.
* `OpenStack API Guide`_: A brief overview of how to send REST API
requests to endpoints for OpenStack services.
* `Command-Line Interface Reference`_: Automatically generates help text for
@ -102,7 +99,7 @@ Licenses
This section shows the license indicators as of March 20, 2015.
* OpenStack Architecture Design Guide: Apache 2.0 and CC-by-sa 3.0
* OpenStack Cloud Administrator Guide: Apache 2.0 and CC-by-sa 3.0
* OpenStack Administrator Guide: Apache 2.0 and CC-by-sa 3.0
* OpenStack Install Guides (all): Apache 2.0
* OpenStack High Availability Guide: Apache 2.0
@ -113,7 +110,6 @@ This section shows the license indicators as of March 20, 2015.
* Virtual Machine Image Guide: CC-by 3.0
* OpenStack Operations Guide: CC-by 3.0
* OpenStack End User Guide: CC-by 3.0
* OpenStack Admin User Guide: CC-by 3.0
* Command-Line Interface Reference: CC-by 3.0
* Contributor dev docs (docs.openstack.org/developer/<projectname>): none
@ -126,14 +122,13 @@ This section shows the license indicators as of March 20, 2015.
What to do to make more consistent output:
* OpenStack Architecture Design Guide: Apache 2.0 and CC-by 3.0
* OpenStack Cloud Administrator Guide: Apache 2.0 and CC-by 3.0
* OpenStack Administrator Guide: Apache 2.0 and CC-by 3.0
* OpenStack Install Guides (all): Apache 2.0 and CC-by 3.0
* OpenStack High Availability Guide: Apache 2.0 and CC-by 3.0
* OpenStack Security Guide: CC-by 3.0
* Virtual Machine Image Guide: CC-by 3.0
* OpenStack Operations Guide: CC-by 3.0
* OpenStack End User Guide: CC-by 3.0
* OpenStack Admin User Guide: CC-by 3.0
These guides are created by "scraping" code:
@ -170,7 +165,6 @@ This guide has a review in place to get a license indicator in output:
.. _`Virtual Machine Image Guide`: http://docs.openstack.org/image-guide/
.. _`OpenStack End User Guide`: http://docs.openstack.org/user-guide/index.html
.. _`OpenStack Admin User Guide`: http://docs.openstack.org/user-guide-admin/index.html
.. _`OpenStack API Guide`: http://developer.openstack.org/api-guide/quick-start/
.. _`Command-Line Interface Reference`: http://docs.openstack.org/cli-reference/

2
doc/contributor-guide/source/doc-tools/configuration.rst
View File

@ -7,7 +7,7 @@ the books to the directory ``publish-docs`` in the top-level directory
of your repository.
By default, it outputs a directory with the same name as the directory
where the ``pom.xml`` file lives in, such as ``admin-guide-cloud``. You can
where the ``pom.xml`` file lives in, such as ``glossary``. You can
also check the output of the build job for the name.
Some books need special treatment and there are three options you can

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

@ -118,10 +118,6 @@ Guides for end users
- http://git.openstack.org/cgit/openstack/openstack-manuals/tree/doc/user-guide
- http://docs.openstack.org/user-guide
* - Admin User Guide
- http://git.openstack.org/cgit/openstack/openstack-manuals/tree/doc/user-guide-admin
- http://docs.openstack.org/user-guide-admin
* - Command Line Interface Reference
- http://git.openstack.org/cgit/openstack/openstack-manuals/tree/doc/cli-reference
- http://docs.openstack.org/cli-reference

2
doc/contributor-guide/source/tools-and-content-overview.rst
View File

@ -11,7 +11,7 @@ information on the conversion, see `Doc Migration from DocBook to RST`_.
To work on the RST source files, find the :file:`/doc/guide/source/` directory
in a given OpenStack project. These files are built to
*docs.openstack.org/<guide-name>*, for example,
http://docs.openstack.org/user-guide-admin.
http://docs.openstack.org/user-guide.
Many cross-project manuals are in the
http://git.openstack.org/cgit/openstack/openstack-manuals/tree/ project.