Merge pull request #475 from stone-ch/master

add docs of fabric master branch in master branch

README.md

@@ -1,13 +1,12 @@
-# Lab Name
-Fabric Docs CN
+# Fabric Docs CN
 
-# Short Description
-A project to translate the Fabric documentation to Chinese
+A project to translate the Fabric documentation into Chinese
 
 一个将 Fabric 文档翻译为中文的项目
 
 # Scope of Lab
-The purpose of this lab is to translate the Fabric documentation to Chinese. We will use this repository to sync with the latest English version. The proposal for doing this is to compare the changes of latest English doc and the current doc we are working on. And update the source file in a new release base branch. Issues are used to track what to update in the changed docs. Translator can merge/reuse the existing translation to the changed docs and focus on the changed part.
+
+The purpose of this lab is to translate the Fabric documentation into Chinese. We will use this repository to sync with the latest English version. The proposal for doing this is to compare the changes of latest English doc and the current doc we are working on. And update the source file in a new release base branch. Issues are used to track what to update in the changed docs. Translator can merge/reuse the existing translation to the changed docs and focus on the changed part.
 
 该 lab 的目的为将 Fabric 文档翻译为中文。我们将会使用这个仓库来将最新的英文版文档同步到这里。提议这么做是为了将最新的英文文档和我们当前正在工作的文档进行比较。并且在一个新的基于 release 的分支中更新源文件。Issues 被用来跟踪在变动的文档中都哪些内容被更新了。翻译者可以合并/重用已经存在的翻译内容到变动的文档中并且关注于有改动的部分。
 
@@ -20,6 +19,7 @@ The Chinese online documentation is https://hyperledger-fabric-cn.readthedocs.io
 中文文档地址：https://hyperledger-fabric-cn.readthedocs.io/zh/latest/
 
 # Initial Committers - 最初的提交者
+
 * Julien Guo - https://github.com/JulienGuo
 * Jiang Lu - lujjiang@cn.ibm.com
 

docs/Pipfile

@@ -0,0 +1,14 @@
+[[source]]
+name = "pypi"
+url = "https://pypi.org/simple"
+verify_ssl = true
+
+[dev-packages]
+
+[packages]
+sphinx = "*"
+sphinx-rtd-theme = "*"
+recommonmark = "==0.4.0"
+
+[requires]
+python_version = "3.7"

docs/README.md

@@ -44,17 +44,19 @@ the docs on your machine. The following sections cover both options:
 
 You can easily build your own staging repo following these steps:
 
-1. Fork [fabric on github](https://github.com/hyperledger/fabric)
-1. From your fork, go to `settings` in the upper right portion of the screen,
-1. click `Integration & services`,
-1. click `Add service` dropdown,
-1. and scroll down to ReadTheDocs.
-1. Next, go to http://readthedocs.org and sign up for an account. One of the first prompts will offer to link to github. Elect this then,
-1. click import a project,
-1. navigate through the options to your fork (e.g. yourgithubid/fabric),
-1. it will ask for a name for this project. Choose something
-intuitive. Your name will preface the URL and you may want to append `-fabric` to ensure that you can distinguish between this and other docs that you need to create for other projects. So for example:
-`yourgithubid-fabric.readthedocs.io/en/latest`
+1. Go to http://readthedocs.org and sign up for an account.
+2. Create a project.
+   Your username will preface the URL and you may want to append `-fabric` to ensure that you can distinguish between this and other docs that you need to create for other projects. So for example:
+   `yourgithubid-fabric.readthedocs.io/en/latest`.
+3. Click `Admin`, click `Integrations`, click `Add integration`, choose `GitHub incoming webhook`,
+   then click `Add integration`.
+4. Fork [Fabric on GitHub](https://github.com/hyperledger/fabric).
+5. From your fork, go to `Settings` in the upper right portion of the screen.
+6. Click `Webhooks`.
+7. Click `Add webhook`.
+8. Add the ReadTheDocs's URL into `Payload URL`.
+9. Choose `Let me select individual events`:`Pushes`、`Branch or tag creation`、`Branch or tag deletion`.
+10. Click `Add webhook`.
 
 Now anytime you modify or add documentation content to your fork, this
 URL will automatically get updated with your changes!
@@ -65,11 +67,14 @@ Here are the quick steps to achieve this on a local machine without
 depending on ReadTheDocs, starting from the main fabric
 directory. Note: you may need to adjust depending on your OS.
 
+Prereqs:
+ - [Python 3.7](https://wiki.python.org/moin/BeginnersGuide/Download)
+ - [Pipenv](https://docs.pipenv.org/en/latest/#install-pipenv-today)
+
 ```
-sudo pip install Sphinx
-sudo pip install sphinx_rtd_theme
-sudo pip install recommonmark==0.4.0
-cd fabric/docs # Be in this directory. Makefile sits there.
+cd fabric/docs
+pipenv install
+pipenv shell
 make html
 ```
 
@@ -88,4 +93,5 @@ sudo cp -r * /var/www/html/
 
 You can then access the html files at `http://localhost/index.html`.
 
-<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>.
+s