openstack
/
api-site
Code Issues Proposed changes
OpenStack API site
4,926 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
Andreas Jaeger 8a82b1445a Switch publishing to publish-docs/html 
This allows simplifying the CI jobs.

Depends-On: https://review.opendev.org/676489
Change-Id: If363e5b0f16cd126dd9ddb5e23e4762d9496ef79
 		2019-08-15 06:45:04 +02:00
tools Switch publishing to publish-docs/html 2019-08-15 06:45:04 +02:00
www Regenerate sitemap 2019-07-26 12:19:50 +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
LICENSE bug 944097 adding apache license to openstack-manuals repo 2012-03-09 08:37:46 -06:00
README.rst Cleanup repo 2019-07-24 18:42:15 +02:00
bindep.txt Cleanup repo 2019-07-24 18:42:15 +02:00
test-requirements.txt Cleanup repo 2019-07-24 18:42:15 +02:00
tox.ini Cleanup repo 2019-07-24 18:42:15 +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 checkbuild - Builds all of the documents in this repository

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/