Skip to content

Commit 810dfbc

Browse files
committed
[CE-296] Documentation typos
Various documentation typo fixes. Change-Id: I02129335f209a293d487a07444d35b3859d50862 Signed-off-by: Chris Lim <yopep@yahoo.com>
1 parent 7799713 commit 810dfbc

File tree

10 files changed

+17
-17
lines changed

10 files changed

+17
-17
lines changed

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ Hyperledger Cello is a blockchain provision and operation system, which helps ma
77
## Introduction
88
Using Cello, everyone can easily:
99

10-
* Build up a Blockchain as a Service (BaaS) platform quickly from the scratch.
10+
* Build up a Blockchain as a Service (BaaS) platform quickly from scratch.
1111
* Provision customizable Blockchains instantly, e.g., a Hyperledger fabric network v1.0.
1212
* Maintain a pool of running blockchain networks on top of baremetals, Virtual Clouds (e.g., virtual machines, vsphere Clouds), Container clusters (e.g., Docker, Swarm, Kubernetes).
1313
* Check the system status, adjust the chain numbers, scale resources... through dashboards.

docs/index.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -15,8 +15,8 @@ Hyperledger Cello provides the following features:
1515

1616
Using Cello, application developers can:
1717

18-
* Build up a Blockchain as a Service (BaaS) platform quickly from the scratch.
19-
* Provision customizable Blockchains instantly, e.g., a Hyperledger fabric v1.0.x network.
18+
* Build up a Blockchain as a Service (BaaS) platform quickly from scratch.
19+
* Provision customizable Blockchains instantly, e.g., a Hyperledger fabric network v1.0.x.
2020
* Maintain a pool of running blockchain networks on top of bare-metals, virtual clouds (e.g., virtual machines, vsphere Clouds), container clusters (e.g., Docker, Swarm, Kubernetes).
2121
* Check the system status, adjust the chain numbers, scale resources... through dashboards.
2222

docs/setup_worker_ansible.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,14 @@
11
# Cello Ansible Worker Node
22

3-
Cello supports to deploy hybperledger fabric onto multiple physical or virtual servers using [ansible](https://ansible.com), and achieve:
3+
Cello supports to deploy hyperledger fabric onto multiple physical or virtual servers using [ansible](https://ansible.com), and achieve:
44

55
- Provision virtual servers to participate in fabric network
66
- Install necessary hyperledger dependent libraries and packages
77
- Setup kubernetes 1.7.0 or overlay network so that containers can communicate cross multiple docker hosts
88
- Install registrator and dns services so that containers can be referenced by name
99
- Build hyperledger fabric artifacts (optional)
1010
- Run hyperledger fabric tests (optional)
11-
- Generate fabric network certificats, genesis block, transaction blocks
11+
- Generate fabric network certificates, genesis block, transaction blocks
1212
- Push new or tagged fabric images onto all docker hosts
1313
- Deploy fabric network
1414
- Join peers to channels, instantiate chaincode

docs/setup_worker_ansible_allinone.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ Please follow the below steps to stand up an all-in-one fabric system
1414
## Install dependencies and clone cello
1515

1616
Use a clean Ubuntu system, login as a user who can do `sudo su` without
17-
prompting password, and run the following comamnds to install necessary
17+
prompting password, and run the following commands to install necessary
1818
dependencies, grant current user docker permissions and clone the cello
1919
project into the current user home directory::
2020

@@ -66,7 +66,7 @@ Create file ~/cello/src/agent/ansible/run/runhosts.tpl with the following conten
6666
$ip
6767

6868
Change your working directory to ~/cello/src/agent/ansible and run the
69-
followng commands to create runhosts file for your environment.
69+
following commands to create runhosts file for your environment.
7070

7171
ipaddr=$(ip -4 addr show | awk -F '/' '/inet / {print $1}' | grep -v '127.0.0.1' | awk -F ' ' '{print $2;exit}')
7272
sed "s/\$ip/$ipaddr/g" run/runhosts.tpl > run/runhosts

docs/setup_worker_docker.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -55,7 +55,7 @@ $ sudo systemctl stop docker.service
5555
$ sudo dockerd -H tcp://0.0.0.0:2375 -H unix:///var/run/docker.sock --api-cors-header='*' --default-ulimit=nofile=8192:16384 --default-ulimit=nproc=8192:16384 -D &
5656
```
5757

58-
At last, run the follow test at Master node and get OK response, to make sure it can access Worker node successfully.
58+
At last, run the follow test at Master node and get OK response, to make sure it can access the Worker node successfully.
5959

6060
```sh
6161
[Master] $ docker -H Worker_Node_IP:2375 info

docs/terminology.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ The Cello system is suggested to be deployed on multiple servers, at least 1 Mas
77
* `Master` Node: Running Cello services, which will manage the worker nodes.
88
* `Worker` Node: The servers to have blockchains running inside. The worker nodes will be managed by the master node.
99
* `Host`: Host is a resource pool managed by a unique control point, which consists of several compute nodes. Typically it can be a naive Docker host, a Swarm cluster or other bare-metal/virtual/container clusters.
10-
* `Chain` (`Cluster`): A blockchain network including numbers of peer nodes. E.g., a Hyperledger Fabric network, a SawthoothLake or Iroha chain.
10+
* `Chain` (`Cluster`): A blockchain network including numbers of peer nodes. E.g., a Hyperledger Fabric network, a Sawthooth Lake or Iroha chain.
1111

1212

1313
## Master

docs/worker_ansible_howto.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@ Ansible agent:
2929
# <a name="setup-ansible-controller"></a>Set up the Ansible controller
3030

3131
You need an Ansible controller to run Ansible playbooks. An Ansible controller
32-
can be any machine (Virtualbox VM, your laptop, AWS instance, etc) that has
32+
can be any machine (VirtualBox VM, your laptop, AWS instance, etc) that has
3333
Ansible 2.3.0.0 or greater installed on it.
3434

3535
1. [Install Ansible](#install-ansible)
@@ -219,7 +219,7 @@ previous step:
219219
The parameter `env` is same as in previous step. The parameter `env_type`
220220
indicates what communication environment you would like to setup. The possible
221221
values for this parameter are `flanneld` and `k8s`. Value `flanneld` is used to
222-
setup a docker swarm like environment. Value `k8s` is to set up a Kuberenetes
222+
setup a docker swarm like environment. Value `k8s` is to set up a Kubernetes
223223
environment.
224224

225225
To remove everything this step created, run the following command:
@@ -467,7 +467,7 @@ reject the ssh connection from Ansible controller.
467467
## <a name="ccac"></a>Convenient configurations and commands
468468

469469
At the root directory of the Ansible agent there are set of preconfigured
470-
playbooks, they were developed as convienent sample playbooks for you if you
470+
playbooks, they were developed as a convenient sample playbooks for you if you
471471
mainly work with a particular cloud. Here's a list of these playbooks.
472472

473473
```

src/agent/ansible/roles/cloud_vb/README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ can be used to clone new machines. The image should have both python 2.x and doc
99
already installed. The configuration file is in vars/vb.yml. You should create your
1010
own configuration file by copy and change that file according to your own environment.
1111

12-
To use this role to provision VirtualBxo vms once you create a configuration file like
12+
To use this role to provision VirtualBox vms once you create a configuration file like
1313
vars/vb.yml, and named it myvb.yml, you can run the following command in the root
1414
directory of the project, not in the directory where this file is located::
1515

@@ -27,7 +27,7 @@ Few words about the base image::
2727
The base image should have the ssh user be a sudoer, for example if your ssh user
2828
is called ubuntu, do the following::
2929

30-
echo "ubuntu ALL=(ALL) NOPASSWD: ALL" | sudo tee /etc/sudoers.d/ununtu
30+
echo "ubuntu ALL=(ALL) NOPASSWD: ALL" | sudo tee /etc/sudoers.d/ubuntu
3131

3232
You may also want to disable the daily update which by default is enabled. When
3333
you start a VB instance using the base image, if it starts auto update, your ansible

src/agent/ansible/roles/deploy_compose/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,5 +4,5 @@ run this command::
44

55
ansible-playbook -i run/runhosts -e "mode=apply env=vb1st" setupfabric.yml
66

7-
Make sure that these host machines already up running, run the above
7+
Make sure that these host machines are already up running, run the above
88
command to setup fabric network defined in vars/vb1st.yml file

src/agent/k8s/README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66

77
##This part of Cello deploys **Fabric over Kubernetes**
88
---
9-
Note: This guide assumes that you already have running Kubernetes Cluster with a master and n-minions.
9+
Note: This guide assumes that you already have running Kubernetes Cluster with a master and n-nodes.
1010

1111
###--Steps to Deploy--
1212

@@ -25,7 +25,7 @@ Note: This guide assumes that you already have running Kubernetes Cluster with a
2525
```$ bash prepare-files.sh```
2626
2727
4. Now, Copy "driving-files" directory to all the nodes, i.e.
28-
Master along with all the Minions.
28+
Master along with all the nodes.
2929
3030
5. On Master, run "run.sh"
3131
```$ bash run.sh```

0 commit comments

Comments
 (0)