Merge pull request #2156 from ttmc/reorder-developer-contrib-process-…

…pages Problem: The order of the dev contrib docs was weird
bigchaindb · Mar 29, 2018 · b4401d2 · b4401d2
2 parents 7f2ed58 + 3d1f341
commit b4401d2
Show file tree

Hide file tree

Showing 4 changed files with 8 additions and 9 deletions.
diff --git a/docs/contributing/source/dev-setup-coding-and-contribution-process/index.rst b/docs/contributing/source/dev-setup-coding-and-contribution-process/index.rst
@@ -4,6 +4,6 @@ Developer Setup, Coding & Contribution Process
 .. toctree::
    :maxdepth: 2
 
-   setup-dev-environment
    write-code
-   vanshdeep-notes
+   run-node-with-docker-compose
+   run-node-as-processes
diff --git a/...d-contribution-process/vanshdeep-notes.md → ...ribution-process/run-node-as-processes.md b/...d-contribution-process/vanshdeep-notes.md → ...ribution-process/run-node-as-processes.md
@@ -1,4 +1,4 @@
-# Vanshdeep's Notes on Running a Local Dev Node
+# Notes on Running a Local Dev Node as Processes
 
 The following doc describes how to run a local node for developing BigchainDB Tendermint version.
 

diff --git a/...ribution-process/setup-dev-environment.md → ...n-process/run-node-with-docker-compose.md b/...ribution-process/setup-dev-environment.md → ...n-process/run-node-with-docker-compose.md
@@ -1,9 +1,7 @@
-# Setup development environment
+# Notes on Running a Local Dev Node with Docker Compose
 
 ## Setting up a single node development environment with ``docker-compose``
 
-You can also use [Docker Compose](https://docs.docker.com/compose/) to run all the tests.
-
 ```bash
 $ docker-compose build bigchaindb
 $ docker-compose up -d bdb

diff --git a/docs/contributing/source/dev-setup-coding-and-contribution-process/write-code.rst b/docs/contributing/source/dev-setup-coding-and-contribution-process/write-code.rst
@@ -100,10 +100,11 @@ Most tests are in the ``tests/`` folder. Take a look around.
 Running a Local Node for Dev and Test
 -------------------------------------
 
-This is tricky and personal. Different people do it different ways. We documented some of those on separate pages.
+This is tricky and personal. Different people do it different ways. We documented some of those on separate pages:
 
-- `Vanshdeep's notes on dev node setup and running all tests locally <vanshdeep-notes.html>`_
-- More to come? (Potentially: using Docker Compose, Kubernetes and Minikube, or Ansible.)
+- `Dev node setup and running all tests with Docker Compose <setup-dev-environment.html>`_
+- `Dev node setup and running all tests as processes <run-node-as-processes.html>`_
+- More to come?
 
 
 Create the PR on GitHub