OpenStack API site
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
Andreas Jaeger b04c695b2c Cleanup jobs 1 month ago
tools Cleanup jobs 1 month ago
www Cleanup jobs 1 month ago
.gitignore Remove firstapp guides 2 months ago
.gitreview OpenDev Migration Patch 5 months ago
.zuul.yaml Remove api-quick-start 2 months ago
LICENSE bug 944097 adding apache license to openstack-manuals repo 7 years ago
README.rst Cleanup jobs 1 month ago
bindep.txt Cleanup repo 1 month ago
test-requirements.txt Cleanup repo 1 month ago
tox.ini Cleanup jobs 1 month ago

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/