OpenStack API site

Go to file

Andreas Jaeger 5c9eb70f6f Cleanup py27 support The repo is now building with py3 only, so remove Py27 support. Change-Id: I6e2eb0b0c31c3dff676241570ebe2f1e852dfc0e		2020-04-14 12:11:03 +00:00
tools	Cleanup py27 support	2020-04-14 12:11:03 +00:00
www	Update infra-manual location	2020-03-21 15:19:46 +01:00
.gitignore	Remove firstapp guides	2019-07-17 08:42:50 +00:00
.gitreview	OpenDev Migration Patch	2019-04-19 19:48:21 +00:00
.zuul.yaml	Remove api-quick-start	2019-07-17 10:43:50 +02:00
bindep.txt	Cleanup repo	2019-07-24 18:42:15 +02:00
LICENSE	bug 944097 adding apache license to openstack-manuals repo	2012-03-09 08:37:46 -06:00
README.rst	Update infra-manual location	2020-03-21 15:19:46 +01:00
test-requirements.txt	Cleanup py27 support	2020-04-14 12:11:03 +00:00
tox.ini	Cleanup jobs	2019-08-16 17:00:24 +02:00

README.rst

Team and repository tags

API-Site repository

This repository contains the index page for https://developer.openstack.org in the www directory.

To complete code reviews in this repository, use the standard OpenStack Gerrit workflow. For details, see Gerrit Workflow.

This repository is in a frozen state, it will be fully retired once a new home is found for the index page.

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.

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 publishdocs - Builds all of the documents in this repository, this is called from CI jobs.

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:

Bugs:openstack-api-site

Install

To learn more about the OpenStack project, see OpenStack.

Release Notes

Release notes for the project can be found at:: https://docs.openstack.org/releasenotes/openstack-manuals/