Commit Graph

15 Commits

Author SHA1 Message Date
Andreas Jaeger d2e1f23d91 Remove firstapp guides
These guides are dead, remove them completely. This will also remove
the documents from the developer website, so remove all links.

Change-Id: Ifd9a4d8a187962498d6f1133226a77308bc2f5ff
2019-07-17 08:42:50 +00:00
Anne Gentle d4156fe7f8 Adds build script for Swagger JSON conversion
- This change lets us upload Swagger files for testing and
validating online.

Change-Id: Ifb570e42b29ec8f01889c982b7cd700754a0e5f7
2016-02-05 15:21:33 -05:00
Andreas Jaeger 7bc1d5d987 Publish German QuickStart as Draft
This gates and publishes the German QuickStart as draft document.

Also, ignore build results for api-quick-start and reorder one entry in
the .gitignore file.

Change-Id: Ib512df6641e14b99be3ffa4fcd4a49d2706347f2
2015-10-09 09:34:20 +02:00
Andreas Jaeger f58477ef61 FirstApp: Move source directory up, rename top-level dir
For the RST guides, we do not need doc/source, since doc is always
empty. Use source directly.

This syncs the setup used here with openstack-manuals.

Rename top-level from openstack-firstapp to firstapp, there's no need
for the long name in this repo.

Change-Id: If4e11a4f90d580876865348e0d88b92cec4b6659
2015-05-01 17:22:46 +02:00
Andreas Jaeger 7d0c7c290e Add docs target, build as part of checkbuild
Add docs target that lists those firstapp targets that are currently
supported. Adjust .gitignore to ignore all build results.

Change firstapp commands so that we have separate build directories per
variant.

Change-Id: I7c5120b1af2de2c3df8f59fe29678e736368365f
2015-04-23 19:12:10 +02:00
Sean M. Collins c219133376 Add "Writing your First OpenStack Application" Guide
Written during a book sprint in Taipei, from March 30th 2015
to April 3rd 2015.

Co-Authored-By: Sean M. Collins <sean@coreitpro.com>
Co-Authored-By: Tom Fifield <tom@openstack.org>
Co-Authored-By: James Dempsey <jamesd@catalyst.net.nz>
Co-Authored-By: Nick Chase <nchase@mirantis.com>
Co-Authored-By: Christian Berendt <berendt@b1-systems.de>

Implements blueprint openstack-firstapp

Change-Id: I55ae32d0c04f641c818bda4714d9bc691a98e6b1
2015-04-21 09:15:26 +10:00
Andreas Jaeger 1f64b95737 Enable building of translated manuals
This is the initial setup to build translated manuals. For now only the
api-quick-start is build.

This needs openstack-doc-tools version 0.13.

Change-Id: I140b8007d76bda5f436cbd80e77b890852c71827
2014-04-24 20:14:13 +02:00
Andreas Jaeger 0faccca209 doc-tools: Ignore build-.log.gz
Change-Id: I4fa3b6c2079d400b97db8a3fca2ffb6ac2d502b1
2014-02-08 22:09:09 +01:00
Andreas Jaeger f58bf159b7 Ignore publish-docs directory
Ignore publish-docs directory. This is the directory used by
openstack-doc-test to copy draft documents to.

blueprint draft-docs-on-docs-draft

Change-Id: I621d1c63716d3cc04ea5678def5ecba13e29c807
2014-02-02 16:35:03 +01:00
Andreas Jaeger 30f4240e0c Setup for openstack-doc-tools gating
Add files to allow us gating via:
tox -e checkbuild
tox -e checkniceness
etc

Enhance .gitignore to ignore files used by gating and by more
editors.

Change-Id: Id33d04f734d438d01dd5bbd784abaa213de5dbc9
2014-01-02 17:00:03 +01:00
annegentle 768ff64741 Fix doc bugs -
bug 1034021 trailing off sentence in overview
bug 1034772 included typo
bug 1034462 scheduler typo
bug 1017691 change in name of root wrap config option

Change-Id: Ia7ecf12f39771c49915b927ea3f0de89c9f28327
2012-08-17 15:38:28 -05:00
Jesse Andrews 0d101b7afa standardize capitalization: ReST -> REST
source: http://en.wikipedia.org/wiki/Representational_state_transfer

Change-Id: If35339d1dc663c5b07a23bf62cb551bb29fe8037
2012-02-29 23:18:48 -08:00
Lorin Hochstein d92ca271ec Added info on how to build docs to the README.
Added info in the README.rst about how to generate the documentation.

Word-wrapped all text to 78 chars or less.

Now ignores Oxygen XML editor project files (.xpr)

Change-Id: I167605c95c706ac1ef82393aa8301594ced1e01d
2011-11-28 09:03:11 -05:00
Lorin Hochstein 9a1da4ebb7 Removed and ignored auto-generated files.
Remoed all files in target/ subdirectories.

Fixed .gitignore so it properly ignores these files.

Change-Id: Ib435a9cc3d858081717d838e48528a96239e2e9d
2011-11-20 19:24:33 -05:00
annegentle 230f729e87 Adds keystone pom.xml file
Change-Id: I5f74951c915c41ed4fe0f7498b7f463e1cc4242a
2011-09-28 13:13:00 -05:00