16 Commits

Author SHA1 Message Date
Troy McConaghy
58432807a0 Problem: No link back to Root Docs from Contrib. Docs (#2170)
Solution: Add a link back to the Root Docs from the 'Contributing to BigchainDB' Docs
2018-04-03 12:28:47 +02:00
Troy McConaghy
ec5f66ba4f Problem: Issue #2217 is unresolved (#2169)
* Problem: Some docs still say to run MongoDB w/ replica set

Solution: Update the relevant docs

* Problem: A docs mention of upsert-validator wasn't linked to BEP-3.

Solution: Link that docs mention to BEP-3 on GitHub.
2018-04-03 12:14:36 +02:00
Troy McConaghy
3d1f341c44 Remove accidentally-pasted URL from docs 2018-03-27 16:41:26 +02:00
Troy McConaghy
8ce48f75a1 Renamed 2 files/pages of notes on running a node 2018-03-27 16:38:58 +02:00
Troy McConaghy
75caf76c62 Problem: The order of the dev contrib docs was weird
Solution: Reorder & relabel those pages
2018-03-27 12:02:33 +02:00
Troy McConaghy
4fb963d149 Don't include docs fetched-at-build-time in Git repo 2018-03-27 10:27:27 +02:00
Troy McConaghy
3566c97873 Problem: Docs re contributing needed editing & reorg
Solution: Edit & reorg them
2018-03-27 10:18:51 +02:00
Ahmed Muawia Khan
9be68c972d Problem: standardize docker-compose workflows (#2130)
- Standardize docker-compose workflow
- Change docker-compose version to 2.1
  - why one might ask? because compose version
    3.0 does not support depends on and inherits
    like we want to and is more aimed towards migration to using
    `docker stack`, for our current strategy `2.1` is a better choice.
- change `bdb` service `bigchaindb` service
  - why? Introduced a new proxy service `bdb` which is just a dummy
    `busybox` image.
    - why? because this ensure via healthcheck of bigchaindb that BigchainDB
      has started properly and makes a `curl` to ensure HTTP API server is up
      and running.
      - why? Because we have had scenarios where BigchainDB is not started
        via docker compose and user has to check out the logs to find out what
        the problem might be. This ensure that bigchaindb is up and running.
- Does this change deployment workflow? No.
  - The only thing change is that if you want to run commands inside a bigchaindb
    container e.g. `pytest` now you have to run the following command:
    `docker-compose run --rm --no-deps bigchaindb pytest -v --cov=bigchaindb`
     as opposed to `docker-compose run --rm --no-deps bdb pytest -v --cov=bigchaindb`
- Remove env variable `BIGCHAINDB_START_TENDERMINT`
- Remove TENDERMINT_INTEGRATION.rst and move to the new docs
- Change mdb -> mongodb because the other services were named with
  full name.
- Add example to run specific tests or from a file
- Update config.toml for tendermint to use `bigchaindb` as proxy app
  instead of `bdb`
- Remove `network` directory because it is deprecated
- Add comment about why PYTHONBUFFERED is used
2018-03-21 12:42:43 +01:00
Troy McConaghy
24119a1b73 Problem: Was getting Shared Workspace Protocol from old location
Solution: Get it from new location in bigchaindb/BEPs
2018-03-15 13:44:22 +01:00
Troy McConaghy
c5054e7239 Problem: Unclear how Travis and Codecov get configured
Solution: Document where Travis and Codecov look for configuration settings and setup.
2018-03-14 13:06:52 +01:00
Troy McConaghy
f54090af6d Cleanup 'Ways to Contribute' even more 2018-03-14 01:40:05 +01:00
Troy McConaghy
d4e8f415a1 Add JS and Python style guides to policies 2018-03-14 00:48:10 +01:00
Troy McConaghy
0e29517145 Revisions to: Contributing to BigchainDB (docs) 2018-03-12 14:23:49 +01:00
Troy McConaghy
5283c32abb
Under den Linden -> Unter 2018-03-07 12:40:12 +01:00
Troy McConaghy
9180d00282
codding -> coding 2018-03-07 12:37:08 +01:00
Troy McConaghy
cf53ce8d32 First draft of new docset on Contributing to BigchainDB 2018-03-06 23:55:18 +01:00