Mirroristas/bigchaindb
2
0
Fork 0
mirror of https://github.com/bigchaindb/bigchaindb.git synced 2024-10-13 13:34:05 +00:00
Code Issues Packages Projects Releases Wiki Activity

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

Browse Source 
Problem: The order of the dev contrib docs was weird
This commit is contained in:
Ahmed Muawia Khan 2018-03-29 12:01:40 +02:00 committed by GitHub
commit b4401d27e4
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
4 changed files with 8 additions and 9 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
docs/contributing/source/dev-setup-coding-and-contribution-process/index.rst
View File

@ -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

2
docs/contributing/source/dev-setup-coding-and-contribution-process/vanshdeep-notes.md → docs/contributing/source/dev-setup-coding-and-contribution-process/run-node-as-processes.md
View File

@ -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.

4
docs/contributing/source/dev-setup-coding-and-contribution-process/setup-dev-environment.md → docs/contributing/source/dev-setup-coding-and-contribution-process/run-node-with-docker-compose.md
View File

@ -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

7
docs/contributing/source/dev-setup-coding-and-contribution-process/write-code.rst
View File

@ -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