The developer documentation has been updated to include an
optional command specs process. This process may be used
to work out the specifications for new commands, objects
and actions before their implementation.
This new process could assist in the implementation of
additional neutron support in OSC.
Change-Id: I62f7472435a9caacee0d1b4c8d35417c123b5a44
conflicting command names are a painpoint, so is manually updating
a list. let's autodocument the commands that are being use by
existing osc supporters.
Change-Id: If37d81dfd57cc79803668b64be1ccd776e319572
in addition to release notes, it'll be nice to also see the
changelog that happened between releases.
Change-Id: I4548be22c377ec12f0398a248391384126506715
This is a follow-up to I6c750730963615895f5d9953487d2d5a905885a8 that
removed a command deprecation warning wrapper. This documents the
technique for later use.
Change-Id: Ieaa1e6b7eed4e5b037b4bfb6cf488e1290fc69f7
Add a developer guideline for command options to define the options
used across multiple commands and make them behave consistently.
Change-Id: I1dbbafe8061e10b271cd55cac056731508c52204
OSC was missing developer docs, these are critically helpful for
new developers. Add sections related to running tests (tox,
functional and with the debugger), and generating docs locally.
implements bp: developer-documentation
Change-Id: I428d89c3e5fc335864bc4f7843506043ec332fe5
As the name of the associated IRC channel for this project is not
completely obvious, add a reference to the doc index page so that
it may be found easier.
Change-Id: I6cb6e2571bff73db6d983cd96fe6d03319d6577c
start tracking any changes in a standard format, so users may
have a heads up about any impacts.
Change-Id: Ibc06926a53592e927d11440362cd3598e0d4b2bf
Closes-Bug: 1406470
Also move the release notes to the bottom of the ToC, no need for
it to be at the top, that's prime real estate.
Change-Id: Ib3094a390a7214b320d02f77229f368aa4432c4e
Copy the content from the main wiki page that is not covered
elsewhere in these docs to the index page.
Change-Id: I94b68b7a0117d08fc8aba961c6de728118ef794e
This is a basic port of the Human Interface Guide from the OpenStack
wiki to our docs. Content changes for updating, etc, will follow
in a separate review.
Change-Id: Id031cd6a27e045b249e16d00e41be24c55fb3c29
Replace URLs for workflow documentation to appropriate parts of the
OpenStack Project Infrastructure Manual.
Change-Id: Id09c9bdf8804c1ed90e49606e76ffbff1d96a7c2
* Sort by command objects
* Drop the comparison to the project CLIs
* Minor updates to command help to match docs
Initially include the cross-API commands to establish the structure and format.
Change-Id: I77a7b3c89e088b66aa62941e29ce0b65b532285b
* Fill out the existing command and man page
* Add a plugins page.
* Begin the release notes for 0.3.0
Change-Id: I4527fed28a10a9d79fc8f6c1d925a4bf0d0a7a36
* rename HACKING to HACKING.rst and refer to the common OpenStack HACKING file
* add the barest of pointers to the wiki, etc. to the source docs
* add a bare-bones man page
Change-Id: I80e5b972af645f14ef17ae87f182ab09cb08dabe
Contributing blurb previously mentioned social coding and Github.
The OpenStack contribution workflow is slightly different. Provide
details on Github, LP, and Gerrit.
Change-Id: Ie5ecd25e5828de611561f37b3acbccc5cf3f0d04
To better facilitate the building and publishing of sphinx
documentation by Jenkins we are moving all openstack projects with
sphinx documentation to a common doc tree structure. Documentation
goes in project/doc/source and build results go in project/doc/build.
Change-Id: I925e687254bac9e06c2c520f4fc35a083e21c4ca
