ec4686554e
The Images v1 API is DEPRECATED in the Newton release by commit 63e6dbb1eb006758fbcf7cae83e1d2eacf46b4ab This patch moves the link to the Images v1 api-ref to the 'Deprecated' section of the quick-start landing page. (The dependency noted below marks the Images v1 API as DEPRECATED in the api-ref source.) Change-Id: I1defb2bc5d71c1086335496a7961347f863bc863 Depends-on: Ifa71b6375a63a9ddf182448a78192d6c76ed7fba Partial-bug: #1618495
API-Site repository
This repository contains API documentation for the OpenStack project.
For details, see OpenStack Documentation Contributor Guide, which includes these pages:
- API Quick Start
- API Guide (in progress)
In addition to these documents, this repository contains:
- Landing page for developer.openstack.org:
www- Writing your first OpenStack application tutorial (in progress):
firstapp
The files in the api-ref directory cannot be changed
because they are moving to project repositories.
To complete code reviews in this repository, use the standard OpenStack Gerrit workflow. For details, see Gerrit Workflow.
Prerequisites
To build the documentation locally, you must install Python and Python Tox.
To install Tox for Ubuntu 14.04 or later:
apt-get install python-tox python-dev libxml2-dev libxslt1-devTo build all the documentation after installing Python and Tox:
tox -e docsTo build an individual document, such as the API Guide:
tox -e api-quick-startThe locally-built output files are found in a
publish-docs directory.
"Writing your First OpenStack Application" tutorial
To build the "Writing your first OpenStack application" tutorial, you must install Graphviz.
To install Graphviz for Ubuntu 12.04 or later or Debian 7 ("wheezy") or later:
apt-get install graphvizOn Fedora 22 and later:
dnf install graphvizOn openSUSE:
zypper install graphvizOn Mac OSX with Homebrew installed:
brew install graphvizBuild and update API docs
Refer to the OpenStack Documentation Contributor Guide for more information.
Run tests
To use the same tests that are used as part of our Jenkins gating
jobs, install the Python tox package and run tox from the
top-level directory.
To run individual tests:
tox -e checkniceness- Niceness teststox -e checkbuild- Builds all of the documents in this repository
To run these tests, the Tox package uses the OpenStack doc tools package.
Contribute
Our community welcomes everyone who is 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.
To contribute to the documents, see OpenStack Documentation Contributor Guide.
Bugs
File bugs on Launchpad and not through GitHub:
Install
To learn more about the OpenStack project, see OpenStack.