[CE-81] Update doc and add mkdocs.yml

Make rtd happy and also add the mkdocs.yml to help local building. Change-Id: I2a46c6b776459a9b6bee68b7ab91bc08bf5ab89c Signed-off-by: Baohua Yang <[email protected]>
hyperledger-cello · Jul 11, 2017 · 586d372 · 586d372
1 parent 675be3a
commit 586d372
Show file tree

Hide file tree

Showing 6 changed files with 18 additions and 7 deletions.
diff --git a/Makefile b/Makefile
@@ -39,6 +39,7 @@ endif
 	all \
 	check \
 	clean \
+	doc \
 	log \
 	logs \
 	redeploy \
@@ -56,6 +57,10 @@ check: ##@Code Check code format
 clean: ##@Code Clean tox result
 	rm -rf .tox
 
+doc: ##@Create local online documentation
+	pip install mkdocs
+	mkdocs serve
+
 # Use like "make log service=dashboard"
 log: ##@Log tail special service log, Use like "make log service=dashboard"
 	docker-compose logs -f ${service} --tail=100

diff --git a/README.md b/README.md
@@ -25,7 +25,7 @@ A typical usage scenario is illustrated as:
 ## Documentation, Getting Started and Develop Guideline
 For new users, it is highly recommended to read the [tutorial](docs/tutorial.md) or [index](docs/index.md) first.
 
-And feel free to visit the [online documentation](http://cello.readthedocs.io/en/latest/) for more information.
+And feel free to visit the [online documentation](http://cello.readthedocs.io/en/latest/) for more information. You can also run `make doc` to start a local documentation website (Listen at [localhost:8000](http://127.0.0.1:8000).
 
 ## Why named Cello?
 Can you find anyone better at playing chains? :)

diff --git a/docs/CONTRIBUTING.md b/docs/CONTRIBUTING.md
@@ -1,8 +1,6 @@
 # Contribution
 Any kind of contribution is encouraged, e.g., bug fix and question report.
 
-Before taking actions, we highly recommend reading the [docs](../README.md).
-
 ## LF ID Application
 
 All the tools require an Linux Foundation (LF) ID.

diff --git a/docs/awsinstall.md b/docs/awsinstall.md
@@ -1,6 +1,8 @@
-# Setup of Hyperledger Cello using AWS EC2 Ubuntu 14.04 instances
+# Deploy Hyperledger Cello on AWS EC2
 
-## Steps for creating an AWS instance and Cello setup.
+The following will show how to deploy Cello on AWS EC2 Ubuntu 14.04 instances.
+
+## AWS Setup
 
 1. If you dont have an Amazon AWS account, create one.
 
@@ -22,12 +24,15 @@
 
 10. From terminal, you can ssh into the AWS Ubuntu instance using command- *sudo ssh -i yourprivatekey.pem ubuntu@IP*.
 
+## 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.
 
 12. Once done, in the master node, you should be able to run the command *docker -H Worker_Node_IP:2375 version*.
 
 Example: You should get something like this in the master node-
 
+```bash
 ubuntu@ip-172-31-34-249:~$ docker -H 54.87.59.141:2375 version
 Client:
  Version:      17.03.0-ce
@@ -45,8 +50,9 @@ Server:
  Built:        Tue Feb 28 07:57:58 2017
  OS/Arch:      linux/amd64
  Experimental: false
+```
 
 13. You should be able to open the link *http://MasternodeIP:8080* .You can login and add hosts. Once the hosts are added, you can create blockchains.
 
 
-<a rel="license" href="http://creativecommons.org/licenses/by/4.0/"><img alt="Creative Commons License" style="border-width:0" src="https://i.creativecommons.org/l/by/4.0/88x31.png" /></a><br />This work is licensed under a <a rel="license" href="http://creativecommons.org/licenses/by/4.0/">Creative Commons Attribution 4.0 International License</a>.
+<a rel="license" href="http://creativecommons.org/licenses/by/4.0/"><img alt="Creative Commons License" style="border-width:0" src="https://i.creativecommons.org/l/by/4.0/88x31.png" /></a><br />This work is licensed under a <a rel="license" href="http://creativecommons.org/licenses/by/4.0/">Creative Commons Attribution 4.0 International License</a>.
diff --git a/docs/index.md b/docs/index.md
@@ -23,7 +23,7 @@ A typical usage scenario is illustrated as:
 
 ## Getting Started
 
-For new users, it is highly recommended to read the [tutorial](docs/tutorial.md) first.
+For new users, it is highly recommended to read the [tutorial](docs/tutorial) first.
 
 ## Operational Guideline
 * [Installation Steps](installation)

diff --git a/mkdocs.yml b/mkdocs.yml
@@ -0,0 +1,2 @@
+site_name: Hyperledger Cello Docs
+theme: readthedocs
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1,2 @@
		site_name: Hyperledger Cello Docs
		theme: readthedocs