34 Commits

Author SHA1 Message Date
Troy McConaghy
e0676306b7 Problem: old page in Appendices is redundant (#2388)
Solution: remove the old Appendices page about installing OS-level dependencies
2018-08-06 11:37:28 +02:00
Muawia Khan
66b243a2b4 Problem: People request all-in-one BigchainDB container (#2424).
Solution: Provide a stand-alone all-in-one BigchainDB container.

* Document it.
* Clarify that the image is not suited for joining a network.
2018-08-02 14:05:23 +02:00
Zachary Bowen
2386ca9d71 Refactor tendermint directory to project root (#2401)
* Problem: core.py contains an unused class, `Bigchain`

Solution: Remove core.py. Refactor BigchainDB Class to remove inheritance from Bigchain.

* Problem: core.py contains an unused class, `Bigchain`

Solution: Remove core.py. Refactor BigchainDB Class to remove inheritance from Bigchain.

* Fixed flake8 complaint about too many blank lines

* Attempting to fix Sphinx docs. This may result in some redundant commits, as I don't know what I'm doing, and I can't experiment without running the CI...

Sorry in advance!

* Attempting to fix Sphinx docs. This may result in some redundant commits, as I don't know what I'm doing, and I can't experiment without running the CI...

Sorry in advance!

* Updating from master changed BigchainDB.process_post_response to a private method, so I had to align with that.

* Fixed a couple stale references to bigchaindb.Bigchain in docstrings

* Missed a reference to `Bigchain` in a patch call...

* Problem: BigchainDB class should be part of project root

Solution: Removed the /tendermint directory and moved its contents to project root

* Problem: Flake8 complained that imports were not at the top of the file

Solution: Had to play around with the order of imports to avoid cyclic dependencies, but its working and style compliant now

* Problem: Stale reference to /tendermint directory in the index

Solution: Removed the references to /tendermint

* Problem: Flake8 complaining of unused import in __init__.py

Solution: The import is there so I can import App directly from bigchaindb, rather than from bigchaindb.core (which I think improves code readability. I added a # noqa to silence Flake8.

* Problem: Stale references to `bigchaindb.tendermint.BigchainDB` in the rst files cause Sphinx to fail

Solution: Updated the autodoc files to use `bigchaindb.BigchainDB` instead

* Problem: Stale reference to the `tendermint` directory in an @patch in a disabled test

Solution: Updated the @patch for completeness

* Problem: BigchainDB class should be part of project root

Solution: Removed the /tendermint directory and moved its contents to project root

* Problem: Flake8 complained that imports were not at the top of the file

Solution: Had to play around with the order of imports to avoid cyclic dependencies, but its working and style compliant now

* Problem: Stale reference to /tendermint directory in the index

Solution: Removed the references to /tendermint

* Problem: Flake8 complaining of unused import in __init__.py

Solution: The import is there so I can import App directly from bigchaindb, rather than from bigchaindb.core (which I think improves code readability. I added a # noqa to silence Flake8.

* Problem: Stale references to `bigchaindb.tendermint.BigchainDB` in the rst files cause Sphinx to fail

Solution: Updated the autodoc files to use `bigchaindb.BigchainDB` instead

* Problem: Stale reference to the `tendermint` directory in an @patch in a disabled test

Solution: Updated the @patch for completeness
2018-07-25 16:59:25 +02:00
Troy McConaghy
1753a7019b Problem: Appendices page 'The Bigchain Class' not Updated for Tendermint (#2330)
* Fixed 2 PEP257 compliance errors

* Upgrade Tendermint to 0.19.7 except for Docker image, which is still at 0.19.2

* In the Appendices, update page re/ The Bigchain Class
2018-06-04 12:19:04 +02:00
Muawia Khan
10e55aa4e7
Problem: No automated way to set up a dev/test network (#2300)
* Problem: No automated way to set up a dev/test network

* Problem: docs not updated for stack, ansible and docker based dev environments

* Problem: Using apt triggers java runtime installation on MacOS

- Update pre_tasks in ansible
- Update bigchaindb-stop playbook to handle pre_tasks

* Update Tendermint version to 0.19.3 from 0.19.2

* Update tendermint version to 0.19.3 everywhere else

* Problem: Sphinx warns about duplicate section labels

Solution: Don't use sphinx.ext.autosectionlabel

* Problem: Sphinx complains that run-node-with-docker not in any TOC

Solution: Add run-node-with-docker to a TOC (i.e. to an index.rst file)

* Tendermint has not tagged `0.19.3` container

* Problem: Internal hyperlinks to new pages not working

Solution: Add .html to the ends of the filename strings

* Problem: Invalid script imports

* Problem: Invalid comparison for supported OS version

* Addressing comments I

* Problem: No way to configure dev/forked repo for developers

* Problem: Docs not updated with STACK_REPO parameter

* Addressing comments II
2018-05-31 16:56:45 +02: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
Troy McConaghy
7f94242f85 Update all docs re/ votes when Tendermint integrated 2018-02-16 16:24:44 +01:00
Troy McConaghy
e0b454953c
Merge branch 'tendermint' into rm-aws-deployment-tools-and-docs 2017-12-06 14:14:04 +01:00
Troy McConaghy
c8e2f59413
Merge pull request #1933 from bigchaindb/docs/1927/remove-azure-quickstart-template-docs
Remove Azure Quickstart Template Docs
2017-12-06 13:56:57 +01:00
Troy McConaghy
b36df932a5 Removed appendices/install-latest-pip.md 2017-12-05 13:47:24 +01:00
Troy McConaghy
c5443dc477 Removed Azure Quickstart Template docs 2017-12-05 11:27:08 +01:00
Troy McConaghy
1a5bb073e3 Remove rethinkdb-backup.md 2017-12-01 15:27:55 +01:00
Troy McConaghy
91dcce1a45 Removed some fully-removeable pages from Appendices 2017-12-01 11:16:35 +01:00
Troy McConaghy
b237a021c6 Removed old AWS testing cluster stuff including docs 2017-11-30 17:50:22 +01:00
Troy McConaghy
f23a2c4042 Removed appendix page w/ tx JSON Schema files & updated transaction-model.rst page 2017-11-23 14:45:23 +01:00
Troy McConaghy
01796b0660
Merge branch 'master' into update-blocks-and-votes-docs 2017-11-16 18:27:08 +01:00
muawiakh
b4ca495967 Remove redundant redirections to different docker installation pages(s)
- All the instructions are common now
- Remove redundant files
- address comments
2017-11-16 12:14:11 +01:00
Troy McConaghy
c6c89bfcba Added page about the transaction schema files 2017-11-15 11:18:07 +01:00
Troy McConaghy
31a0bc846b Updated docs about blocks and votes 2017-11-14 15:51:36 +01:00
muawiakh
f2e1b4ac80 Automation for single node deployment for quickstart
- Change consists of two deployment models:
  - Using Vagrant(single node, with/without docker)
  - Using Ansible(single node, with/without docker)
- Updated quickstart documentation.
- Some WIP comments, which will be addressed later. Depending on the
  requirements.
2017-09-14 14:00:13 +02:00
Troy McConaghy
157e2683de Removed old Terraform & Ansible templates 2017-07-11 11:07:43 +02:00
Troy McConaghy
f807495e92 Moved page re RethinkDB-based AWS testing cluster to Appendices 2017-06-09 10:26:01 +02:00
Troy McConaghy
edbe5deb46 docs: moved old cloud depl. templates to Appendices & edited intros 2017-05-15 15:25:01 +02:00
Krish
df02a77788 Documentation for running BigchainDB in docker containers on mac (#1265)
* Documentation for running bigchaindb docker image on mac
2017-04-13 16:17:18 +02:00
Troy McConaghy
5afc63ac67 Merge pull request #1390 from bigchaindb/remove-consensus-plugin-docs
Made the consensus plugin an undocumented feature
2017-04-13 10:43:31 +02:00
Troy McConaghy
53b4325d01 Merge branch 'master' into update-docs-on-clusters 2017-04-13 10:27:52 +02:00
Troy McConaghy
93baa922c8 Made the consensus plugin an undocumented feature 2017-04-13 09:56:03 +02:00
Troy McConaghy
ad37441115 docs: moved rethinkdb backup notes to appendices 2017-04-12 14:24:11 +02:00
Troy McConaghy
ffc08eaef9 updated docs page 'Set Up and Run a Cluster Node' 2017-04-11 16:29:08 +02:00
Troy McConaghy
22cc47b0c5 Updated docs re: prod node reqs. Moved RethinkDB reqs to Appendices 2017-04-11 14:27:17 +02:00
Sylvain Bellemare
b42264e27e Add commands subpackage documentation 2017-03-22 16:35:24 +01:00
Troy McConaghy
ffb1d7a624 Docs on using special SSH keypair with ACS/Kubernetes 2017-02-27 15:29:49 +01:00
Sylvain Bellemare
d43e77ce4a Add docs for backend 2016-12-12 15:48:48 +01:00
troymc
cd2fd494ac Moved docs directory to docs/server, except README.md 2016-10-27 14:09:24 +02:00