[CE-55] Update the documentations

Update docs on installation and also the scripts. Change-Id: I447674564c9088d2f020a3de8a567b7db7d34ca1 Signed-off-by: Baohua Yang <yangbaohua@gmail.com>
hyperledger · Jun 12, 2017 · b496549 · b496549
1 parent ba75c56
commit b496549
Show file tree

Hide file tree

Showing 4 changed files with 54 additions and 53 deletions.
diff --git a/Makefile b/Makefile
@@ -38,8 +38,8 @@ clean: ##@Code Clean tox result
 log: ##@Log tail special service log, Use like "make log service=dashboard"
 	docker-compose logs -f ${service} --tail=100
 
-logs:
-	docker-compose logs -f --tail=100
+logs: ##@Log tail for all service log
+	docker-compose logs -f --tail=200
 
 # Use like "make redeploy service=dashboard"
 redeploy: ##@Service Redeploy single service, Use like "make redeploy service=dashboard"

diff --git a/README.md b/README.md
@@ -1,28 +1,23 @@
 ![Cello](docs/imgs/logo.png)
 
-Blockchain as a Service!
+Cello is a blockchain provision and operational system, which helps provide Blockchain as a Service.
 
-Cello is a blockchain provision and operation system.
+**Note:** This is a **read-only mirror** of the formal [Gerrit](https://gerrit.hyperledger.org/r/#/admin/projects/cello) repository. Find more details at [Cello Wiki](https://wiki.hyperledger.org/projects/cello).
 
-**Note:** This is a **read-only mirror** of the formal [Gerrit](https://gerrit.hyperledger.org/r/#/admin/projects/cello) repository,
-where active development is ongoing. Issue tracking is handled in [Jira](https://jira.hyperledger.org/projects/CE/issues/).
-
-## Incubation Notice
-
-This project is a Hyperledger project in _Incubation_. It was proposed to the community and documented [here](https://docs.google.com/document/d/1E2i5GRqWsIag7KTxjQ_jQdDiWcuikv3KqXeuw7NaceM/edit), and was approved by [Hyperledger TSC at 2017-01-07](https://lists.hyperledger.org/pipermail/hyperledger-tsc/2017-January/000535.html). Information on what _Incubation_ entails can be found in the [Hyperledger Project Lifecycle document](https://goo.gl/4edNRc).
 
+## Introduction
 
-Using Cello, we can:
+Using Cello, everyone can:
 
-* Provision customizable Blockchains instantly, e.g., a 6-node fabric chain using PBFT consensus.
-* Maintain a pool of running blockchains healthy with no manual operations.
+* Provision customizable Blockchains instantly, e.g., a Hyperledger fabric network.
+* Maintain a pool of running blockchains atop of baremetals, vms, Docker Swarm and Kubernetes.
 * Check the system status, scale the chain numbers, change resources... through a dashboard.
 
 ![Typical Scenario](docs/imgs/scenario.png)
 
-You can also find more [scenarios](docs/scenario.md).
+Explore more [scenarios](docs/scenario.md).
 
-## Features
+## Main Features
 
 * Manage the lifecycle of blockchains, e.g., create/delete/keep health automatically.
 * Response nearly instantly, even with hundreds of chains, or nodes.
@@ -33,25 +28,27 @@ You can also find more [scenarios](docs/scenario.md).
 
 ## Documentation
 
-### Tutorials
-* [Tutorial](docs/tutorial.md)
+For new users, it is highly recommended to read the [tutorial](docs/tutorial.md) first.
 
-### Operational Docs
-* [Installation & Deployment](docs/install.md)
-* [Terminologies](docs/terminology.md)
-* [Scenarios](docs/scenario.md)
+### User Docs
+* [Installation Steps](docs/installation.md)
+* [Terminologies List](docs/terminology.md)
+* [Adoption Scenarios](docs/scenario.md)
 * [Production Configuration](docs/production_config.md)
 
 ### Development Docs
 * [How to contribute](docs/CONTRIBUTING.md)
-* We're following [pep8 style guide](https://www.python.org/dev/peps/pep-0008/), [Coding Style](docs/code_style.md)
 * [Architecture Design](docs/arch.md)
 * [Database Model](docs/db.md)
 * [API](api/restserver_v2.md)
 * [Develop react js](docs/reactjs.md)
+* [pep8 style guide](https://www.python.org/dev/peps/pep-0008/), [Coding Style](docs/code_style.md)
 
 ## Why named Cello?
 Can you find anyone better at playing chains? :)
 
+## Incubation Notice
+This project is a Hyperledger project in _Incubation_. It was proposed to the community and documented [here](https://docs.google.com/document/d/1E2i5GRqWsIag7KTxjQ_jQdDiWcuikv3KqXeuw7NaceM/edit), and was approved by [Hyperledger TSC at 2017-01-07](https://lists.hyperledger.org/pipermail/hyperledger-tsc/2017-January/000535.html). Information on what _Incubation_ entails can be found in the [Hyperledger Project Lifecycle document](https://goo.gl/4edNRc).
+
 ## License <a name="license"></a>
 The Hyperledger Cello project uses the [Apache License Version 2.0](LICENSE) software license.
diff --git a/docs/index.md b/docs/index.md
@@ -1,28 +1,23 @@
 ![Cello](docs/imgs/logo.png)
 
-Blockchain as a Service!
+Cello is a blockchain provision and operational system, which helps provide Blockchain as a Service.
 
-Cello is a blockchain provision and operation system.
+**Note:** This is a **read-only mirror** of the formal [Gerrit](https://gerrit.hyperledger.org/r/#/admin/projects/cello) repository. Find more details at [Cello Wiki](https://wiki.hyperledger.org/projects/cello).
 
-**Note:** This is a **read-only mirror** of the formal [Gerrit](https://gerrit.hyperledger.org/r/#/admin/projects/cello) repository,
-where active development is ongoing. Issue tracking is handled in [Jira](https://jira.hyperledger.org/projects/CE/issues/).
-
-## Incubation Notice
-
-This project is a Hyperledger project in _Incubation_. It was proposed to the community and documented [here](https://docs.google.com/document/d/1E2i5GRqWsIag7KTxjQ_jQdDiWcuikv3KqXeuw7NaceM/edit), and was approved by [Hyperledger TSC at 2017-01-07](https://lists.hyperledger.org/pipermail/hyperledger-tsc/2017-January/000535.html). Information on what _Incubation_ entails can be found in the [Hyperledger Project Lifecycle document](https://goo.gl/4edNRc).
 
+## Introduction
 
-Using Cello, we can
+Using Cello, everyone can:
 
-* Provision customizable Blockchains instantly, e.g., a 6-node fabric chain using PBFT consensus.
-* Maintain a pool of running blockchains healthy with no manual operations.
+* Provision customizable Blockchains instantly, e.g., a Hyperledger fabric network.
+* Maintain a pool of running blockchains atop of baremetals, vms, Docker Swarm and Kubernetes.
 * Check the system status, scale the chain numbers, change resources... through a dashboard.
 
 ![Typical Scenario](docs/imgs/scenario.png)
 
-You can also find more [scenarios](docs/scenario.md).
+Explore more [scenarios](docs/scenario.md).
 
-## Features
+## Main Features
 
 * Manage the lifecycle of blockchains, e.g., create/delete/keep health automatically.
 * Response nearly instantly, even with hundreds of chains, or nodes.
@@ -33,25 +28,27 @@ You can also find more [scenarios](docs/scenario.md).
 
 ## Documentation
 
-### Tutorials
-* [Tutorial](docs/tutorial.md)
+For new users, it is highly recommended to read the [tutorial](docs/tutorial.md) first.
 
-### Operational Docs
-* [Installation & Deployment](docs/install.md)
+### User Docs
+* [Installation & Deployment](docs/installation.md)
 * [Terminologies](docs/terminology.md)
-* [Scenarios](docs/scenario.md)
+* [Adoption Scenarios](docs/scenario.md)
 * [Production Configuration](docs/production_config.md)
 
 ### Development Docs
 * [How to contribute](docs/CONTRIBUTING.md)
-* We're following [pep8 style guide](https://www.python.org/dev/peps/pep-0008/), [Coding Style](docs/code_style.md)
 * [Architecture Design](docs/arch.md)
 * [Database Model](docs/db.md)
 * [API](api/restserver_v2.md)
 * [Develop react js](docs/reactjs.md)
+* [pep8 style guide](https://www.python.org/dev/peps/pep-0008/), [Coding Style](docs/code_style.md)
 
 ## Why named Cello?
-Can u find anyone better at playing chains? :)
+Can you find anyone better at playing chains? :)
+
+## Incubation Notice
+This project is a Hyperledger project in _Incubation_. It was proposed to the community and documented [here](https://docs.google.com/document/d/1E2i5GRqWsIag7KTxjQ_jQdDiWcuikv3KqXeuw7NaceM/edit), and was approved by [Hyperledger TSC at 2017-01-07](https://lists.hyperledger.org/pipermail/hyperledger-tsc/2017-January/000535.html). Information on what _Incubation_ entails can be found in the [Hyperledger Project Lifecycle document](https://goo.gl/4edNRc).
 
 ## License <a name="license"></a>
 The Hyperledger Cello project uses the [Apache License Version 2.0](LICENSE) software license.
diff --git a/docs/install.md → docs/installation.md b/docs/install.md → docs/installation.md
@@ -1,10 +1,10 @@
-# Deployment
+# Installation
 
-*Here we describe the deployment setups for development usage. If you want to deploy Cello for production, please also refer to the [Production Configuration](production_config.md).*
+*Here we describe the setups for development usage. If you want to deploy Cello for production, please also refer to the [Production Configuration](production_config.md).*
 
-Cell follows a typical Master-Worker architecture. Hence there will be two types of Nodes.
+Cello follows a typical Master-Worker architecture. Hence there will be two types of Nodes.
 
-* Master Node: Manage (e.g., create/delete) the chains inside Work Nodes, with Web dashboard on port `8080` and RESTful api on port `80`;
+* Master Node: Manage (e.g., create/delete) the chains inside Work Nodes, with Web dashboard listening on port `8080` and RESTful api on port `80`;
 * Worker Node: Chain providers, now support Docker Host or Swarm Cluster. The Docker service should be accessible from port `2375` from the Master Node.
 
 ![Deployment topology](imgs/deployment_topo.png)
@@ -103,7 +103,7 @@ The Master Node includes several services:
 * restserver: Provide RESTful APIs for chain consumers.
 * watchdog: Watch for health checking.
 
-More details can be found at the [architecture doc](docs/arch.md).
+*More details can be found at the [architecture doc](docs/arch.md).*
 
 It can be deployed by in 3 steps.
 
@@ -125,7 +125,7 @@ $ sudo aptitude install git make -y
 $ git clone http://gerrit.hyperledger.org/r/cello && cd cello
 ```
 
-### Docker images pulling
+### Docker Images Pulling
 
 Pull the following images
 
@@ -150,15 +150,18 @@ Make sure there is no error during the setup. Otherwise, please check the log ms
 
 ### Usage
 
-#### Start/Restart
-To (re)start the whole services, please run
+#### Start/Stop/Restart
+To start the whole services, please run
 
 ```sh
-$ make restart
+$ make start
 ```
 
-#### Deploy/Redploy
-To (re)deploy one specific service, e.g., dashboard, please run
+To stop or restart the whole services, run `make stop` or `make restart`.
+
+
+#### Redploy a service
+To redeploy one specific service, e.g., dashboard, please run
 
 ```sh
 $ make redeploy service=dashboard
@@ -187,3 +190,7 @@ By default, it also loads the `config.py` file as the configurations.
 The mongo container will use local `/opt/cello/mongo` directory for persistent storage.
 
 Please keep it safe by backups or using more high-available solutions.
+
+
+*Licensed under Creative Commons Attribution 4.0 International License
+   https://creativecommons.org/licenses/by/4.0/*