openstack
/
keystone
Code Issues Proposed changes

Move development environment setup instructions to standard location 

According to [1], every project should publish instructions for
setting up a development environment to
http://docs.openstack.org/developer/<PROJECT_NAME>/devref/development.environment.html

Keystone's development environment setup instructions are moved
there for consistency.

[1] https://wiki.openstack.org/wiki/Getting_The_Code#Hacking_on_your_laptop_and_running_unit_tests

Change-Id: I084fd0dd9fc4f4ec768649718d86a8ccac990dfd
This commit is contained in:
Brant Knudson 2015-09-23 15:15:21 -05:00
parent f311e7b428
commit a0c531031a
4 changed files with 9 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

11
doc/source/developing.rst
View File

@ -21,10 +21,10 @@ Developing with Keystone
Setup Setup
----- -----
Get your development environment set up according to :doc:`setup`. The Get your development environment set up according to
instructions from here will assume that you have installed Keystone into a :doc:`devref/development.environment`. The instructions from here will assume
virtualenv. If you chose not to, simply exclude "tools/with_venv.sh" from the that you have installed Keystone into a virtualenv. If you chose not to, simply
example commands below. exclude "tools/with_venv.sh" from the example commands below.
Configuring Keystone Configuring Keystone
@ -247,7 +247,8 @@ Running Tests
============= =============
Before running tests, you should have ``tox`` installed and available in your Before running tests, you should have ``tox`` installed and available in your
environment (in addition to the other external dependencies in :doc:`setup`): environment (in addition to the other external dependencies in
:doc:`devref/development.environment`):
.. code-block:: bash .. code-block:: bash

2
doc/source/setup.rst → doc/source/devref/development.environment.rst
View File

@ -167,4 +167,4 @@ You should then be able to `import keystone` using Python without issue:
$ python -c "import keystone" $ python -c "import keystone"
If you can import Keystone without a traceback, you should be ready to move on If you can import Keystone without a traceback, you should be ready to move on
to :doc:`developing`. to :doc:`../developing`.

2
doc/source/index.rst
View File

@ -47,7 +47,7 @@ Getting Started
.. toctree:: .. toctree::
:maxdepth: 1 :maxdepth: 1
setup devref/development.environment
installing installing
configuration configuration
policy_mapping policy_mapping

2
doc/source/installing.rst
View File

@ -21,7 +21,7 @@ Installing Keystone
This document describes how to install Keystone in order to use it. If you are This document describes how to install Keystone in order to use it. If you are
intending to develop on or with Keystone, please read :doc:`developing` and intending to develop on or with Keystone, please read :doc:`developing` and
:doc:`setup`. :doc:`devref/development.environment`.
Installing from Source Installing from Source
---------------------- ----------------------