[CE-190] Fix documentation name and links

* Gather all worker node docs with same name format. * Fix several documentation links. Change-Id: I4c364b21ac2b15373111b2c2f71b895592f4ae40 Signed-off-by: Baohua Yang <yangbaohua@gmail.com>
hyperledger-cello · Dec 11, 2017 · 2ec1de4 · 2ec1de4
1 parent 4e013dc
commit 2ec1de4
Show file tree

Hide file tree

Showing 10 changed files with 26 additions and 26 deletions.
diff --git a/docs/awsinstall.md b/docs/awsinstall.md
@@ -26,7 +26,7 @@ The following will show how to deploy Cello on AWS EC2 Ubuntu 14.04 instances.
 
 ## Cello Installation
 
-11. Install docker and docker-compose. Follow the Cello master node setup as given in following document ![here](install.md). In the host, follow the worker node setup as given in link ![here](install.md). Other steps are the same for both master and worker node.
+11. Install docker and docker-compose. Follow the Cello [master node setup](setup_master.md). In the host, follow the [worker node setup](setup_worker_docker.md). Other steps are the same for both master and worker node.
 
 12. Once done, in the master node, you should be able to run the command *docker -H Worker_Node_IP:2375 version*.
 

diff --git a/docs/index.md b/docs/index.md
@@ -9,7 +9,7 @@ Hyperledger Cello provides the following features:
 
 * Manage the lifecycle of blockchain networks (mainly support [Hyperledger fabric](https://github.com/hyperledger/fabric) now), e.g., `create/start/stop/delete/keep health` automatically.
 * Support customized blockchain network, e.g., network size, consensus type.
-* Support multiple underly infrastructure including bare-metal, virtual machine, native [Docker](https://www.docker.com/) host, swarm or [Kubernetes](https://kubernetes.io/). More supports on the way.
+* Support multiple underly infrastructure including bare-metal, virtual machine, native [Docker](https://www.docker.com) host, swarm or [Kubernetes](https://kubernetes.io). More supports on the way.
 * Support heterogeneous architecture, e.g., X86, POWER and Z, from bare-metal servers to virtual machine clouds.
 * Extendable with monitoring, logging, health and analytics capability by integrating with existing tools like [ELK](https://www.elastic.co).
 
@@ -25,23 +25,22 @@ Using Cello, application developers can:
 For new users, it is highly recommended to read the [Tutorial for Beginners](tutorial) first.
 
 ## Operation Guideline
-* [Terminology and Concept](terminology)
-* [Installation](installation)
-* [Adoption Scenarios](scenario)
-* [Configuration for Production](production_config)
-* [Manage Cello services](service_management)
+* [Terminology and Concept](terminology.md)
+* [Start Cello](setup.md)
+* [Adoption Scenarios](scenario.md)
+* [Configuration for Production](production_config.md)
+* [Manage Cello services](service_management.md)
 
 ## Contribute to the Project
-* [How to Contribute](CONTRIBUTING)
-* [Coding Style](code_style)
-* [PEP8 Style Guide](https://www.python.org/dev/peps/pep-0008/)
-* [Develop react js](reactjs)
-* [Develop vue theme](vue/index)
+* [How to Contribute](CONTRIBUTING.md)
+* [Code Style Guide](https://www.python.org/dev/peps/pep-0008/)
+* [Develop react js](reactjs.md)
+* [Develop vue theme](vue/index.md)
 
 ## Design Documentation
-* [Architecture Design](arch)
-* [Database Model](db)
-* [API Design](api/restserver_v2)
+* [Architecture Design](arch.md)
+* [Database Model](db.md)
+* [API Design](api/restserver_v2.md)
 
 ## Communication Channels
 

diff --git a/docs/releases.md → docs/release_note.md b/docs/releases.md → docs/release_note.md
diff --git a/docs/installation.md → docs/setup.md b/docs/installation.md → docs/setup.md
@@ -1,24 +1,25 @@
-# Installation
+# Setup Cello Platform
 
 Cello follows a typical Master-Worker architecture. There are two types of Nodes in the cluster.
 
 * `Master Node`: Holds [Cello services](service_management.md) to manage (e.g., `create/delete`) the chains inside Worker Nodes through Worker's management APIs. Usually, Master Node provides web dashboard (port `8080`) and RESTful APIs (port `80`). It is recommended to use Linux (e.g., Ubuntu 16.04+) or MacOS;
-* `Worker Node`: Nodes to hold blockchains. Cello support several types of `worker node` from single server to cluster. Take `Docker host` or `Swarm cluster` for example, the Docker daemon should be accessible (typically at port `2375`) from the Master Node as the management API.
+* `Worker Node`: Nodes to hold blockchains. Cello support several types of `worker node` from single server to cluster. Take `Docker host` or `Swarm cluster` for example, the Worker's management APIs (i.e., Docker daemon APIs) should be accessible (typically on port `2375`) from the Master Node.
 
 ![Deployment topology](imgs/deploy_arch.png)
 
 ## Master Node
 
-See [Installation on Master Node](installation_master.md).
+See [Setup a Master Node](setup_master.md).
 
 ## Worker Node
 
 Currently we support Docker Host or Swarm Cluster as Worker Node. More types will be added soon.
 
-* `Docker Host`: See [Installation on Worker Docker Node](installation_worker_docker.md).
-* `Docker Swarm `: See [Create a Docker Swarm](https://docs.docker.com/engine/swarm/swarm-tutorial/create-swarm/).
-* `Kubernetes`: See [Kubernetes Setup](https://kubernetes.io/docs/setup/).
-* `vSphere`: TODO.
+* `Docker Host`: [Setup Docker Host as a Worker Node](setup_worker_docker.md).
+* `Docker Swarm `: [Create a Docker Swarm](https://docs.docker.com/engine/swarm/swarm-tutorial/create-swarm/).
+* `Kubernetes`: [Kubernetes Setup](https://kubernetes.io/docs/setup/).
+* `vSphere`: [Setup vSphere as a Worker Node](setup_worker_vsphere.md).
+* `Ansible`: [Setup Ansible as a Worker Node](setup_worker_ansible.md).
 
 ## Special Configuration for Production
 

diff --git a/docs/installation_master.md → docs/setup_master.md b/docs/installation_master.md → docs/setup_master.md
@@ -5,7 +5,7 @@ The [Master Node](./terminology.md) includes several services:
 * `restserver`: Provide RESTful APIs for chain consumers.
 * `watchdog`: Watch for health checking.
 
-*More details can be found at the [architecture doc](./arch.md).*
+*More details can be found at the [Architecture Design](./arch.md).*
 
 ### System Requirement
 

diff --git a/docs/worker_ansible.md → docs/setup_worker_ansible.md b/docs/worker_ansible.md → docs/setup_worker_ansible.md
@@ -66,7 +66,7 @@ Supported ansible versions are 2.3.0.0 or greater.
 
 ### Run fabric network on a single ubuntu server
 
-Please follow instructions in document [ansible worker usage](./worker_ansible_usage.md) to
+Please follow instructions in document [ansible worker usage](setup_worker_ansible_allinone.md) to
 setup fabric network on one clean ubuntu 16.04 server.
 
 ## More Usage

diff --git a/docs/worker_ansible_usage.md → docs/setup_worker_ansible_allinone.md b/docs/worker_ansible_usage.md → docs/setup_worker_ansible_allinone.md
diff --git a/docs/installation_worker_docker.md → docs/setup_worker_docker.md b/docs/installation_worker_docker.md → docs/setup_worker_docker.md
@@ -1,4 +1,4 @@
-## Setup Docker Host as Worker Node
+## Setup Docker Host as a Worker Node
 
 For the Worker Node with meeting the [system requirements](#system-requirements), three steps are required:
 

diff --git a/docs/vsphere.md → docs/setup_worker_vsphere.md b/docs/vsphere.md → docs/setup_worker_vsphere.md
diff --git a/docs/tutorial.md b/docs/tutorial.md
@@ -7,7 +7,7 @@ Have a look at the [terminology](./terminology.md) to understand the basic conce
 
 ## Setup a Cello Cluster
 
-Following the [installation](./installation.md) to setup a Cello cluster.
+Following the [setup steps](./setup.md) to start a Cello cluster.
 
 After that, operators can interact with Cello through dashboard.