From a0c531031a32db7b9e74874529b9c81b8ed5ac20 Mon Sep 17 00:00:00 2001 From: Brant Knudson Date: Wed, 23 Sep 2015 15:15:21 -0500 Subject: [PATCH] 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//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 --- doc/source/developing.rst | 11 ++++++----- .../{setup.rst => devref/development.environment.rst} | 2 +- doc/source/index.rst | 2 +- doc/source/installing.rst | 2 +- 4 files changed, 9 insertions(+), 8 deletions(-) rename doc/source/{setup.rst => devref/development.environment.rst} (99%) diff --git a/doc/source/developing.rst b/doc/source/developing.rst index 50fed9e53a..c9af3fc513 100644 --- a/doc/source/developing.rst +++ b/doc/source/developing.rst @@ -21,10 +21,10 @@ Developing with Keystone Setup ----- -Get your development environment set up according to :doc:`setup`. The -instructions from here will assume that you have installed Keystone into a -virtualenv. If you chose not to, simply exclude "tools/with_venv.sh" from the -example commands below. +Get your development environment set up according to +:doc:`devref/development.environment`. The instructions from here will assume +that you have installed Keystone into a virtualenv. If you chose not to, simply +exclude "tools/with_venv.sh" from the example commands below. Configuring Keystone @@ -247,7 +247,8 @@ Running Tests ============= 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 diff --git a/doc/source/setup.rst b/doc/source/devref/development.environment.rst similarity index 99% rename from doc/source/setup.rst rename to doc/source/devref/development.environment.rst index d1ce8f4cb5..10f217ba20 100644 --- a/doc/source/setup.rst +++ b/doc/source/devref/development.environment.rst @@ -167,4 +167,4 @@ You should then be able to `import keystone` using Python without issue: $ python -c "import keystone" If you can import Keystone without a traceback, you should be ready to move on -to :doc:`developing`. +to :doc:`../developing`. diff --git a/doc/source/index.rst b/doc/source/index.rst index 511bc89f97..4d314e29db 100644 --- a/doc/source/index.rst +++ b/doc/source/index.rst @@ -47,7 +47,7 @@ Getting Started .. toctree:: :maxdepth: 1 - setup + devref/development.environment installing configuration policy_mapping diff --git a/doc/source/installing.rst b/doc/source/installing.rst index e38663b718..9d30d6685c 100644 --- a/doc/source/installing.rst +++ b/doc/source/installing.rst @@ -21,7 +21,7 @@ Installing Keystone 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 -:doc:`setup`. +:doc:`devref/development.environment`. Installing from Source ----------------------