3da3bfd65f
The point of this change is to ensure that these two docs are in sync and are complete with regards to the descriptions of each method and their request and response parameters: http://api.openstack.org/api-ref-objectstorage.html (API Reference page for Object Storage) http://docs.openstack.org/api/openstack-object-storage/1.0/content/ (API Reference (or spec) for Object Storage) In addition, the current documents don’t describe ACLs, FormPOST, TempURLs, StaticWeb, Bulk Upload, Bulk Delete, the OPTIONS operation (though this is implicit in CORS support) and maybe a couple of other things. These items should be part of the https://review.openstack.org/#/c/64579/ review, which I'm still working on. updated to add {name} for variables in metadata Co-Author: Donagh McCabe Partial-Bug: #1187119 Partial-Bug: #1214139 Change-Id: I82331b1c3cfc5b19f91f7ac1379476e6a9e6806d author: diane fleming |
||
---|---|---|
api-quick-start | ||
api-ref | ||
www | ||
.gitignore | ||
.gitreview | ||
LICENSE | ||
README.rst | ||
pom.xml | ||
test-requirements.txt | ||
tox.ini |
README.rst
API-Site Repository
This repository contains documentation for the OpenStack project.
For more details, see the OpenStack Documentation wiki page.
It includes these manuals:
- API Quick Start
- API Complete Reference
In addition to these, this repository contains:
- api.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 maven
On Fedora 15 and later:
yum install maven3
Building
The manuals are in the api-quick-start
and
api-ref
directories.
To build a specific guide, look for a pom.xml
file
within a subdirectory, then run the mvn
command in that
directory. For example:
cd api-quick-start
mvn clean generate-sources
The generated PDF documentation file is:
api-quick-start/target/docbkx/webhelp/api-quick-start-onepager-external/api-quick-start-onepager.pdf
The root of the generated HTML documentation is:
api-quick-start/target/docbkx/webhelp/api-quick-start-onepager-external/content/index.html
Testing of changes and building of the manual
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 tests *
tox -e checksyntax
- to run syntax checks *
tox -e checkdeletions
- to check that no deleted files are
referenced * tox -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.
Contributing
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, not GitHub:
Installing
Refer to http://docs.openstack.org to see where these documents are published and to learn more about the OpenStack project.