5a11f8343c
The Libcloud version of FirstApp is ready to move from draft stage so it can be widely disseminated to satiate the burning need for this content that is currently not being addressed. The guide was very well received during it's packed-room summit sesion. So far it has received significantly more editing and testing than other sprint-created documents when they were published. This is thanks to the work of: Andreas Jaegar, Karen Bradshaw, Diane Fleming, Shilla Saebi, James Dempsey's users, Jon Proulx, Bruno Lago, Chuck Burkett, Dana Bauer, and the original authors (at least 2 each section). Any areas lacking in the guide are well understood and captured in the bug list: https://bugs.launchpad.net/openstack-manuals/+bugs?field.tag=firstapp and there are no major blockers that would prevent listing this guide on developer.openstack.org. This patch links the libcloud section of developer.openstack.org to the guide. Change-Id: If85bc020cd54e3ca06e5d320024dec9428764641
API-Site repository
This repository contains documentation for the OpenStack project.
For more details, see the OpenStack Documentation wiki page.
It includes these pages and PDFs:
- API Quick Start
- API Complete Reference (web pages)
- API Reference PDFs
- API Guide (in progress)
In addition to these, this repository contains:
- developer.openstack.org:
www
Prerequisites
Apache Maven must be installed to build the documentation.
To install Maven 3 for Ubuntu 12.04 and later,and Debian wheezy and later:
apt-get install mavenOn Fedora 20 and later:
yum install mavenBuild and update API docs
For more details about the Gerrit workflow, see Gerrit Workflow.
To build and updates any of the API documents:
Open a Terminal window.
Change into a directory where you want to clone api-site.
Run this command to clone openstack/api-site:
git clone https://github.com/openstack/api-siteCD into the api-site directory.
Run these commands to ensure you have the latest changes:
git remote update git checkout master git pull origin masterTo checkout a new branch:
git checkout -b "*my_branch*"Otherwise, to checkout an existing review:
git review -d change-number /* where change-number is the change number of the reviewMake your changes.
Run this command to build the docs locally:
mvn clean generate-sourcesTo check in your changes, see Gerrit Workflow.
The root of the generated HTML (API site) documentation is:
api-site/api-ref/target/docbkx/html/api-ref.htmlThe root of the generated API guide (in progress) is:
api-site/api-guide/target/docbkx/webhelp/api-guide/index.htmlThe generated PDFs for the API pages are at:
api-site/api-ref-guides/target/docbkx/pdf/*.pdfThe root of the API quick start is at:
api-site/api-quick-start/target/docbkx/webhelp/api-quick-start-onepager-external/api-quick-start-onepager.pdf
Run tests
Install the python tox package and run tox from the
top-level directory to use the same tests that are done as part of our
Jenkins gating jobs.
If you like to run individual tests, run:
tox -e checkniceness- to run the niceness teststox -e checksyntax- to run syntax checkstox -e checkdeletions- to check that no deleted files are referencedtox -e checkbuild- to actually build the manual
tox will use the openstack-doc-tools package for execution of these tests. openstack-doc-tools has a requirement on maven for the build check.
Contribute
Our community welcomes all people interested in open source cloud computing, and encourages you to join the OpenStack Foundation.
The best way to get involved with the community is to talk with
others online or at a meetup and offer contributions through our
processes, the OpenStack wiki,
blogs, or on IRC at #openstack on
irc.freenode.net.
We welcome all types of contributions, from blueprint designs to documentation to testing to deployment scripts.
If you would like to contribute to the documents, please see the Documentation HowTo.
Bugs
Bugs should be filed on Launchpad, and not GitHub:
Install
See OpenStack to learn more about the OpenStack project.