This replaces the doc-migration work. We can avoid the maintenance
cost by generating CLI reference for neutron CLI like this.
This patch introduces a new sphinx directive to render CLI
global options to achieve the goal. This can be migrated to
cliff sphinxext later.
Change-Id: I7089df3f7fc6475ebdd1e71221492baf12f18226
Recently cliff introduced a sphinx extension directive named autoprogram-cliff
which genarates command-line help automatically. By using it, we no longer
need to write command-line help document separately.
Also fixes minor string substitution issue in a BGPVPN command.
Note that the new cliff release with the directive is not released yet,
but there are several number of OSC plugin commands proposed and
having a local copy would help such developers.
Change-Id: I6b1aee89f406ac449fbc43e210c4ca7ad901b19b
* Move OSC first as neutron CLI is deprecated
* Add more information on OSC usage (links to embeded command list
and the mapping guide)
* Add deprecation notice for neutron CLI
This commit also makes toctree structure simpler
At now, we have two index page unlinked from the top page.
I thought it is good first, but it potentially makes things tricky.
Let's remove such tweaks for easy maintenance.
Change-Id: I7fd79f465fa6c04bf5b13f6578796d4c2d01edfd
The new simple configuration way was introduced in
openstackdocstheme 1.11.0. This commit introduces the new way.
Also drops unnecessary sphinx configurations like latex,
texinfo and manpages.
Change-Id: I587eb8cbd3e64c65dfc7247a01eca90af6adad4e
Neutron CLI itself is now deprecated. It means a kind of
feature freeze and we don't accept any changes on
adding/changing/dropping the existing commands.
The only exception is bug fixes on the deprecated neutron CLI.
It is better to document our policy on neutron CLI chnages.
Change-Id: I5f063c7eddbc9a91f587d5d3610092d07150f726
The docs currently show deprecated forms of client creation. Update them
to use keystoneauth Session and Identity v3.
Change-Id: I3ec285e9b02db870276bae6a9b7e1278e5d306f6
Closes-Bug: #1566448
This patch adds a new path under neutronclient docs
to document the newly added OSC commands. All new CLI commands
added via the openstack client plugin must now provide a user
guide to these commands under doc/source/usage/osc/v2
Change-Id: Id16d2fb0712fe6dd4a45a765bf7b65410302f5b8
All occurrences of tenant replaced with project (where applicable).
Partially Implements blueprint: keystone-v3
Change-Id: I4919745aa59863f99c7740e730d8cbfd91c2f646
Update the "Transition to OpenStack Client" devref with the plan
for handling network resources in Newton. In particular, this
update clarifies the OpenStack project where the commands will
reside. This update attempts to capture some of the information
in [1] and to address packaging concerns.
[1] https://etherpad.openstack.org/p/osc-neutron-support
Change-Id: I95e579ab23377a6cf36fc7a50356ab406d350053
Related-Bug: #1521291
Update the "Transition to OpenStack Client" devref with the following:
- Status update per start of Newton release
- Change developer references to use github for latest information
Change-Id: I17111b833a83395f379ed8e93091cd1956b80dbd
Related-Bug: #1521291
Update the "Transition to OpenStack Client" devref with information
about the new OSC command specs process. This process can be used
to propose new networking commands while deferring their
implementation. This process may help speed the overall transition
to OSC.
This update also includes information about the OSC neutron support
etherpad which provides detailed status for the transition.
And finally, updates were made to the overall transition plan
based on discussions at the midcycle.
Change-Id: I46bc066d2169a1e20af13baac7131ffa2eedd7c8
Related-Bug: #1521291
Added wrapper classes which are inherited from base data types tuple, dict
and str. Each of these wrapper classes contain a 'request_ids' attribute
which is populated with a 'x-openstack-request-id' received in a header
from a response body.
This change is required to return 'request_id' from client to log
request_id mappings of cross projects[1].
[1]: http://specs.openstack.org/openstack/openstack-specs/specs/return-request-id.html
Change-Id: I55fcba61c4efb308f575e95e154aba23e5dd5245
Implements: blueprint return-request-id-to-caller
Add developer reference for the transitition of the neutron CLI
support to the openstack CLI.
Change-Id: I5f9885eab7b6d1b6f4ee0d9cf84a07a0cb9d8c9a
Related-Bug: #1521291
A lot of changes have been proposed to add options to
*-create/update operations. This guideline tries to clarify
the conventions used in neutornclient.
Change-Id: I2c66c3dcba2569fdac2e54afb49406084cbf7037
* Filtering in list operation
* Changing displayed columns in list operation
* Debug: display API level communication
Change-Id: Ifba20559c76bf0c1b29f9ef3ac9def3882099956
Per the recent release note guidelines for libraries [1],
reno based release notes will be moved out from the normal docs.
The previous (partial) release notes are also moved to
releasenotes directory. The developer documentation now
has a link to the releasenote web site.
In addition, having reno directive in normal sphinx document
prevents users from generating our docs from release tarballs.
[1] http://lists.openstack.org/pipermail/openstack-dev/2015-November/080694.html
Change-Id: I817f1a7331b8664486544c82e1a9a917864601bf
Closes-Bug: #1520096
This reorganization is to make it easier to add more contents.
It move the usage of CLI and python binding to separate pages.
Change-Id: I39e0d1d18010dfd1c687c573619a09331f12241a
Even though [pbr] warnerrors = true is specified,
somehow sphinx warnings are not treated as errors.
If we use sphinx-build, -W option detects document warnings
and it leads to better documentation quality.
Fix a warning in the existing document too.
Change-Id: Icbb39686c7a24f0040d998fb14e14c63613da190
