openstack-attic/identity-api
Code Issues Proposed changes
253 Commits 1 Branch 4 Tags 5.8 MiB
JavaScript 43.7%
XSLT 37.1%
CSS 15.9%
Shell 3.3%
70b7a13782
Go to file
Andreas Jaeger 70b7a13782 Add doc-test.conf 
This is needed for v0.5 of the doc-tools.

blueprint draft-docs-on-docs-draft

Change-Id: I9b26d2b05513a101af1eaa9523888fc5317cb6f7
2014-02-03 20:46:23 +01:00
openstack-identity-api Add xml:ids to resources 2014-02-03 18:47:37 +01:00
tools Remove trailing whitespaces in regular file 2012-03-09 16:14:21 +08:00
.gitignore Ignore publish-docs directory 2014-02-02 17:11:38 +01:00
.gitreview Add .gitreview config file for gerrit. 2011-10-24 11:02:31 -04:00
doc-test.conf Add doc-test.conf 2014-02-03 20:46:23 +01:00
README.rst Fix bullet list format in README.rst 2014-02-02 12:17:14 +01:00
test-requirements.txt Updated from global requirements 2014-01-25 03:30:30 +00:00
tox.ini Setup for openstack-doc-tools 2014-01-07 20:05:14 +01:00

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