openstack
/
api-site
Code Issues Proposed changes
OpenStack API site
4,691 Commits 1 Branch 0 Tags 45 MiB
CSS 74.6%
JavaScript 15.7%
HTML 6.6%
Python 2.6%
Shell 0.5%
Go to file
Flavio Percoco 46b61d4cbd Show team and repo badges on README 
This patch adds the team's and repository's badges to the README file.
The motivation behind this is to communicate the project status and
features at first glance.

For more information about this effort, please read this email thread:

http://lists.openstack.org/pipermail/openstack-dev/2016-October/105562.html

To see an example of how this would look like check:

b'https://gist.github.com/f85631540f7457a0a49eb0d061697d9c\n'

Change-Id: I3d6c847e0d4657c46ce892db7a460cd1f25b81d2
 		2016-11-25 14:40:42 +01:00
api-quick-start Imported Translations from Zanata 2016-11-22 07:45:56 +00:00
api-ref Remove leftover extraneous files in api-ref 2016-09-02 14:45:16 -05:00
common Updated from openstack-manuals 2016-11-23 01:01:25 +00:00
firstapp Remove import unused 2016-10-12 09:52:44 +07:00
tools Add marker file 2016-09-16 09:57:27 +02:00
www Link to translated API Guide 2016-11-15 16:11:58 +00: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
LICENSE bug 944097 adding apache license to openstack-manuals repo 2012-03-09 08:37:46 -06:00
README.rst Show team and repo badges on README 2016-11-25 14:40:42 +01:00
bindep.txt Drop DocBook support, swagger building 2016-08-23 13:20:09 +02:00
doc-tools-check-languages.conf Remove common translations 2016-10-09 18:11:18 +02:00
test-requirements.txt Sync with global requirements 2016-11-10 16:36:36 -05:00
tox.ini Fix de publishing 2016-10-10 09:06:42 +02:00

README.rst

Team and repository tags

image

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.