From 6c818828990642d612ea0c6db434ed1286a086e2 Mon Sep 17 00:00:00 2001 From: troymc Date: Mon, 8 Aug 2016 15:56:30 +0200 Subject: [PATCH] docs: moved CLI docs to new reference section --- docs/source/nodes/index.rst | 1 - docs/source/nodes/run-with-docker.md | 2 +- docs/source/nodes/setup-run-node.md | 2 +- docs/source/{nodes => server-reference}/bigchaindb-cli.md | 5 ++++- docs/source/server-reference/index.rst | 3 ++- 5 files changed, 8 insertions(+), 5 deletions(-) rename docs/source/{nodes => server-reference}/bigchaindb-cli.md (89%) diff --git a/docs/source/nodes/index.rst b/docs/source/nodes/index.rst index 0e0861c2..808d6618 100644 --- a/docs/source/nodes/index.rst +++ b/docs/source/nodes/index.rst @@ -12,4 +12,3 @@ BigchainDB Nodes setup-run-node run-with-docker running-unit-tests - bigchaindb-cli diff --git a/docs/source/nodes/run-with-docker.md b/docs/source/nodes/run-with-docker.md index e39766d1..d763e98a 100644 --- a/docs/source/nodes/run-with-docker.md +++ b/docs/source/nodes/run-with-docker.md @@ -96,7 +96,7 @@ docker run --rm -v "$HOME/bigchaindb_docker:/data" -ti \ Note the `--link` option to link to the first container (named `bigchaindb`). -Aside: The `bigchaindb load` command has several options (e.g. `-m`). You can read more about it in [the documentation about the BigchainDB command line interface](bigchaindb-cli.html). +Aside: The `bigchaindb load` command has several options (e.g. `-m`). You can read more about it in [the documentation about the BigchainDB command line interface](../server-reference/bigchaindb-cli.html). If you look at the RethinkDB dashboard (in your web browser), you should see the effects of the load test. You can also see some effects in the Docker logs using: ```text diff --git a/docs/source/nodes/setup-run-node.md b/docs/source/nodes/setup-run-node.md index 478e6a83..d744b5a1 100755 --- a/docs/source/nodes/setup-run-node.md +++ b/docs/source/nodes/setup-run-node.md @@ -161,7 +161,7 @@ Start by creating a default BigchainDB config file: bigchaindb -y configure ``` -(There's documentation for the `bigchaindb` command is in the section on [the BigchainDB Command Line Interface (CLI)](bigchaindb-cli.html).) +(There's documentation for the `bigchaindb` command in the section on [the BigchainDB Command Line Interface (CLI)](../server-reference/bigchaindb-cli.html).) Edit the created config file: diff --git a/docs/source/nodes/bigchaindb-cli.md b/docs/source/server-reference/bigchaindb-cli.md similarity index 89% rename from docs/source/nodes/bigchaindb-cli.md rename to docs/source/server-reference/bigchaindb-cli.md index 0939d04e..ccfad7dd 100644 --- a/docs/source/nodes/bigchaindb-cli.md +++ b/docs/source/server-reference/bigchaindb-cli.md @@ -1,4 +1,7 @@ -# The BigchainDB Command Line Interface (CLI) +# BigchainDB Command Line Interface (CLI) + +**Note: At the time of writing, BigchainDB Server and our BigchainDB client are combined, so the BigchainDB CLI includes some server-specific commands and some client-specific commands (e.g. `bigchaindb load`). Soon, BigchainDB Server will be separate from all BigchainDB clients, and they'll all have different CLIs.** + The command-line command to interact with BigchainDB is `bigchaindb`. diff --git a/docs/source/server-reference/index.rst b/docs/source/server-reference/index.rst index e84419d3..41827c43 100644 --- a/docs/source/server-reference/index.rst +++ b/docs/source/server-reference/index.rst @@ -1,10 +1,11 @@ .. You can adapt this file completely to your liking, but it should at least contain the root `toctree` directive. -BigchainDB Server Reference +BigchainDB Settings and CLI =========================== .. toctree:: :maxdepth: 1 configuration + bigchaindb-cli