From fef3a5494c3b9b27cd7bbb2910358af91241f8c5 Mon Sep 17 00:00:00 2001 From: troymc Date: Mon, 22 Feb 2016 11:27:18 +0100 Subject: [PATCH] Added v1 of Glossary --- docs/source/glossary.md | 17 +++++++++++++++++ docs/source/index.rst | 1 + 2 files changed, 18 insertions(+) create mode 100644 docs/source/glossary.md diff --git a/docs/source/glossary.md b/docs/source/glossary.md new file mode 100644 index 00000000..9f8a9a52 --- /dev/null +++ b/docs/source/glossary.md @@ -0,0 +1,17 @@ +# Glossary of Terms + +**BigchaindB client.** A computer that can communicate with a BigchainDB cluster via the BigchainDB client-server API. + +**BigchainDB cluster.** A collection of servers running BigchainDB Server software and communicating with each other via RethinkDB protocols. a BigchainDB cluster contains one logical RethinkDB datastore. + +**Block.** A collection of up to 1000 transactions, plus other things. They get chained together by votes. See [the section on the block model](models.html#the-block-model). + +**Federation.** 1. An organization with members and some kind of governance structure. 2. The BigchainDB cluster owned and operated by a Federation's members. + +**Federation node.** A server running BigchainDB Server software, with permission to communicate with other nodes in a federation. + +**Node.** See _Federation node_. + +**Transaction.** The basic informational unit. A transaction can represent the creation or transfer of a digital asset. See [the section on the transaction model](models.html#the-transaction-model). + +**Vote.** Each federation node in a federation is required to vote on the validity of every block (i.e. whether the block valid or not). A node's vote on a block also includes the id of the block it considers to be the previous block. See [the section on the vote model](models.html#the-vote-model). diff --git a/docs/source/index.rst b/docs/source/index.rst index 6c4726a3..f8ef2a32 100644 --- a/docs/source/index.rst +++ b/docs/source/index.rst @@ -24,6 +24,7 @@ Table of Contents contributing faq release-notes + glossary Indices and Tables