Qian Min Chen ee8f4b3155 Correct the wrong link url

Since Queens nenamed from Contributor Guide to Documentation
Contributor Guide to distinguish this document from the new
document aimed at all new OpenStack contributors. So this
patch correct the link. Refer to
https://docs.openstack.org/releasenotes/openstack-manuals/queens

Change-Id: I3c9bc403dfcf4c9b6e3ed410256614415ecfc4dc

2018-08-26 22:43:25 +08:00

3.5 KiB

Raw Blame History

Team and repository tags

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

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 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.

3.5 KiB Raw Blame History