From 62309ed2e8c3ff2ab5147b91ec54a40f5ee65bb6 Mon Sep 17 00:00:00 2001
From: Kendall Nelson <kennelson11@gmail.com>
Date: Fri, 22 Mar 2019 15:37:23 -0700
Subject: [PATCH] Link development.rst to contributing.rst
A bit of a reorg combined with adding mention of the install guide
to the contributing doc.
Change-Id: I63678e0b3e2f60831ef28a8695a5c6cebcb087e2
---
doc/source/{ => contribute}/contributing.rst | 9 ++++++++-
doc/source/{install => contribute}/development.rst | 2 ++
doc/source/{ => contribute}/webclient.rst | 4 ++--
doc/source/index.rst | 12 +++---------
doc/source/migration.rst | 2 +-
5 files changed, 16 insertions(+), 13 deletions(-)
rename doc/source/{ => contribute}/contributing.rst (95%)
rename doc/source/{install => contribute}/development.rst (99%)
rename doc/source/{ => contribute}/webclient.rst (98%)
diff --git a/doc/source/contributing.rst b/doc/source/contribute/contributing.rst
similarity index 95%
rename from doc/source/contributing.rst
rename to doc/source/contribute/contributing.rst
index 27faa76f..f6d3716d 100644
--- a/doc/source/contributing.rst
+++ b/doc/source/contribute/contributing.rst
@@ -1,4 +1,4 @@
-.. include:: ../../CONTRIBUTING.rst
+.. include:: ../../../CONTRIBUTING.rst
.. NOTE(dhellmann): The title underline style just below relies on the
existing format of the file included just above.
@@ -108,6 +108,13 @@ timeout to 3 minutes, run::
$ OS_TEST_TIMEOUT=180 tox -e py27
+For More Extensive Testing...
+-------------------------------
+
+To set up your own local storyboard to see how your changes look in the webclient, see
+the :ref:`development`.
+
+
.. _tox: https://tox.readthedocs.io/en/latest/
diff --git a/doc/source/install/development.rst b/doc/source/contribute/development.rst
similarity index 99%
rename from doc/source/install/development.rst
rename to doc/source/contribute/development.rst
index a4da1a2d..0388b218 100644
--- a/doc/source/install/development.rst
+++ b/doc/source/contribute/development.rst
@@ -1,3 +1,5 @@
+.. _development:
+
=======================================
Installing and Running for Developers
=======================================
diff --git a/doc/source/webclient.rst b/doc/source/contribute/webclient.rst
similarity index 98%
rename from doc/source/webclient.rst
rename to doc/source/contribute/webclient.rst
index eab734e6..768b625d 100644
--- a/doc/source/webclient.rst
+++ b/doc/source/contribute/webclient.rst
@@ -5,7 +5,7 @@ Using tox:
----------
* Run the test suite::
-
+
tox -egrunt test
@@ -28,7 +28,7 @@ Using grunt directly within virtual environment
-----------------------------------------------
* Activate virtual environment::
-
+
source .tox/grunt/bin/activate
diff --git a/doc/source/index.rst b/doc/source/index.rst
index e0bdad83..aabb75ea 100644
--- a/doc/source/index.rst
+++ b/doc/source/index.rst
@@ -42,13 +42,6 @@ Using StoryBoard
Tasks, Stories, & Tags <gui/tasks_stories_tags>
Organizing Your Work: Best Practices <gui/best_practices>
-Installation guides
--------------------
-.. toctree::
- :maxdepth: 1
-
- install/development
-
Maintenance guides
------------------
.. toctree::
@@ -70,8 +63,9 @@ Developer docs
.. toctree::
:maxdepth: 1
- contributing
- webclient
+ Running the Tests <contribute/contributing>
+ Webclient Commands <contribute/webclient>
+ Installation and Running for Developers <contribute/development>
Extending StoryBoard
--------------------
diff --git a/doc/source/migration.rst b/doc/source/migration.rst
index 987ed24f..6cb8fa50 100644
--- a/doc/source/migration.rst
+++ b/doc/source/migration.rst
@@ -33,7 +33,7 @@ Test Migration
you are infra-core or Zara or SotK, the best way to do this is to spin
up your own test instance in a VM or somewhere.
- There are instructions on how to do that in :doc:`/install/development`.
+ There are instructions on how to do that in :doc:`/contribute/development`.
I won't go into detail
here on the ins and outs of getting set up. When you have an up-to-date
database you'll need to log in via the webclient. Upon successfully logging