13 Commits

Author SHA1 Message Date
Monty Taylor
9cdd967550
Go ahead and admit that we return Munch objects
There was a point in time in the past where we were gung ho on using
Munch as a halfway house to get us to pure dicts. However, we released
1.0 before we could do that, so we're pretty stuck with them for the
forseeable future. That's not terrible - they're pretty low overhead and
work pretty well.

Depends-On: Ie10099430481ffa76f5a19557e3693189544df6b
Change-Id: I8b7dd2c4038db999280ec0c2c9c43fb9499e6d22
2016-08-03 08:16:54 -05:00
David Shrewsbury
04774d8f80 Add release note doc to dev guide
Add a section to our Coding Standards documentation that describes
the use of reno for shade release notes.

Change-Id: I87973c5b3f68727aa0cb1ccb9a82c90a8a32ebd1
2016-05-04 09:54:26 -04:00
David Shrewsbury
ab8a196907 Clarify Munch object usage in documentation
We have pretty much settled on sticking with Munch objects for the
1.x series of shade releases. Change the documentation to note this.

Change-Id: I8b2838c3a5a40b0c74e31081bfb1ed4b0d39280f
2016-02-12 03:44:05 +00:00
Monty Taylor
83159ae486 Use reno for release notes
The OpenStack Release team has created a great release notes management
tool that integrates with Sphinx. Start using it. For reference on how
to use it, see http://docs.openstack.org/developer/reno/

Change-Id: I57692d720174fedb68ab2f52d5a4c496a6d993b2
2015-12-07 15:52:11 -05:00
David Shrewsbury
0f6203f303 Split out OpenStackCloud and OperatorCloud classes
Change-Id: If8a09f52313c07d12c7fe0da66f6599de3120979
2015-10-31 15:18:32 -04:00
Monty Taylor
0ab8b82c6b Move valid_kwargs decorator to _utils
It's not really a public symbol.

Change-Id: Iab016b93697f1e44fd299d6bfbfc80677030102d
2015-10-22 11:32:30 +09:00
David Shrewsbury
eeae22fb7f Add a developer coding standards doc
We have coding standards. Let's tell others about them.

Change-Id: I36456fa706db96ad1abb3d121f90981845065d8c
2015-08-12 16:25:05 -04:00
David Shrewsbury
0af29bda2f Clarify future changes in docs
The README was discussing future design decisions as if they were
already implemented. This can be confusing for new users. This
separates that discussion into a separate doc page and clarifies
its intentions.

Also, fix sphinx doc build warnings.

Change-Id: Ie66b60d972cae25a9805804ad17632aed0932627
2015-08-04 09:11:01 -04:00
Atsushi SAKAI
914d82a33a Fix two typos and one readablity on shade documentation
resouce => resource
expse   => expose

virtualenvwrapper => virtualenv wrapper

Change-Id: Id4dbcb4852eb2ef5dac4e0379e384c945c93a1ae
2015-07-29 14:36:07 +09:00
David Shrewsbury
e71bee318c Stop leaking server objects
We should not be returning raw client objects when creating or
rebuilding a server.

The usage document is updated to indicate that access to resource
values via attribute is deprecated, and the examples in the README
now reflect dict-style access.

Change-Id: Iac38d4c0b29f867cc3cefaccf48c1c3fcd17a3d9
2015-05-12 15:14:04 -04:00
Monty Taylor
5ca933aa7f Add API auto-generation based on docstrings
We've been adding docstrings, maybe we should put them into our
documentation.

Change-Id: I11ee33e1b87854403ec8b4e35f338c2c604d7fa4
2015-04-02 13:50:59 -04:00
Monty Taylor
5b3c005aae Fix up copyright headers 2015-01-07 12:31:15 -05:00
Monty Taylor
c046b39e79 Initial cookiecutter repo 2014-08-30 17:05:28 -07:00