openstack
/
openstack-manuals
Code Issues Proposed changes

[www] Update the links to Virtual Machine Image Guide 

also, update the DocBook example to CLI Reference.

Change-Id: I5e0ac56fa5cc03e0fc79122b59d96af142e5a214
This commit is contained in:
KATO Tomoyuki 2016-01-06 22:03:00 +09:00
parent 6064bce863
commit 1f005801a5
4 changed files with 12 additions and 12 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
README.rst
View File

@ -49,22 +49,22 @@ The different manuals are in subdirectories of the
DocBook guides
--------------
For example, the root directory of the *OpenStack Virtual Machine Image Guide*
is ``openstack-manuals/doc/image-guide``.
For example, the root directory of the *OpenStack Command-Line Interface Reference*
is ``openstack-manuals/doc/cli-reference``.
To build a specific guide, look for a ``pom.xml`` file within a subdirectory,
then run the ``mvn`` command in that directory. For example::
cd openstack-manuals/doc/image-guide/
cd openstack-manuals/doc/cli-reference/
mvn clean generate-sources
The generated PDF documentation file is::
openstack-manuals/doc/image-guide/target/docbkx/webhelp/image-guide/image-guide.pdf
openstack-manuals/doc/cli-reference/target/docbkx/webhelp/cli-reference/cli-reference.pdf
The root of the generated HTML documentation is::
openstack-manuals/doc/image-guide/target/docbkx/webhelp/image-guide/content/index.html
openstack-manuals/doc/cli-reference/target/docbkx/webhelp/cli-reference/content/index.html
RST guides

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

@ -134,17 +134,17 @@ using Maven plug-in in that directory. For example:
.. code-block:: console
cd openstack-manuals/doc/image-guide
cd openstack-manuals/doc/cli-reference
mvn clean generate-sources
Find the generated documentation in the
``openstack-manuals/doc/<guide-name>/target`` directory of the guide that you
build. For example:
* PDF: ``openstack-manuals/doc/image-guide/target/docbkx/webhelp/
image-guide/image-guide.pdf``
* HTML: ``openstack-manuals/doc/image-guide/target/docbkx/webhelp/
image-guide/content/index.html``.
* PDF: ``openstack-manuals/doc/cli-reference/target/docbkx/webhelp/
cli-reference/cli-reference.pdf``
* HTML: ``openstack-manuals/doc/cli-reference/target/docbkx/webhelp/
cli-reference/content/index.html``.
Using Tox to check builds
-------------------------

2
www/static/.htaccess
View File

@ -41,7 +41,7 @@ redirect 301 /trunk/openstack-compute/admin/content/ /admin-guide-cloud/
redirect 301 /trunk/openstack-object-storage/admin/content/ /admin-guide-cloud/
# Redirecting Image Guide to new location
redirect 301 /trunk/openstack-image/content/ /image-guide/content
redirect 301 /trunk/openstack-image/content/ /image-guide/
# Redirecting HA Guide to new location
redirect 301 /trunk/openstack-ha/content/ /ha-guide

2
www/templates/ops_and_admin_guides.tmpl
View File

@ -7,7 +7,7 @@
<p>Design, create, and administer a production OpenStack cloud</p>
<a href="/security-guide/">Security Guide</a>
<p>Guidelines and scenarios for creating more secure OpenStack clouds</p>
<a href="/image-guide/content/">Virtual Machine Image Guide</a>
<a href="/image-guide/">Virtual Machine Image Guide</a>
<p>Obtain, create, and modify OpenStack-compatible virtual machine images</p>
<a href="/arch-design/">Architecture Design Guide</a>
<p>Guidelines for designing an OpenStack cloud</p>