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 index d63915fd..787753a9 100644 --- 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/docs/contributing/source/dev-setup-coding-and-contribution-process/vanshdeep-notes.md b/docs/contributing/source/dev-setup-coding-and-contribution-process/run-node-as-processes.md similarity index 98% rename from docs/contributing/source/dev-setup-coding-and-contribution-process/vanshdeep-notes.md rename to docs/contributing/source/dev-setup-coding-and-contribution-process/run-node-as-processes.md index db2358e4..21008174 100644 --- a/docs/contributing/source/dev-setup-coding-and-contribution-process/vanshdeep-notes.md +++ b/docs/contributing/source/dev-setup-coding-and-contribution-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/docs/contributing/source/dev-setup-coding-and-contribution-process/setup-dev-environment.md b/docs/contributing/source/dev-setup-coding-and-contribution-process/run-node-with-docker-compose.md similarity index 92% rename from docs/contributing/source/dev-setup-coding-and-contribution-process/setup-dev-environment.md rename to docs/contributing/source/dev-setup-coding-and-contribution-process/run-node-with-docker-compose.md index ce8cb6e5..3a35644d 100644 --- a/docs/contributing/source/dev-setup-coding-and-contribution-process/setup-dev-environment.md +++ b/docs/contributing/source/dev-setup-coding-and-contribution-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 index 68cf9885..a38cf562 100644 --- 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 `_ -- More to come? (Potentially: using Docker Compose, Kubernetes and Minikube, or Ansible.) +- `Dev node setup and running all tests with Docker Compose `_ +- `Dev node setup and running all tests as processes `_ +- More to come? Create the PR on GitHub