90 Commits

Author SHA1 Message Date
Richard Theis
2e048fdc94 Devref: Add dynamic routing to OSC transition
Add dynamic routing commands to OSC transition devref.

Change-Id: Ifa8c2ece88e185f932cb812d1393750ce93585e9
Related-Bug: #1521291
2016-05-09 08:15:50 -05:00
Jenkins
2a7cc35e84 Merge "Devref Update: Transition to OpenStack Client" 2016-04-20 03:25:21 +00:00
Richard Theis
3faf02f6ca Devref: Newton updates for transition to OSC
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
2016-04-07 10:16:08 -05:00
Richard Theis
6c82731fe7 Devref Update: Transition to OpenStack Client
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
2016-03-29 13:10:47 -05:00
Jenkins
e2444d4f53 Merge "Devref Update: Transition to OpenStack Client" 2016-03-02 17:32:21 +00:00
Richard Theis
585a4ffbfa Devref Update: Transition to OpenStack Client
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
2016-02-26 08:28:12 -06:00
Hirofumi Ichihara
65118c09eb Add wrapper classes for return-request-id-to-caller
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
2016-02-26 16:16:55 +09:00
Hirofumi Ichihara
6581284941 Fix code-block for python code in doc
Change-Id: Ia5cb007b0a0093e478416161763dcaa23b9cfbe4
2016-01-25 19:29:57 +09:00
Jenkins
f8c1f4ec8d Merge "Devref: Transition to OpenStack Client" 2016-01-07 16:08:43 +00:00
Richard Theis
722ce10d3c Devref: Transition to OpenStack Client
Add developer reference for the transitition of the neutron CLI
support to the openstack CLI.

Change-Id: I5f9885eab7b6d1b6f4ee0d9cf84a07a0cb9d8c9a
Related-Bug: #1521291
2016-01-05 10:09:15 -06:00
Jenkins
31d55759e5 Merge "Adding missing headers to the devref documents" 2015-12-21 22:19:53 +00:00
vikram.choudhary
b7e3a214d7 Reworded nargs='?' explanation for better clarity
Change-Id: Iae2c71695ed18504690cc953b4128aeaf3196275
2015-12-15 13:53:36 +05:30
vikram.choudhary
4c96d4a1d5 Adding missing headers to the devref documents
Change-Id: Ie7f8b8d5751ff378e999287c29c1f3e4714ea64a
2015-12-11 13:57:07 +05:30
Jenkins
8899c03be8 Merge "Add CLI option guideline" 2015-12-04 21:23:59 +00:00
Jenkins
508984f694 Merge "Add description of extra args in CLI" 2015-12-04 21:23:56 +00:00
Jenkins
9fdb63d56a Merge "Add os-client-config to CLI usage" 2015-12-04 21:23:54 +00:00
Jenkins
92256a3163 Merge "Add more contents about CLI usage" 2015-12-04 21:23:07 +00:00
Akihiro Motoki
b05d94377c Add CLI option guideline
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
2015-12-04 22:50:52 +09:00
Akihiro Motoki
1b97f4bcc3 Add description of extra args in CLI
Change-Id: Ia732d7ba82e3e5a5698a68be8e86eed87916f7da
2015-12-04 20:16:51 +09:00
Akihiro Motoki
a2f2908c16 Add os-client-config to CLI usage
Change-Id: I5d4a3d7206c8f90f479047e8ee810496c06022d9
2015-12-04 20:14:07 +09:00
Akihiro Motoki
f5b4a27fb7 Add more contents about CLI usage
* Filtering in list operation
* Changing displayed columns in list operation
* Debug: display API level communication

Change-Id: Ifba20559c76bf0c1b29f9ef3ac9def3882099956
2015-12-04 20:12:45 +09:00
Akihiro Motoki
800f35d8a5 Do not include reno releasenotes in normal documentation
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
2015-12-04 02:43:46 +09:00
Akihiro Motoki
dd8f157aa7 Reorganize documentation structure
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
2015-12-01 15:46:54 +09:00
Akihiro Motoki
a14a5f9a27 Use sphinx-build -W in [docs] target
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
2015-11-28 06:20:48 +09:00
Akihiro Motoki
66b03a8167 Add reno for release notes management
In addition to the convention of releasenotes/source directory
which used in most OpenStack project, we have the release notes
in our developer documents.

Change-Id: Ied07af5ee5c8929e639e17a34b559cebfe419dc4
2015-11-24 07:39:23 +09:00
Akihiro Motoki
895b9b9d21 Move the old release notes to a separate file
Preparation for reno adoption in a following patch

Change-Id: Ice4f45147ae9699a5be2c60c0ed247b893881d62
2015-11-24 07:38:53 +09:00
gong yong sheng
a174215491 Clear the extension requirement
Change-Id: If0725e009dfb98fe949b9e00349108c88cf4424a
Closes-bug: #1486845
2015-08-25 09:26:00 +08:00
gong yong sheng
54e7b94012 Add document for entry point in setup.cfg
In addition, to remove the contrib/ way to load commands since
it is not implemented at all.

Change-Id: Id15eb10e7cb086d55d2bcad4f719f9120c6f7d1a
Closes-Bug:#1486824
2015-08-20 12:00:52 +08:00
Gal Sagie
ab7d9e805a Devref documentation for client command extension support
Change-Id: If71c9e2bbf888b1a68d3b7dc351f7df02f1a380f
Closes-Bug: #1470622
2015-07-14 18:00:43 +03:00
Lucas H. Xu
58a5ec66cf Add alternative login description in neutronclient docs
A way to test it is to follow the description and create
a neutron client using the alternative way

Make changes based on Akihiro comments
Add extra colon in line 19

Change-Id: I2f7a5a3e8f7386d24d258303b3056615da8612ad
2015-06-12 11:38:02 -04:00
Andreas Jaeger
60e8961097 Stop using intersphinx
Remove intersphinx from the docs build as it triggers network calls that
occasionally fail, and we don't really use intersphinx (links other
sphinx documents out on the internet)

This also removes the requirement for internet access during docs build.

This can cause docs jobs to fail if the project errors out on
warnings.

Change-Id: I71e941e2a639641a662a163c682eb86d51de42fb
Related-Bug: #1368910
2014-09-13 09:44:00 +02:00
Steve Martinelli
c05eb2941f Update theme for docs
The current developer docs theme used is out of sync with the other
openstack projects. This patch will update the docs to provide a more
consistent look and feel when using developer docs

Change-Id: I03985039381c2ba4f81a2015258f7b49bba441d9
2014-07-24 21:28:19 -04:00
Wu Wenxiang
ab24db6134 Remove unused imports
Remove unused imports in doc/source/conf.py

Change-Id: Ia21f8952b36ae74b1c2d3bfd10c0a4a04a390faa
Closes-Bug: #1265266
2014-02-19 21:26:25 +08:00
Sean Winn
1b36606b39 Change copyright headers from LLC to Foundation
Closes-Bug: #1214176
Change-Id: I8c8095860f6e17652bb5f52583008774180337f6
2013-10-04 02:37:37 +09:00
Mark McClain
93ac15bfeb Rename quantumclient to neutronclient
Implements Blueprint: remove-use-of-quantum

Change-Id: Idebe92d56d277435ffd23f292984f9b8b8fdb2df
2013-07-03 11:56:44 -04:00
Mark McClain
92811c76f3 add readme for 2.2.2
Change-Id: Id32a4a72ec1d13992b306c4a38e73605758e26c7
2013-05-29 09:32:53 -04:00
gongysh
a63555120a add 2.2.0 release note in index.rst file
Bug #1156480

Change-Id: Ib28266a362e76960455509b7a2af57d5315f70df
2013-03-18 15:25:34 +08:00
gongysh
0dc8d7c8ba Delete network with id in sample code using API.
Bug #1106936

Change-Id: I6a7ee694a916af3f0268884ce28ca12e5efdc025
2013-01-27 22:55:38 +08:00
gongysh
2a45b707bd Add document for using quantum client by python or cli invocation.
After this patch, we should see output at
http://docs.openstack.org/developer/python-quantumclient/.

Change-Id: I908c0d0e7f80a6eb73e97ee30eaab1bfbfec1e61
2012-09-12 21:09:59 +08:00
Monty Taylor
f7086ed40a Add initial docs.
Change-Id: I846eec12e800c15a545946604fe77a0a6b83fb46
2012-06-14 18:04:52 -04:00