From 19db787551836b32cc127c8088a9e16097f75a7c Mon Sep 17 00:00:00 2001 From: Andreas Jaeger Date: Tue, 16 Jul 2019 18:51:40 +0200 Subject: [PATCH] Cleanup after api-quick-start import Remove extra whitespace, line wrap overlong lines, convert too long table to list-table, remove all setup.cfg files since we don't need them anymore. Change-Id: Icb0dc37c21927ecc6de163ae1b0245aea9b9c202 --- doc/api-quick-start/setup.cfg | 22 ------ .../source/api-quick-start.rst | 75 ++++++++++--------- doc/api-quick-start/source/index.rst | 4 - doc/doc-contrib-guide/setup.cfg | 27 ------- doc/glossary/setup.cfg | 27 ------- doc/image-guide/setup.cfg | 27 ------- doc/install-guide/setup.cfg | 27 ------- tox.ini | 2 +- 8 files changed, 39 insertions(+), 172 deletions(-) delete mode 100644 doc/api-quick-start/setup.cfg delete mode 100644 doc/doc-contrib-guide/setup.cfg delete mode 100644 doc/glossary/setup.cfg delete mode 100644 doc/image-guide/setup.cfg delete mode 100644 doc/install-guide/setup.cfg diff --git a/doc/api-quick-start/setup.cfg b/doc/api-quick-start/setup.cfg deleted file mode 100644 index 34094724b5..0000000000 --- a/doc/api-quick-start/setup.cfg +++ /dev/null @@ -1,22 +0,0 @@ -[metadata] -name = OpenStack API Documentation -summary = OpenStack API Documentation -description-file = - README.rst -author = OpenStack Documentation -author-email = openstack-docs@lists.openstack.org -home-page = https://developer.openstack.org/ -classifier = - Intended Audience :: Developers - License :: OSI Approved :: Apache Software License - -[build_sphinx] -all_files = 1 -build-dir = build -source-dir = source - -[pbr] -warnerrors = True - -[wheel] -universal = 1 diff --git a/doc/api-quick-start/source/api-quick-start.rst b/doc/api-quick-start/source/api-quick-start.rst index b645d89894..1817c065ae 100644 --- a/doc/api-quick-start/source/api-quick-start.rst +++ b/doc/api-quick-start/source/api-quick-start.rst @@ -46,44 +46,45 @@ Authenticate The payload of credentials to authenticate contains these parameters: -+-----------------------+----------------+--------------------------------------+ -| Parameter | Type | Description | -+=======================+================+======================================+ -| *User Domain* | string | The Domain of the user. | -| (required) | | | -+-----------------------+----------------+--------------------------------------+ -| username (required) | string | The user name. If you do not provide | -| | | a user name and password, you must | -| | | provide a token. | -+-----------------------+----------------+--------------------------------------+ -| password (required) | string | The password for the user. | -+-----------------------+----------------+--------------------------------------+ -| *Project Domain* | string | The Domain of the project. This is a | -| (optional) | | required part of the scope object. | -+-----------------------+----------------+--------------------------------------+ -| *Project Name* | string | The project name. Both the | -| (optional) | | *Project ID* and *Project Name* | -| | | are optional. | -+-----------------------+----------------+--------------------------------------+ -| *Project ID* | string | The project ID. Both the *project ID*| -| (optional) | | and *Project Name* are optional. But | -| | | one of them is required along with | -| | | the *Project Domain*. They are | -| | | wrapped under a scope object. | -| | | If you do not know the project name | -| | | or ID, send a request without any | -| | | scope object. | -+-----------------------+----------------+--------------------------------------+ +.. list-table:: Credential parameters + :widths: 10 10 40 + :header-rows: 1 + * - Parameter + - Type + - Description + * - *User Domain* (required) + - string + - The Domain of the user. + * - username (required) + - string + - The user name. If you do not provide a user name and password, you + must provide a token. + * - password (required) + - string + - The password for the user. + * - *Project Domain* (optional) + - string + - The Domain of the project. This is a required part of the scope object. + * - *Project Name* (optional) + - string + - The project name. Both the *Project ID* and *Project Name* are optional. + * - *Project ID* (optional) + - string + - The project ID. Both the *project ID* and *Project Name* are + optional. But one of them is required along with the *Project + Domain*. They are wrapped under a scope object. If you do not know + the project name or ID, send a request without any scope object. In a typical OpenStack deployment that runs Identity, you can specify your project name, and user name and password credentials to authenticate. -First, export your project name to the ``OS_PROJECT_NAME`` environment variable, -your project domain name to the ``OS_PROJECT_DOMAIN_NAME`` environment variable, -your user name to the ``OS_USERNAME`` environment variable, your password to the -``OS_PASSWORD`` environment variable and your user domain name to the -``OS_USER_DOMAIN_NAME`` environment variable. +First, export your project name to the ``OS_PROJECT_NAME`` environment +variable, your project domain name to the ``OS_PROJECT_DOMAIN_NAME`` +environment variable, your user name to the ``OS_USERNAME`` +environment variable, your password to the ``OS_PASSWORD`` environment +variable and your user domain name to the ``OS_USER_DOMAIN_NAME`` +environment variable. The example below uses an endpoint from an installation of Ocata by following the installation guide. However, you can also use ``$OS_AUTH_URL`` as an @@ -192,14 +193,15 @@ though it can be configured differently - see the `expiration `__ option in the the *Identity Service Configuration Guide*. -Export the project name to the ``OS_PROJECT_NAME`` environment variable. For example: +Export the project name to the ``OS_PROJECT_NAME`` environment +variable. For example: .. code-block:: console export OS_PROJECT_NAME=demo -Then, use the Compute API to list flavors, substituting the Compute API endpoint with -one containing your project ID below: +Then, use the Compute API to list flavors, substituting the Compute +API endpoint with one containing your project ID below: .. code-block:: console @@ -572,4 +574,3 @@ command with the image and flavor IDs and the server name: For information about the default ports that the OpenStack components use, see `Firewalls and default ports `_ in the *OpenStack Installation Guide*. - diff --git a/doc/api-quick-start/source/index.rst b/doc/api-quick-start/source/index.rst index f835fc76f7..8e721c5014 100644 --- a/doc/api-quick-start/source/index.rst +++ b/doc/api-quick-start/source/index.rst @@ -167,7 +167,3 @@ To begin sending API requests, use one of the following methods: :maxdepth: 2 api-quick-start - - - - diff --git a/doc/doc-contrib-guide/setup.cfg b/doc/doc-contrib-guide/setup.cfg deleted file mode 100644 index 7184a8c3f2..0000000000 --- a/doc/doc-contrib-guide/setup.cfg +++ /dev/null @@ -1,27 +0,0 @@ -[metadata] -name = openstackdocumentationcontributorguide -summary = OpenStack Documentation Contributor Guide -author = OpenStack -author-email = openstack-discuss@lists.openstack.org -home-page = https://docs.openstack.org/ -classifier = - Environment :: OpenStack - Intended Audience :: Information Technology - Intended Audience :: Documentation Contributors - License :: OSI Approved :: Apache Software License - Operating System :: POSIX :: Linux - Topic :: Documentation - -[global] -setup-hooks = - pbr.hooks.setup_hook - -[files] - -[build_sphinx] -warning-is-error = 1 -build-dir = build -source-dir = source - -[wheel] -universal = 1 diff --git a/doc/glossary/setup.cfg b/doc/glossary/setup.cfg deleted file mode 100644 index 2f9e4c0e00..0000000000 --- a/doc/glossary/setup.cfg +++ /dev/null @@ -1,27 +0,0 @@ -[metadata] -name = openstackdocumentationglossary -summary = OpenStack Documentation Glossary -author = OpenStack -author-email = openstack-discuss@lists.openstack.org -home-page = https://docs.openstack.org/ -classifier = - Environment :: OpenStack - Intended Audience :: Information Technology - Intended Audience :: Documentation Contributors - License :: OSI Approved :: Apache Software License - Operating System :: POSIX :: Linux - Topic :: Documentation - -[global] -setup-hooks = - pbr.hooks.setup_hook - -[files] - -[build_sphinx] -warning-is-error = 1 -build-dir = build -source-dir = source - -[wheel] -universal = 1 diff --git a/doc/image-guide/setup.cfg b/doc/image-guide/setup.cfg deleted file mode 100644 index 40352b2f60..0000000000 --- a/doc/image-guide/setup.cfg +++ /dev/null @@ -1,27 +0,0 @@ -[metadata] -name = virtualmachineimageguide -summary = OpenStack Virtual Machine Image Guide -author = OpenStack -author-email = openstack-discuss@lists.openstack.org -home-page = https://docs.openstack.org/ -classifier = - Environment :: OpenStack - Intended Audience :: Information Technology - Intended Audience :: Cloud Architects - License :: OSI Approved :: Apache Software License - Operating System :: POSIX :: Linux - Topic :: Documentation - -[global] -setup-hooks = - pbr.hooks.setup_hook - -[files] - -[build_sphinx] -warning-is-error = 1 -source-dir = source -build-dir = build - -[wheel] -universal = 1 diff --git a/doc/install-guide/setup.cfg b/doc/install-guide/setup.cfg deleted file mode 100644 index ad83dd08df..0000000000 --- a/doc/install-guide/setup.cfg +++ /dev/null @@ -1,27 +0,0 @@ -[metadata] -name = openstackinstallguide -summary = OpenStack Installation Guides -author = OpenStack -author-email = openstack-discuss@lists.openstack.org -home-page = http://docs.openstack.org/ -classifier = - Environment :: OpenStack - Intended Audience :: Information Technology - Intended Audience :: System Administrators - License :: OSI Approved :: Apache Software License - Operating System :: POSIX :: Linux - Topic :: Documentation - -[global] -setup-hooks = - pbr.hooks.setup_hook - -[files] - -[build_sphinx] -warning-is-error = 1 -build-dir = build -source-dir = source - -[wheel] -universal = 1 diff --git a/tox.ini b/tox.ini index d789bf0262..6f429f806f 100644 --- a/tox.ini +++ b/tox.ini @@ -95,7 +95,7 @@ usedevelop = False [doc8] # Settings for doc8: # Ignore target directories and autogenerated files -ignore-path = doc/*/target,doc/*/build*,doc/api-quick-start/source/api-quick-start.rst +ignore-path = doc/*/target,doc/*/build* # File extensions to use extensions = .rst,.txt # Maximal line length should be 79 but we have some overlong lines.