diff options
| author | Jenkins <jenkins@review.openstack.org> | 2017-07-27 14:16:52 +0000 |
|---|---|---|
| committer | Gerrit Code Review <review@openstack.org> | 2017-07-27 14:16:52 +0000 |
| commit | 99bb6f3ecb1f3c883c50bf715618e64b145257b2 (patch) | |
| tree | adb2535f18f2790ff0bfdc831d6979d4729fd7ae /doc/source/index.rst | |
| parent | f5bedfc5bab5bc73f791c0cf2c2c033472b700e1 (diff) | |
| parent | a3f9f4f16d0bf64a6b5467c5b6ee25a9214706c6 (diff) | |
| download | python-cinderclient-3.1.0.tar.gz | |
Merge "Rearrange existing documentation to fit the new standard layout"3.1.0
Diffstat (limited to 'doc/source/index.rst')
| -rw-r--r-- | doc/source/index.rst | 26 |
1 files changed, 24 insertions, 2 deletions
diff --git a/doc/source/index.rst b/doc/source/index.rst index e55b6bb..13d95c5 100644 --- a/doc/source/index.rst +++ b/doc/source/index.rst @@ -28,8 +28,8 @@ Alternatively, you can create a client instance using the keystoneauth session A >>> cinder.volumes.list() [] -Command-line Tool -================= +User Guides +=========== In order to use the CLI, you must provide your OpenStack username, password, tenant, and auth endpoint. Use the corresponding configuration options (``--os-username``, ``--os-password``, ``--os-tenant-id``, and ``--os-auth-url``) or set them in environment variables:: export OS_USERNAME=user @@ -41,6 +41,28 @@ Once you've configured your authentication parameters, you can run ``cinder help See also :doc:`/cli/index` for detailed documentation. +.. toctree:: + :maxdepth: 2 + + user/cinder + +Command-Line Reference +====================== + +.. toctree:: + :maxdepth: 2 + + cli/shell + cli/no_auth + +Developer Guides +================ + +.. toctree:: + :maxdepth: 2 + + contributor/functional_tests + contributor/unit_tests Release Notes ============= |