opendev/storyboard
Code Issues Proposed changes

Link development.rst to contributing.rst

Browse Source 
A bit of a reorg combined with adding mention of the install guide
to the contributing doc.

Change-Id: I63678e0b3e2f60831ef28a8695a5c6cebcb087e2
This commit is contained in:
Kendall Nelson 2019-03-22 15:37:23 -07:00
parent 68272b85d4
commit 62309ed2e8
5 changed files with 16 additions and 13 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

9
doc/source/contributing.rst → doc/source/contribute/contributing.rst
View File

@ -1,4 +1,4 @@
.. include:: ../../CONTRIBUTING.rst .. include:: ../../../CONTRIBUTING.rst
.. NOTE(dhellmann): The title underline style just below relies on the .. NOTE(dhellmann): The title underline style just below relies on the
existing format of the file included just above. existing format of the file included just above.
@ -108,6 +108,13 @@ timeout to 3 minutes, run::
$ OS_TEST_TIMEOUT=180 tox -e py27 $ 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/ .. _tox: https://tox.readthedocs.io/en/latest/

2
doc/source/install/development.rst → doc/source/contribute/development.rst
View File

@ -1,3 +1,5 @@
.. _development:
======================================= =======================================
Installing and Running for Developers Installing and Running for Developers
======================================= =======================================

4
doc/source/webclient.rst → doc/source/contribute/webclient.rst
View File

@ -5,7 +5,7 @@ Using tox:
---------- ----------
* Run the test suite:: * Run the test suite::
tox -egrunt test tox -egrunt test
@ -28,7 +28,7 @@ Using grunt directly within virtual environment
----------------------------------------------- -----------------------------------------------
* Activate virtual environment:: * Activate virtual environment::
source .tox/grunt/bin/activate source .tox/grunt/bin/activate

12
doc/source/index.rst
View File

@ -42,13 +42,6 @@ Using StoryBoard
Tasks, Stories, & Tags <gui/tasks_stories_tags> Tasks, Stories, & Tags <gui/tasks_stories_tags>
Organizing Your Work: Best Practices <gui/best_practices> Organizing Your Work: Best Practices <gui/best_practices>
Installation guides
-------------------
.. toctree::
:maxdepth: 1
install/development
Maintenance guides Maintenance guides
------------------ ------------------
.. toctree:: .. toctree::
@ -70,8 +63,9 @@ Developer docs
.. toctree:: .. toctree::
:maxdepth: 1 :maxdepth: 1
contributing Running the Tests <contribute/contributing>
webclient Webclient Commands <contribute/webclient>
Installation and Running for Developers <contribute/development>
Extending StoryBoard Extending StoryBoard
-------------------- --------------------

2
doc/source/migration.rst
View File

@ -33,7 +33,7 @@ Test Migration
you are infra-core or Zara or SotK, the best way to do this is to spin 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. 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 I won't go into detail
here on the ins and outs of getting set up. When you have an up-to-date 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 database you'll need to log in via the webclient. Upon successfully logging