openstack/api-site
Code Issues Proposed changes
OpenStack API site
4,602 Commits 1 Branch 0 Tags 45 MiB
CSS 74.6%
JavaScript 15.7%
HTML 6.5%
Python 2.6%
Shell 0.6%
25e94f7291
Go to file
OpenStack Proposal Bot 25e94f7291 Imported Translations from Zanata 
For more information about this automatic import see:
https://wiki.openstack.org/wiki/Translations/Infrastructure

Change-Id: I652f960df2f38b6b9e5b983365189813e3307a09
2016-09-02 08:56:24 +00:00
api-quick-start Imported Translations from Zanata 2016-09-02 08:56:24 +00:00
api-ref Deletes content in the api-ref directory, README remains 2016-08-31 13:24:03 -05:00
common Updated from openstack-manuals 2016-08-31 19:07:48 +00:00
firstapp Follow rename of app_support 2016-08-04 14:09:30 +02:00
tools Drop DocBook support, swagger building 2016-08-23 13:20:09 +02:00
www Removes Object Storage files and adds redirect 2016-08-21 19:55:11 +02:00
.gitignore Adds build script for Swagger JSON conversion 2016-02-05 15:21:33 -05:00
.gitreview Complete api-site split from openstack-manuals. 2012-09-25 10:20:38 -07:00
bindep.txt Drop DocBook support, swagger building 2016-08-23 13:20:09 +02:00
doc-tools-check-languages.conf Drop DocBook support, swagger building 2016-08-23 13:20:09 +02:00
LICENSE bug 944097 adding apache license to openstack-manuals repo 2012-03-09 08:37:46 -06:00
README.rst Drop DocBook support, swagger building 2016-08-23 13:20:09 +02:00
test-requirements.txt Updates the "API Quick Start" to become a better landing for all API docs 2016-08-31 17:38:29 +00:00
tox.ini Remove obsolete tox environments 2016-08-23 16:52:29 +02:00

README.rst

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-dev

To build all the documentation after installing Python and Tox:

tox -e docs

To build an individual document, such as the API Guide:

tox -e api-quick-start

The 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 graphviz

On Fedora 22 and later:

dnf install graphviz

On openSUSE:

zypper install graphviz

On Mac OSX with Homebrew installed:

brew install graphviz

Build 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 tests
  • tox -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:

https://bugs.launchpad.net/openstack-api-site/

Install

To learn more about the OpenStack project, see OpenStack.