Some updates for RST CLI Reference
Update contributor-guide for RST conversions. Replace cli-reference/content/index.html with new location for RST guide. Change-Id: I17d5410bcb0f50d995f5d9123da218f57465935a
This commit is contained in:
parent
1a7bfc93e4
commit
777aed9821
@ -135,7 +135,7 @@ The following list explains the optional arguments that you can use with
|
||||
the ``create`` and ``update`` commands to modify image properties. For
|
||||
more information, refer to Image service chapter in the `OpenStack
|
||||
Command-Line Interface
|
||||
Reference <http://docs.openstack.org/cli-reference/content/index.html>`__.
|
||||
Reference <http://docs.openstack.org/cli-reference/index.html>`__.
|
||||
|
||||
``--name NAME``
|
||||
The name of the image.
|
||||
|
@ -25,7 +25,7 @@ MySQL, MariaDB, and SQLite.
|
||||
|
||||
Users can access OpenStack via the web-based user interface implemented
|
||||
by the :ref:`get_started_dashboard`, via `command-line
|
||||
clients <http://docs.openstack.org/cli-reference/content>`__ and by
|
||||
clients <http://docs.openstack.org/cli-reference/>`__ and by
|
||||
issuing API requests through tools like browser plug-ins or :command:`curl`.
|
||||
For applications, `several SDKs <http://developer.openstack.org/#sdk>`__
|
||||
are available. Ultimately, all these access methods issue REST API calls
|
||||
|
@ -134,17 +134,17 @@ using Maven plug-in in that directory. For example:
|
||||
|
||||
.. code-block:: console
|
||||
|
||||
cd openstack-manuals/doc/cli-reference
|
||||
cd openstack-manuals/doc/glossary
|
||||
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/cli-reference/target/docbkx/webhelp/
|
||||
cli-reference/cli-reference.pdf``
|
||||
* HTML: ``openstack-manuals/doc/cli-reference/target/docbkx/webhelp/
|
||||
cli-reference/content/index.html``.
|
||||
* PDF: ``openstack-manuals/doc/glossary/target/docbkx/webhelp/
|
||||
glossary/glossary.pdf``
|
||||
* HTML: ``openstack-manuals/doc/glossary/target/docbkx/webhelp/
|
||||
glossary/content/index.html``.
|
||||
|
||||
Using Tox to check builds
|
||||
-------------------------
|
||||
|
@ -168,7 +168,7 @@ This guide has a review in place to get a license indicator in output:
|
||||
.. _`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/content/
|
||||
.. _`Command-Line Interface Reference`: http://docs.openstack.org/cli-reference/
|
||||
|
||||
.. _`Complete API Reference`: http://developer.openstack.org/api-ref.html
|
||||
.. _`API specifications`: http://specs.openstack.org/
|
||||
|
@ -128,7 +128,7 @@ Guides for end users
|
||||
|
||||
* - Command Line Interface Reference
|
||||
- http://git.openstack.org/cgit/openstack/openstack-manuals/tree/doc/cli-reference
|
||||
- http://docs.openstack.org/cli-reference/content
|
||||
- http://docs.openstack.org/cli-reference
|
||||
|
||||
Developer guides
|
||||
----------------
|
||||
@ -235,9 +235,9 @@ tell the build where to place the built files.
|
||||
|
||||
::
|
||||
|
||||
<targetDirectory>${basedir}/target/docbkx/webhelp/admin-guide-cloud<targetDirectory>
|
||||
<targetDirectory>${basedir}/target/docbkx/webhelp/glossary<targetDirectory>
|
||||
<webhelpDirname>/</webhelpDirname>
|
||||
<pdfFilenameBase>bk-admin-guide-cloud-latest</pdfFilenameBase>
|
||||
<pdfFilenameBase>bk-glossary</pdfFilenameBase>
|
||||
|
||||
The clouddocs-maven-plugin automatically detects which images you use in your
|
||||
document and copies them to the output directory. When you use .svg graphics,
|
||||
|
Loading…
Reference in New Issue
Block a user