diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 5dc7002a..97b5938b 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -39,8 +39,8 @@ Familiarize yourself with how we do coding and documentation in the BigchainDB p * [Install RethinkDB Server](https://rethinkdb.com/docs/install/) * Make sure you have Python 3.4+ (preferably in a virtualenv) -* [Install BigchaindB Server's OS-level dependencies](http://bigchaindb.readthedocs.io/en/latest/appendices/install-os-level-deps.html) -* [Make sure you have the latest Python 3 version of pip and setuptools](http://bigchaindb.readthedocs.io/en/latest/appendices/install-latest-pip.html) +* [Install BigchaindB Server's OS-level dependencies](http://bigchaindb.readthedocs.io/projects/server/en/latest/appendices/install-os-level-deps.html) +* [Make sure you have the latest Python 3 version of pip and setuptools](http://bigchaindb.readthedocs.io/projects/server/en/latest/appendices/install-latest-pip.html) ### Step 3 - Fork bigchaindb on GitHub diff --git a/README.md b/README.md index a766efa7..52d5b336 100644 --- a/README.md +++ b/README.md @@ -2,7 +2,7 @@ [![PyPI](https://img.shields.io/pypi/v/bigchaindb.svg)](https://pypi.python.org/pypi/BigchainDB) [![Travis branch](https://img.shields.io/travis/bigchaindb/bigchaindb/master.svg)](https://travis-ci.org/bigchaindb/bigchaindb) [![Codecov branch](https://img.shields.io/codecov/c/github/bigchaindb/bigchaindb/master.svg)](https://codecov.io/github/bigchaindb/bigchaindb?branch=master) -[![Documentation Status](https://readthedocs.org/projects/bigchaindb/badge/?version=latest)](https://bigchaindb.readthedocs.org/en/latest/) +[![Documentation Status](http://bigchaindb.readthedocs.io/projects/server/en/latest/?badge=latest)](https://bigchaindb.readthedocs.org/projects/server/en/latest/) [![Join the chat at https://gitter.im/bigchaindb/bigchaindb](https://badges.gitter.im/bigchaindb/bigchaindb.svg)](https://gitter.im/bigchaindb/bigchaindb?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge) @@ -15,11 +15,12 @@ We're hiring! [Learn more](https://github.com/bigchaindb/org/blob/master/engjob. ## Get Started with BigchainDB Server -### [Quickstart](http://bigchaindb.readthedocs.io/en/latest/quickstart.html) -### [Set Up & Run a Dev/Test Node](http://bigchaindb.readthedocs.io/en/latest/dev-and-test/setup-run-node.html) -### [Run BigchainDB Server with Docker](http://bigchaindb.readthedocs.io/en/latest/appendices/run-with-docker.html) +### [Quickstart](http://bigchaindb.readthedocs.io/projects/server/en/latest/quickstart.html) +### [Set Up & Run a Dev/Test Node](http://bigchaindb.readthedocs.io/projects/server/en/latest/dev-and-test/setup-run-node.html) +### [Run BigchainDB Server with Docker](http://bigchaindb.readthedocs.io/projects/server/en/latest/appendices/run-with-docker.html) ## Links for Everyone + * [BigchainDB.com](https://www.bigchaindb.com/) - the main BigchainDB website, including newsletter signup * [Whitepaper](https://www.bigchaindb.com/whitepaper/) - outlines the motivations, goals and core algorithms of BigchainDB * [Roadmap](https://github.com/bigchaindb/org/blob/master/ROADMAP.md) @@ -28,7 +29,9 @@ We're hiring! [Learn more](https://github.com/bigchaindb/org/blob/master/engjob. * [Google Group](https://groups.google.com/forum/#!forum/bigchaindb) ## Links for Developers -* [BigchainDB Server Documentation](http://bigchaindb.readthedocs.io/en/latest/) - for developers + +* [BigchainDB Server Documentation](https://bigchaindb.readthedocs.io/projects/server/en/latest/) +* [All BigchainDB Documentation](http://bigchaindb.readthedocs.io/en/latest/) * [CONTRIBUTING.md](CONTRIBUTING.md) - how to contribute * [Community guidelines](CODE_OF_CONDUCT.md) * [Open issues](https://github.com/bigchaindb/bigchaindb/issues) @@ -36,6 +39,7 @@ We're hiring! [Learn more](https://github.com/bigchaindb/org/blob/master/engjob. * [Gitter chatroom](https://gitter.im/bigchaindb/bigchaindb) ## Legal + * [Licenses](LICENSES.md) - open source & open content * [Imprint](https://www.bigchaindb.com/imprint/) * [Contact Us](https://www.bigchaindb.com/contact/) diff --git a/benchmarking-tests/test1/README.md b/benchmarking-tests/test1/README.md index 12d08ce2..fadc2d55 100644 --- a/benchmarking-tests/test1/README.md +++ b/benchmarking-tests/test1/README.md @@ -2,7 +2,7 @@ Measure how many blocks per second are created on the _bigchain_ with a pre filled backlog. -1. Deploy an aws cluster http://bigchaindb.readthedocs.io/en/latest/deploy-on-aws.html +1. Deploy an aws cluster https://bigchaindb.readthedocs.io/projects/server/en/latest/clusters-feds/aws-testing-cluster.html 2. Make a symbolic link to hostlist.py: `ln -s ../deploy-cluster-aws/hostlist.py .` 3. Make a symbolic link to bigchaindb.pem: ```bash diff --git a/bigchaindb/web/views/info.py b/bigchaindb/web/views/info.py index fab7b7db..7f2edb25 100644 --- a/bigchaindb/web/views/info.py +++ b/bigchaindb/web/views/info.py @@ -1,7 +1,7 @@ """This module provides the blueprint for some basic API endpoints. For more information please refer to the documentation on ReadTheDocs: - - https://bigchaindb.readthedocs.io/en/latest/drivers-clients/http-client-server-api.html + - https://bigchaindb.readthedocs.io/projects/server/en/latest/drivers-clients/http-client-server-api.html """ import flask diff --git a/bigchaindb/web/views/transactions.py b/bigchaindb/web/views/transactions.py index e1986d0a..e697d045 100644 --- a/bigchaindb/web/views/transactions.py +++ b/bigchaindb/web/views/transactions.py @@ -1,7 +1,7 @@ """This module provides the blueprint for some basic API endpoints. For more information please refer to the documentation on ReadTheDocs: - - https://bigchaindb.readthedocs.io/en/latest/drivers-clients/http-client-server-api.html + - https://bigchaindb.readthedocs.io/projects/server/en/latest/drivers-clients/http-client-server-api.html """ from flask import current_app, request, Blueprint from flask_restful import Resource, Api diff --git a/docs/source/index.rst b/docs/source/index.rst index 5f95f2dc..b8c1af08 100644 --- a/docs/source/index.rst +++ b/docs/source/index.rst @@ -1,12 +1,10 @@ BigchainDB Server Documentation =============================== -Table of Contents ------------------ - .. toctree:: :maxdepth: 1 + ← Back to All BigchainDB Docs introduction quickstart cloud-deployment-starter-templates/index