]> review.fuel-infra Code Review - openstack-build/heat-build.git/commit
Code Review / openstack-build / heat-build.git / commit
? search:
summary | shortlog | log | commit | commitdiff | review | tree
(parent: 083c0cc) | patch
A new documention structure, ready for contributions
authorSteve Baker <sbaker@redhat.com>
Fri, 14 Dec 2012 01:13:05 +0000 (14:13 +1300)
committerSteve Baker <sbaker@redhat.com>
Tue, 18 Dec 2012 21:22:35 +0000 (10:22 +1300)
commitc4777794e78e2124f788a0b321e15febe71ee077
tree77fb0c935e8d0eed3736682cdd9ded1b3b8ebbc4tree | snapshot
parent083c0cc2b0137f1d0bf8ea03ae312489b7582933commit | diff
A new documention structure, ready for contributions

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
33 files changed:
doc/.gitignore [new file with mode: 0644] blob
doc/Makefile [new file with mode: 0644] blob
doc/README.rst [new file with mode: 0644] blob
doc/docbkx/README.rst [new file with mode: 0644] blob
doc/docbkx/api-ref/pom.xml [new file with mode: 0644] blob
doc/docbkx/api-ref/src/docbkx/api-ref.xml [new file with mode: 0644] blob
doc/docbkx/api-ref/src/wadls/heat-api/src/heat-api-1.0.wadl [new file with mode: 0644] blob
doc/docbkx/heat-admin/app_core.xml [new file with mode: 0644] blob
doc/docbkx/heat-admin/bk-heat-admin-guide.xml [new file with mode: 0644] blob
doc/docbkx/heat-admin/ch_install.xml [new file with mode: 0644] blob
doc/docbkx/heat-admin/ch_limitations.xml [new file with mode: 0644] blob
doc/docbkx/heat-admin/ch_overview.xml [new file with mode: 0644] blob
doc/docbkx/heat-admin/ch_preface.xml [new file with mode: 0644] blob
doc/docbkx/heat-admin/ch_using.xml [new file with mode: 0644] blob
doc/docbkx/heat-admin/pom.xml [new file with mode: 0644] blob
doc/docbkx/heat-cli-guide/pom.xml [new file with mode: 0644] blob
doc/docbkx/heat-cli-guide/src/bk-cli-guide.xml [new file with mode: 0644] blob
doc/docbkx/heat-cli-guide/src/heat_cli_commands.xml [new file with mode: 0644] blob
doc/docbkx/heat-cli-guide/src/heat_cli_howto.xml [new file with mode: 0644] blob
doc/docbkx/heat-cli-guide/src/heat_cli_install.xml [new file with mode: 0644] blob
doc/source/conf.py [new file with mode: 0644] blob
doc/source/index.rst [new file with mode: 0644] blob
doc/source/man/heat-api-cfn.rst [new file with mode: 0644] blob
doc/source/man/heat-api-cloudwatch.rst [new file with mode: 0644] blob
doc/source/man/heat-api.rst [new file with mode: 0644] blob
doc/source/man/heat-cfn.rst [new file with mode: 0644] blob
doc/source/man/heat-engine.rst [new file with mode: 0644] blob
doc/source/man/index.rst [new file with mode: 0644] blob
docs/man/man1/heat-api-cfn.1 [deleted file] blob | history
docs/man/man1/heat-boto.1 [deleted file] blob | history
docs/man/man1/heat-cfn.1 [deleted file] blob | history
docs/man/man1/heat-db-setup.1 [deleted file] blob | history
docs/man/man1/heat-engine.1 [deleted file] blob | history