Skip to content

Commit

Permalink
Browse files Browse the repository at this point in the history
Moving contributor docs into rst (bug #843056)
- Added "Setting up a development environment" doc
  - Removed related info from pip-requires & project README
- Added "Testing" doc
  - Removed related info from project README
- Also removed contributor doc build info from project README (bug #843056)
- Updated version string to '2012.1-dev'

Change-Id: I58c79acd91dc391e3fa85911d09f74ad54d9d444
  • Loading branch information
dolph committed Oct 28, 2011
1 parent 3c1ae8b commit 043715e
Show file tree
Hide file tree
Showing 9 changed files with 239 additions and 247 deletions.
51 changes: 1 addition & 50 deletions README.md
Expand Up @@ -2,14 +2,9 @@

Keystone is a Python implementation of the [OpenStack](http://www.openstack.org) identity service API.

This project aims to address the current use cases in Swift and Nova which are:

* RESTful token auth for Swift
* Many-to-many relationship between identity and tenant for Nova.

# Documentation

## For new users, deployers, and system administrators
## For users and sysadmins

Learn how to install, configure, manage, and interact with the OpenStack
Identity Service API at the [OpenStack Documentation](http://docs.openstack.org/) site.
Expand Down Expand Up @@ -51,41 +46,6 @@ Having trouble? We'd like to help!
* bin/keystone-service - Provides HTTP API for users
* bin/keystone-manage - Provides command-line interface for managing all aspects of Keystone

By default, configuration parameters are parsed from `etc/keystone.conf`.

## Installing Dependencies

Keystone maintains a list of PyPi dependencies, designed for use by [pip](http://pypi.python.org/pypi/pip).

*However*, your system may need additional dependencies that `pip` (and by extension, PyPi) cannot satisfy.
A list of such dependences is maintained in the `tools/pip-requires` file, and should be installed prior to using `pip`.

You may also need to prefix `pip install` with `sudo`, depending on your environment.

# Describe dependencies (including non-PyPi dependencies)
$ cat tools/pip-requires

# Install all PyPi dependencies (for production, testing, and development)
$ pip install -r tools/pip-requires

## Updating your PYTHONPATH

There are a number of methods for getting Keystone into your PYTHON PATH, the easiest of which is:

# Fake-install the project by symlinking Keystone into your Python site-packages
$ python setup.py develop

You should then be able to `import keystone` from your Python shell without issue:

>>> import keystone
>>>

## Testing Keystone

To run the entire test suite, with test progress shown in realtime, use:

$ ./run_tests.sh --with-progress

## Running Keystone

Starting both Admin and Service API endpoints:
Expand Down Expand Up @@ -114,11 +74,6 @@ Keystone looks in the following location to find a configuration file:

Additional configuration templates are maintained in `keystone/test/etc/` that may be useful as a reference.

## Contributing Changes

Refer to our [Gerrit-Jenkins-Github Workflow](http://wiki.openstack.org/GerritJenkinsGithub).
## Writing Documentation

### Editing and Building the API Developer Guide

Users of the Keystone API are often developers making ReSTful API calls to Keystone. The guide to provide them
Expand All @@ -135,10 +90,6 @@ To build the Developer Guide from source, you need [Maven](http://maven.apache.o

The output will go into the `target` folder (the source is in `src`). Output generated is PDF and webhelp.

### Editing and Building the Contributor Guide

Refer to `doc/README.rst`.

# Additional Information:

## Sample data
Expand Down
19 changes: 13 additions & 6 deletions doc/source/community.rst
Expand Up @@ -14,21 +14,28 @@
License for the specific language governing permissions and limitations
under the License.

================
Getting Involved
================

The Keystone community is a very friendly group and there are places online to join in with the
community. Feel free to ask questions. This document points you to some of the places where you can
communicate with people.

How to Join the Keystone Community
----------------------------------
How to Join the Community
=========================

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 wiki, or blogs. We welcome all types of contributions,
from blueprint designs to documentation to testing to deployment scripts.
and offer contributions through Launchpad_, the wiki_, or blogs. We welcome all types of contributions,
from blueprint designs to documentation to testing to deployment scripts.

.. _Launchpad: https://launchpad.net/keystone
.. _wiki: http://wiki.openstack.org/

Contributing Changes
====================

Contributing Code
-----------------
To contribute tests, docs, code, etc, refer to our `Gerrit-Jenkins-Github Workflow`_.

.. _`Gerrit-Jenkins-Github Workflow`: http://wiki.openstack.org/GerritJenkinsGithub
File renamed without changes.
60 changes: 28 additions & 32 deletions doc/source/index.rst
Expand Up @@ -14,72 +14,68 @@
License for the specific language governing permissions and limitations
under the License.

=========================
Keystone for Contributors
=========================

Keystone is the canonical implementation of `Openstack's Identity API
<https://github.com/openstack/identity-api>`_, which provides authentication,
an OpenStack service catalog, and (soon) authorization services.
Keystone is a cloud identity service written in Python, which provides
authentication, authorization, and an OpenStack service catalog. It
implements `OpenStack's Identity API`_.

This document describes Keystone for contributors of the project, and assumes
that you are already familiar with Keystone from an `end-user perspective`_.

This document describes keystone for contributors of the project.
.. _`OpenStack's Identity API`: https://github.com/openstack/identity-api
.. _`end-user perspective`: http://docs.openstack.org/

Using Keystone
--------------
Getting Started
===============

.. toctree::
:maxdepth: 1

installing
configuring
usingkeystone
setup
testing
configuration
community

Configuration File Examples
---------------------------
API Use Case Examples
=====================

.. toctree::
:maxdepth: 1

nova-api-paste
keystone.conf
adminAPI_curl_examples
serviceAPI_curl_examples

Man Pages
---------
Configuration File Examples
===========================

.. toctree::
:maxdepth: 1

man/keystonemanage.rst
nova-api-paste
keystone.conf

example API usage
-----------------
Man Pages
=========

.. toctree::
:maxdepth: 1

adminAPI_curl_examples
serviceAPI_curl_examples
man/keystonemanage.rst

Developer Docs
--------------
==============

.. toctree::
:maxdepth: 1

architecture
community

.. toctree::
:maxdepth: 1

sourcecode/autoindex

Outstanding Documentation Tasks
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

.. todolist::

Indices and tables
------------------
==================

* :ref:`genindex`
* :ref:`modindex`
Expand Down
155 changes: 0 additions & 155 deletions doc/source/installing.rst

This file was deleted.

0 comments on commit 043715e

Please sign in to comment.