openstack/python-cinderclient
Code Issues Proposed changes

Cleanup the home page

Browse Source 
Good lord this thing needed some love. This change
does a few things:

* Remove the duplicate man page.
* Rename some titles to drop the CINDERCLIENT yelling -
  this is docs about cinderclient, I get it, no need to
  repeat in all caps.
* Fixed the sub-section title formatting in the home page.
* Dropped the duplicate usage guide wording and simply linked
  to the user docs from the home page.

Change-Id: I259787a40151e8c875ad87021f655a141e06b15e
This commit is contained in:
Matt Riedemann 2018-12-04 17:32:19 -05:00
parent 7cb50b4c4a
commit 85a3f0e30d
5 changed files with 11 additions and 91 deletions

5
doc/source/contributor/functional_tests.rst

@ -1,7 +1,4 @@
==================
CINDERCLIENT Tests
==================
================
Functional Tests
================

5
doc/source/contributor/unit_tests.rst

@ -1,7 +1,4 @@
==================
CINDERCLIENT Tests
==================
==========
Unit Tests
==========

28
doc/source/index.rst

@ -34,41 +34,25 @@ API::
[]
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
export OS_PASSWORD=pass
export OS_TENANT_ID=b363706f891f48019483f8bd6503c54b
export OS_AUTH_URL=http://auth.example.com:5000/v2.0
Once you've configured your authentication parameters, you can run ``cinder
help`` to see a complete listing of available commands.
See also :doc:`/cli/index` for detailed documentation.
~~~~~~~~~~~
.. toctree::
:maxdepth: 2
user/cinder
user/shell
user/no_auth
Command-Line Reference
======================
~~~~~~~~~~~~~~~~~~~~~~
.. toctree::
:maxdepth: 2
cli/index
cli/details
user/shell
user/no_auth
Developer Guides
================
~~~~~~~~~~~~~~~~
.. toctree::
:maxdepth: 2
@ -77,7 +61,7 @@ Developer Guides
contributor/unit_tests
Release Notes
=============
~~~~~~~~~~~~~
All python-cinderclient release notes can now be found on the `release notes`_
page.

58
doc/source/user/cinder.rst

@ -1,58 +0,0 @@
==============================
:program:`cinder` CLI man page
==============================
.. program:: cinder
.. highlight:: bash
SYNOPSIS
========
:program:`cinder` [options] <command> [command-options]
:program:`cinder help`
:program:`cinder help` <command>
DESCRIPTION
===========
The :program:`cinder` command line utility interacts with OpenStack Block
Storage Service (Cinder).
In order to use the CLI, you must provide your OpenStack username, password,
project (historically called tenant), and auth endpoint. You can use
configuration options `--os-username`, `--os-password`, `--os-tenant-name` or
`--os-tenant-id`, and `--os-auth-url` or set corresponding environment
variables::
export OS_USERNAME=user
export OS_PASSWORD=pass
export OS_TENANT_NAME=myproject
export OS_AUTH_URL=http://auth.example.com:5000/v3
You can select an API version to use by `--os-volume-api-version`
option or by setting corresponding environment variable::
export OS_VOLUME_API_VERSION=3
OPTIONS
=======
To get a list of available commands and options run::
cinder help
To get usage and options of a command::
cinder help <command>
BUGS
====
Cinder client is hosted in Launchpad so you can view current bugs at
https://bugs.launchpad.net/python-cinderclient/.

6
doc/source/user/no_auth.rst

@ -1,6 +1,6 @@
=========================
CINDERCLIENT Using noauth
=========================
============
Using noauth
============
Cinder Server side API setup
============================