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
3f2d40f670
Merge pull request #2155 from ttmc/clarify-contributing-docs
...
Problem: Docs re contributing needed editing & reorg
2018-03-27 10:34:15 +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
Troy McConaghy
dea76f7c91
Merge pull request #2141 from muawiakh/update-dns-server
...
Problem: Cluster DNS and Health check terminology is incorrect
2018-03-26 16:37:49 +02:00
Ahmed Muawia Khan
a8e68c3706
Replace clusters Web UI to k8s cluster web ui
2018-03-26 16:00:25 +02:00
Ahmed Muawia Khan
339078ae68
Address comments
...
- remove confusion between NODE-IP<->CLUSTER-IP just replace with IP
- remove confusion between node<->cluster just replace with Kubernetes
cluster
2018-03-26 15:37:05 +02:00
Troy McConaghy
ff62675c01
THE blockchain database.
2018-03-24 06:01:12 +01:00
Troy McConaghy
1d053bbad8
Two fixes to root docs home page
...
- Added a button to link to the new "Contributing to BigchainDB" docs
- Changed the opening tag line
2018-03-24 05:40:14 +01:00
vrde
f157096699
Problem: No reason to check the BEP (+typo) ( #2144 )
...
Solution: Say why there is a link to the BEP, and fix a typo.
2018-03-23 14:39:15 +01: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
Ahmed Muawia Khan
cf543d8f41
Problem: docs build failing
...
Solution: Fix docs build
2018-03-21 11:15:25 +01:00
Vanshdeep Singh
ef26220c7f
Problem: Docs for BEP#3 implementation not updated ( #2123 )
...
* Problem: Docs for BEP#3 implementation not updated
Solutions: Update docs for #2070 and #2106
* Problem: 'Validator update' docs language not clear
Solution: Re-write the documentation which explains when validators are updated
* Problem: Typos and BEP reference missing
Solution: Fix typos and add BEP reference
2018-03-21 09:23:08 +01:00
Ahmed Muawia Khan
757b4fc14c
Remove cluster-dns
2018-03-20 19:34:01 +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
Troy McConaghy
81c6975501
Merge pull request #2071 from bigchaindb/text-edits-in-http-api-docs
...
Copy-edited the HTTP API docs
2018-03-05 12:31:56 +01:00
Troy McConaghy
c2fd9e7b7b
Merge pull request #2113 from bigchaindb/rm-stand-alone
...
Problem: The node-on-kubernetes docs aren't just for a "stand-alone" node
2018-03-05 12:28:34 +01:00
Troy McConaghy
6ee8224491
Merge pull request #2112 from bigchaindb/revise-azure-acs-page
...
Problem: User gets error about "Service Principal" when they try to deploy a k8s cluster on Azure
2018-03-05 12:27:44 +01:00
Troy McConaghy
7acdb1a565
Problem: The docs aren't just for a "stand-alone" node
...
Solution: Remove "stand-alone"
2018-03-04 19:34:18 +01:00
Troy McConaghy
5f206acc63
Revised docs re az acs create
2018-03-04 14:36:55 +01:00
Troy McConaghy
95b4647a22
Added instructions for including secret token header in POST requests
2018-03-03 19:15:01 +01:00
Troy McConaghy
74d86cc83e
Add example secret token
2018-03-03 15:02:45 +01:00
Troy McConaghy
2304f8cd10
Revisions to Overview page in prod dep. template
2018-03-03 14:55:31 +01:00
Ahmed Muawia Khan
9cb84b165f
Merge pull request #2093 from muawiakh/migrate-cli-docs
...
Migrate CLI documentation
2018-02-28 14:44:17 +01:00
Ahmed Muawia Khan
4c6ac6bd19
Update production deployment template after v1 automation
2018-02-27 13:26:51 +01:00
Troy McConaghy
3d0720ce42
Revised intro of Overview page in prod dep template docs
2018-02-27 00:37:59 +01:00
Sylvain Bellemare
12f603b8d2
Problem: There are no docs for the tendermint integration API
...
Solution: Add docs for the tendermint integration in Appendices for now.
2018-02-26 16:26:40 +01:00
Ahmed Muawia Khan
7cea7298f0
Update mongodb user configuration
...
- Update docs for azure cluster deployment template
- Update entrypoint for MongoDB to handle user configuration
more efficiently
- remove `use admin` in js file, that is an invalid format
2018-02-26 14:45:21 +01:00
Troy McConaghy
86e7b2a881
Some minor copy-editing
2018-02-25 18:05:18 +01:00
Ahmed Muawia Khan
8e8e328205
Migrate CLI documentation
...
- Remove documentation for CLI commands that are not needed with
Tendermint integration.
2018-02-23 14:53:28 +01:00
Troy McConaghy
497e1039ef
Merge branch 'tendermint' into text-edits-in-http-api-docs
2018-02-22 21:02:33 +01:00
Ahmed Muawia Khan
5669514ee7
Fix label docs
2018-02-21 12:13:45 +01:00
Ahmed Muawia Khan
669b2d586b
Merge branch 'tendermint' into tendermint-docs-k8s-dep
2018-02-21 11:48:02 +01:00
Troy McConaghy
c5fdaf24ad
Fix the requirements.txt file for docs/server, update README.md
2018-02-20 12:58:23 +01:00
Troy McConaghy
5c783be546
Merge branch 'tendermint' into text-edits-in-http-api-docs
2018-02-19 16:45:03 +01:00
Troy McConaghy
e1bdd41030
Copy-edited the HTTP API docs
2018-02-19 16:33:46 +01:00
Troy McConaghy
7f94242f85
Update all docs re/ votes when Tendermint integrated
2018-02-16 16:24:44 +01:00
Troy McConaghy
96f30da875
Merge pull request #2056 from bigchaindb/rm-refs-to-transaction-cli-tool
...
Problem: Transaction CLI Tool deprecated but linked from some docs
2018-02-16 15:28:10 +01:00
Troy McConaghy
6982dfbe79
Put back the accidentally-removed post-tx-response
2018-02-16 14:54:20 +01:00
Troy McConaghy
7c3d7f4f63
Tidy up some grammar and Tendermint refs
2018-02-16 14:53:30 +01:00
Troy McConaghy
0139e53ab4
rm code to gen example HTTP stuff for /statuses & /votes
2018-02-16 14:35:35 +01:00