Merge pull request #648 from bigchaindb/relabel-bigchaindb-docs-as-bigchaindb-server

Relabeled docs in this repository as being for BigchainDB Server

README.md

@@ -6,18 +6,18 @@
 [![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)
 
 
-# BigchainDB
+# BigchainDB Server
 
-A scalable blockchain database. [The whitepaper](https://www.bigchaindb.com/whitepaper/) explains what that means.
+BigchainDB is a scalable blockchain database. [The whitepaper](https://www.bigchaindb.com/whitepaper/) explains what that means.
 
 We're hiring! [Learn more](https://github.com/bigchaindb/org/blob/master/engjob.md).
 
 
-## Get Started
+## 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 with Docker](http://bigchaindb.readthedocs.io/en/latest/appendices/run-with-docker.html)
+### [Run BigchainDB Server with Docker](http://bigchaindb.readthedocs.io/en/latest/appendices/run-with-docker.html)
 
 ## Links for Everyone
 * [BigchainDB.com](https://www.bigchaindb.com/) - the main BigchainDB website, including newsletter signup
@@ -28,7 +28,7 @@ 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
-* [Documentation](http://bigchaindb.readthedocs.io/en/latest/) - for developers
+* [BigchainDB Server Documentation](http://bigchaindb.readthedocs.io/en/latest/) - for developers
 * [CONTRIBUTING.md](CONTRIBUTING.md) - how to contribute
 * [Community guidelines](CODE_OF_CONDUCT.md)
 * [Open issues](https://github.com/bigchaindb/bigchaindb/issues)

docs/source/appendices/licenses.md

@@ -1,3 +1,3 @@
 # Licenses
 
-Information about how the BigchainDB code and documentation are licensed can be found in [the LICENSES.md file](https://github.com/bigchaindb/bigchaindb/blob/master/LICENSES.md) (in the root directory of the repository).
+Information about how the BigchainDB Server code and documentation are licensed can be found in [the LICENSES.md file](https://github.com/bigchaindb/bigchaindb/blob/master/LICENSES.md) of the bigchaindb/bigchaindb repository on GitHub.

docs/source/conf.py

@@ -66,7 +66,7 @@ source_suffix = ['.rst', '.md']
 master_doc = 'index'
 
 # General information about the project.
-project = 'BigchainDB'
+project = 'BigchainDB Server'
 copyright = '2016'
 author = 'BigchainDB Contributors'
 
@@ -224,7 +224,7 @@ html_static_path = ['_static']
 #html_search_scorer = 'scorer.js'
 
 # Output file base name for HTML help builder.
-htmlhelp_basename = 'bigchaindbdoc'
+htmlhelp_basename = 'bigchaindb-server-doc'
 
 # -- Options for LaTeX output ---------------------------------------------
 
@@ -246,7 +246,7 @@ latex_elements = {
 # (source start file, target name, title,
 #  author, documentclass [howto, manual, or own class]).
 latex_documents = [
-    (master_doc, 'bigchaindb.tex', 'BigchainDB Documentation',
+    (master_doc, 'bigchaindb-server.tex', 'BigchainDB Server Documentation',
      author, 'manual'),
 ]
 
@@ -276,7 +276,7 @@ latex_documents = [
 # One entry per manual page. List of tuples
 # (source start file, name, description, authors, manual section).
 man_pages = [
-    (master_doc, 'bigchaindb', 'BigchainDB Documentation',
+    (master_doc, 'bigchaindb-server', 'BigchainDB Server Documentation',
      [author], 1)
 ]
 
@@ -290,8 +290,8 @@ man_pages = [
 # (source start file, target name, title, author,
 #  dir menu entry, description, category)
 texinfo_documents = [
-    (master_doc, 'bigchaindb', 'BigchainDB Documentation',
-     author, 'bigchaindb', 'A scalable blockchain database.',
+    (master_doc, 'bigchaindb-server', 'BigchainDB Server Documentation',
+     author, 'bigchaindb-server', 'A scalable blockchain database.',
      'Miscellaneous'),
 ]
 

docs/source/index.rst

@@ -1,5 +1,5 @@
-BigchainDB Documentation
-========================
+BigchainDB Server Documentation
+===============================
 
 Table of Contents
 -----------------

docs/source/introduction.md

@@ -1,5 +1,7 @@
 # Introduction
 
+This is the documentation for BigchainDB Server, the BigchainDB software that one runs on servers (but not on clients).
+
 BigchainDB is a scalable blockchain database. That is, it's a "big data" database with some blockchain characteristics, including [decentralization](topic-guides/decentralized.html), [immutability](topic-guides/immutable.html) and [native support for assets](topic-guides/assets.html).
 
 You can read about the motivations, goals and high-level architecture in the [BigchainDB whitepaper](https://www.bigchaindb.com/whitepaper/).

docs/source/quickstart.md

@@ -26,7 +26,7 @@ E. Install the `bigchaindb` Python package from PyPI:
 sudo pip3 install bigchaindb
 ```
 
-F. Configure and run BigchainDB:
+F. Configure and run BigchainDB Server:
 ```text
 bigchaindb -y configure
 bigchaindb start
@@ -34,4 +34,4 @@ bigchaindb start
 
 That's it!
 
-For now, you can get a good sense of how to work with BigchainDB by going through [the examples in the section on the Python Server API](drivers-clients/python-server-api-examples.html).
+For now, you can get a good sense of how to work with BigchainDB Server by going through [the examples in the section on the Python Server API](drivers-clients/python-server-api-examples.html).

docs/source/release-notes.md

@@ -1,6 +1,6 @@
 # Release Notes
 
-You can find a list of all BigchainDB releases and release notes on GitHub at:
+You can find a list of all BigchainDB Server releases and release notes on GitHub at:
 
 [https://github.com/bigchaindb/bigchaindb/releases](https://github.com/bigchaindb/bigchaindb/releases)