From 75caf76c6243bac1cf6eea9d68e787059f31cc0f Mon Sep 17 00:00:00 2001 From: Troy McConaghy Date: Tue, 27 Mar 2018 12:02:33 +0200 Subject: [PATCH] Problem: The order of the dev contrib docs was weird Solution: Reorder & relabel those pages --- .../dev-setup-coding-and-contribution-process/index.rst | 2 +- .../setup-dev-environment.md | 4 +--- .../vanshdeep-notes.md | 2 +- .../write-code.rst | 7 ++++--- 4 files changed, 7 insertions(+), 8 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 index d63915fd..03f27524 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 + setup-dev-environment vanshdeep-notes 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/setup-dev-environment.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/setup-dev-environment.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/vanshdeep-notes.md b/docs/contributing/source/dev-setup-coding-and-contribution-process/vanshdeep-notes.md index db2358e4..5fa1b4ad 100644 --- a/docs/contributing/source/dev-setup-coding-and-contribution-process/vanshdeep-notes.md +++ b/docs/contributing/source/dev-setup-coding-and-contribution-process/vanshdeep-notes.md @@ -1,4 +1,4 @@ -# Vanshdeep's Notes on Running a Local Dev Node +# Vanshdeep's 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/write-code.rst b/docs/contributing/source/dev-setup-coding-and-contribution-process/write-code.rst index 68cf9885..b5113157 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