openstack/api-site
Code Issues Proposed changes
OpenStack API site
4,920 Commits 1 Branch 0 Tags 45 MiB
CSS 74.6%
JavaScript 15.7%
HTML 6.5%
Python 2.6%
Shell 0.6%
4cf72bf7ba
Go to file
Andreas Jaeger 4cf72bf7ba Update links on index.html 
Update for moved API Quick Start, note that Japanese is not translated
anymore and thus got removed.

Update CLI links:
  We do not have these links on docs.o.o anymore, rewrite and add new
  links.

Depends-On: https://review.opendev.org/672250
Change-Id: Ie6352dd20f28bfb3ea8d546ca14ef6af5fd39fe5
2019-07-24 15:00:04 +02:00
api-ref Remove leftover extraneous files in api-ref 2016-09-02 14:45:16 -05:00
tools Remove api-quick-start 2019-07-17 10:43:50 +02:00
www Update links on index.html 2019-07-24 15:00:04 +02: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 Update document links 2017-09-19 20:21:46 -07:00
LICENSE bug 944097 adding apache license to openstack-manuals repo 2012-03-09 08:37:46 -06:00
README.rst Remove firstapp guides 2019-07-17 08:42:50 +00:00
test-requirements.txt Sync Sphinx requirement 2019-06-18 22:22:06 +08:00
tox.ini Remove api-quick-start 2019-07-17 10:43:50 +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

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.

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 linters - 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:

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/