Merge pull request #1996 from rameshthoomu/mkdocs

Fabric docs display using mkdocs and ReadTheDocs #1674

README.md

@@ -1,6 +1,7 @@
 [![Build Status](https://travis-ci.org/hyperledger/fabric.svg?branch=master)](https://travis-ci.org/hyperledger/fabric)
 [![Go Report Card](https://goreportcard.com/badge/github.com/hyperledger/fabric)](https://goreportcard.com/report/github.com/hyperledger/fabric)
 [![GoDoc](https://godoc.org/github.com/hyperledger/fabric?status.svg)](https://godoc.org/github.com/hyperledger/fabric)
+[![Documentation Status](https://readthedocs.org/projects/hyperledger-fabric/badge/?version=latest)](http://hyperledger-fabric.readthedocs.io/en/latest/?badge=latest)
 
 # Incubation Notice
 This project is a Hyperledger project in _Incubation_. It was proposed to the community and documented [here](https://goo.gl/RYQZ5N). Information on what _Incubation_ entails can be found in the [Hyperledger Project Lifecycle document](https://goo.gl/4edNRc).

docs/README.md

@@ -2,11 +2,13 @@
 ## Getting started
 
 Welcome to the Linux Foundation Hyperledger Project documentation README. This page contains: 
+
 - Getting started doc links 
 - Quickstart doc links
 - Table of Contents links to the complete library
 
 If you are new to the project, you can begin by reviewing the following documents:
+
 - [Whitepaper WG](https://github.com/hyperledger/hyperledger/wiki/Whitepaper-WG)
 - [Requirements WG](https://github.com/hyperledger/hyperledger/wiki/Requirements-WG)
 - [Glossary](glossary.md): to understand the terminology that we use throughout the website and project.
@@ -15,6 +17,7 @@ When you are ready to start building applications or to otherwise contribute to
 
 ## Quickstart documentation
 In addition to the <b>Getting started</b> documentation, the following quickstart topics are available:
+
 - [Fabric FAQs](FAQ)
 - [Canonical use cases](biz/usecases.md)
 - [Development environment set-up](dev-setup/devenv.md)

docs/TravisCI_Readme.md

@@ -61,7 +61,7 @@ slack:<Slack account name>:<User Slack Token> ex: slack:openchain:<user slack to
       - other@example.com
     on_success: [always|never|change] # default: change
     on_failure: [always|never|change] # default: always
-  ```
+```
 
 Now you have completed with Travis CI setup process. If you make any changes in your code and push code to remote repository, Travis CI automatically starts the build process and shows you the build results on your notification settings (Slack, email and on GitHub Readme.md).
 
@@ -105,4 +105,4 @@ git commit -m "Ignore build process [ci skip]"
   - Click on `RAW log` link on Travis CI home page.
 
 - Where can I find Behave Container log files?
-  - Click on each container log file link displays bottom of the RAW log file.
+  - Click on each container log file link displays bottom of the RAW log file.

docs/index.md

@@ -0,0 +1,20 @@
+# Hyperledger Fabric
+
+Welcome to the Hyperledger Fabric documentation. <br><br> This Linux Foundation documentation is sourced on GitHub. To contribute to this documentation, simply update the GitHub source files in the following repo, and submit a pull request: <br><br> [![https://github.com/hyperledger/fabric/tree/master/docs](https://github.com/hyperledger/fabric/tree/master/docs)](https://github.com/hyperledger/fabric/tree/master/docs)
+
+**Hyperledger-Fabric Build & Test Status @ Travis Continuous Integration (CI) service**
+
+[![Build Status](https://travis-ci.org/hyperledger/fabric.svg?branch=master)](https://travis-ci.org/hyperledger/fabric)
+
+**Go Report Card of Hyperledger Fabric**
+
+[![Go Report Card](https://goreportcard.com/badge/github.com/hyperledger/fabric)](https://goreportcard.com/report/github.com/hyperledger/fabric)
+
+**Go Doc reference of Hypereldger Fabric**
+
+[![GoDoc](https://godoc.org/github.com/hyperledger/fabric?status.svg)](https://godoc.org/github.com/hyperledger/fabric)
+
+**Hyperledger Fabric Documentation**
+
+[![Documentation Status](https://readthedocs.org/projects/hyperledger-fabric/badge/?version=latest)](http://hyperledger-fabric.readthedocs.io/en/latest/?badge=latest)
+

mkdocs.yml

@@ -0,0 +1,55 @@
+site_name: Hyperledger Fabric
+site_url: http://hyperledger-fabric.readthedocs.io
+theme: readthedocs
+repo_url: https://github.com/hyperledger/fabric
+site_description: 'Welcome to the Hyperledger fabric documentation'
+
+markdown_extensions:
+# Convert ASCII dashes, quotes to HTML entity
+- smarty
+
+pages:
+- HOME: index.md
+- Getting Started: README.md
+- TravisCI Readme: TravisCI_Readme.md
+- Glossary: glossary.md
+- Protocol Spec: protocol-spec.md
+
+- API:
+  - ChainCode APIs: API/ChaincodeAPI.md
+  - CoreAPI: API/CoreAPI.md
+  - MemberServicesAPI: API/MemberServicesAPI.md 
+  - SandboxSetup: API/SandboxSetup.md
+
+- FAQ:
+  - ChainCodeFAQ: FAQ/chaincode_FAQ.md
+  - ConfidentialityFAQ: FAQ/confidentiality_FAQ.md
+  - ConsensusFAQ: FAQ/consensus_FAQ.md
+  - Identity ManagementFAQ: FAQ/identity_management_FAQ.md
+  - UsageFAQ: FAQ/usage_FAQ.md
+
+- Biz:
+  - Usecase: biz/usecases.md
+
+- Dev setup:
+  - CA Setup: dev-setup/ca-setup.md
+  - Devenv: dev-setup/devenv.md
+  - Devnet Setup: dev-setup/devnet-setup.md
+  - Install: dev-setup/install.md
+  - Logging Control: dev-setup/logging-control.md
+
+- Tech:
+  - Application ACL: tech/application-ACL.md
+  - Attributes: tech/attributes.md
+  - Best Practices: tech/best-practices.md
+
+markdown_extensions:
+  - extra
+  - tables
+  - toc
+  - fenced_code
+  - mdx_math:
+      enable_dollar_delimiter: True #for use of inline $..$  
+  - footnotes
+
+copyright: Copyright &copy; 2016 <a href="https://github.com/hyperledger/fabric/blob/master/docs/dev-setup/headers.txt">IBM Corp.</a> <br></br>Contributed to the Hyperledger Project under the Apache Software License 2.0