Skip to content
This repository

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
branch: master

Use --publish for openstack-doc-test

This requires openstack-doc-test 0.11: We now can use --publish for
openstack-doc-test. This replaces --nocreate-index.

Change-Id: I5e255326ef35810504467603a98da691e26a332c
latest commit 85e91f7cf2
Andreas Jaeger ajaeger authored April 19, 2014
Octocat-spinner-32 openstack-identity-api Merge "Fix bad formatting in v3 federation markdown" April 14, 2014
Octocat-spinner-32 tools Remove trailing whitespaces in regular file March 09, 2012
Octocat-spinner-32 .gitignore doc-tools: Ignore build-*.log.gz February 08, 2014
Octocat-spinner-32 .gitreview Add .gitreview config file for gerrit. October 24, 2011
Octocat-spinner-32 README.rst Change package to build docs to correct name April 07, 2014
Octocat-spinner-32 doc-test.conf Set up for publishing via openstack-doc-tools February 14, 2014
Octocat-spinner-32 test-requirements.txt Updated from global requirements April 19, 2014
Octocat-spinner-32 tox.ini Use --publish for openstack-doc-test April 19, 2014
README.rst

Identity Service API

This repository contains the RESTful API information for the OpenStack Identity Service, also known as the Keystone project. The Keystone project provides authentication for OpenStack services, with plans to also provide authorization.

Building v2.0 Docs

Build these docs using the same procedure as documented for the openstack-manuals project: https://github.com/openstack/openstack-manuals

In short, with Maven 3:

cd openstack-identity-api/v2.0
mvn clean generate-sources

Building v3 Docs

The v3 docs require an extra proprocessing to convert the Markdown source into the DocBook format required by the Maven build process. A few extra tools are required for this preprocessing step.

Installing conversion tools on Ubuntu:

apt-get install pandoc xsltproc docbook5-xml

To build the docs:

cd openstack-identity-api/v3 ./preprocess.sh mvn clean generate-sources

Testing of changes and building of the manual

Install the python tox package and run tox from the top-level directory to use the same tests that are done as part of our Jenkins gating jobs.

If you like to run individual tests, run:

  • tox -e checkniceness - to run the niceness tests
  • tox -e checksyntax - to run syntax checks
  • tox -e checkdeletions - to check that no deleted files are referenced
  • tox -e checkbuild - to actually build the manual

tox will use the openstack-doc-tools package for execution of these tests. openstack-doc-tools has a requirement on maven for the build check.

Contributing

Our community welcomes all people interested in open source cloud computing, and there are no formal membership requirements. The best way to join the community is to talk with others online or at a meetup and offer contributions through Launchpad, the OpenStack wiki, or blogs. We welcome all types of contributions, from blueprint designs to documentation to testing to deployment scripts.

Installing

Refer to http://keystone.openstack.org to learn more about installing an OpenStack Identity Service server that can respond to these API commands.

Something went wrong with that request. Please try again.