git.openstack.org is our official server, github is just a
read-only mirror.
Linking to github might also raise the expectation that we use the usual
github workflow which is not the case.
Change-Id: I3b3e8213c264757838c8e5fd33221eebf219cdc8
With the incorporation of many projects within OpenStack, it's very important to
use standards in the documentation This is important for formalization as well
as consistency
the proper usage is: heat or Orchestration or Orchestration module
heat should not be capitalized
https://wiki.openstack.org/wiki/Documentation/Conventions
Change-Id: Ia8d7f1429f877e4c88fc9b210948b63443376ba0
- The original heat wadl (heat-api-1.0.wadl) and the samples have now
been deleted from this repo. The wadl has been renamed and migrated
to the following location along with the samples:
https://github.com/openstack/api-site/blob/master/api-ref/src/wadls/
orchestration-api/src/v1/orchestration-api.wadl
- Inserted api-ref/src/wadls/heat-api/src/README.rst file in repo
that specifies the new wadl location.
- Updated pom file to latest version of clouddocs-maven-plugin.
- Currently clouddocs-maven-plugin 1.11.0 has a bug which creates
new sections for the request and response examples for each API
call. This will be fixed in an upcoming release of the plugin.
- Several remarks are inserted in the manual text and marked with
security="writeronly" so they do not appear in the output. You
are welcome to provide any answers and feedback you may have for
these remarks.
- Fix title for commit to resolve H803 build exception.
- Fix extra spaces in file /wadls/heat-api/src/README.rst, and
wrap lines in commit message at less than 70 characters.
Change-Id: I478b394268f64b41317ab77fff6d6366ddd7efa1
quantumclient is gone upstream and has been replaced by neutronclient.
This patch retains the OS::Quantum::XX namespace
Fixes: bug #1197208
Change-Id: Id48f9598ea1884132d411ad533770ae49494102b
Support "Environment" section in the create/update body.
We the roll up the parameters and the environment and send
that as json using the rpc "params" argument. So no changes
to the rpc layer are needed. The engine knows how to deal
with both formats in the Environments class.
blueprint envirnonments
Change-Id: I6d6085d5c052a5f9115ecd46891b00d2fad4d1db
Here are some skeletons for the documentation which will need to be written.
doc/source
A Sphinx based document which will be aimed at heat developers.
This also contains .rst files which generate the man files
doc/docbkx/api-ref
Docbook and WADL for the REST API, with the intent of moving this
to api-site to publish to api.openstack.org
doc/docbkx/heat-admin
Docbook manual targeted at Heat admins, with the intent of moving this
to openstack-manuals to publish to docs.openstack.org
doc/docbkx/heat-cli
Docbook manual targeted at users of the Heat CLI, with the intent of
moving this to openstack-manuals to publish to docs.openstack.org
Dude, wheres my man pages?
docs/man
is deleted, now generated into doc/build/man
Packaging will need to be updated to generate the man pages
Change-Id: Idf2f37086b6f97df18ed57172de2f9e3d4c7706a
