fanliang11 · gisbull · Jun 11, 2019 · Jun 11, 2019 · Jun 12, 2019 · Jun 16, 2019
diff --git a/.gitignore b/.gitignore
@@ -195,6 +195,7 @@ ClientBin/
 *.pfx
 *.publishsettings
 node_modules/
+!/node_modules/swagger-ui-dist/
 orleans.codegen.cs
 
 # Since there are multiple workflows, uncomment next line to ignore bower_components
@@ -262,3 +263,9 @@ paket-files/
 __pycache__/
 *.pyc
 
+/src/Surging.Core/Surging.Core.CPlatform/CPlatformResource.en-US.resources
+api/
+_site/
+
+/src/Surging.ApiGateway
+/src/Surging.Services/Surging.Services.Server/Dockerfile
diff --git a/samples/README.md → FETCH_HEAD b/samples/README.md → FETCH_HEAD
diff --git a/README.EN.md b/README.EN.md
@@ -4,7 +4,11 @@
 # surging is a distributed micro service framework that provides high-performance RPC remote service calls, using Zookeeper, Consul as the registration center for surging services, integrating hash, random, polling as a load balancing algorithm, RPC integration using the netty framework, Using asynchronous transmission.
 <br />
 
-Start configuration：
+### Architecture：
+
+<img src="https://github.com/dotnetcore/surging/blob/master/docs/Architecture.png" alt="架构图" />
+
+### Start configuration：
 
  <br/>
 

diff --git a/README.md b/README.md
@@ -1,7 +1,7 @@
 # surging 　　　　　　　　　　　　　　　　　　　　[English](https://github.com/dotnetcore/surging/blob/master/README.EN.md)
 [![Member project of .NET Core Community](https://img.shields.io/badge/member%20project%20of-NCC-9e20c9.svg)](https://github.com/dotnetcore)
 [![GitHub license](https://img.shields.io/badge/license-MIT-blue.svg)](https://mit-license.org/)
-### surging 是一个分布式微服务框架,提供高性能RPC远程服务调用，采用Zookeeper、Consul作为surging服务的注册中心，集成了哈希，随机，轮询，压力最小优先作为负载均衡的算法，RPC集成采用的是netty框架，采用异步传输。
+### surging 是一个分布式微服务框架,提供高性能RPC远程服务调用，采用Zookeeper、Consul作为surging服务的注册中心，集成了哈希，随机，轮询，压力最小优先作为负载均衡的算法，RPC可以选择采用netty或thrift框架，采用异步非阻塞传输。
 
 <br />
 
@@ -18,6 +18,11 @@
 ### 微服务定义
 微服务应该是可以自由组合拆分，对于每个业务都是独立的，针对于业务模块的 CRUD 可以注册为服务，而每个服务都是高度自治的，从开发，部署都是独立，而每个服务只做单一功能，利用领域驱动设计去更好的拆分成粒度更小的模块
 
+### 微服务边界
+微服务是针对业务的松耦合，也是粒度最小的功能业务模块，针对于行业解决方案，集成相应的service host,而针对于业务需要一些中间件来辅助，比如缓存中间件，eventbus中间件（消息中间件），数据储存中间件,而各个服务又可以互相通过rpc进行可靠性通信。
+
+引擎是微服务的容器，而docker 是服务引擎的容器，而利用k8s或rancher可以针对docker集群化管理，可以服务编排弹性扩容，熟知工具，让工具物尽其用。
+
 ### 能做什么
 1.简化的服务调用，通过服务规则的指定，就可以做到服务之间的远程调用，无需其它方式的侵入
 
@@ -39,9 +44,13 @@ docker hub : docker pull serviceengine/surging:版本号
 
 nuget:Install-Package surging -Version  版本号
 
-### surging模块功能
+### 架构图
+
+<img src="https://github.com/dotnetcore/surging/blob/master/docs/Architecture.png" alt="架构图" />
 
-<img src="https://github.com/dotnetcore/surging/blob/master/docs/SurgingFunction.png" alt="surging模块功能" />
+### 调用链
+
+<img src="https://github.com/dotnetcore/surging/blob/master/docs/call-chain.png" alt="链路图" />
 
 ### 配置：
 
@@ -262,11 +271,18 @@ Task.FromResult(new Surging.IModuleServices.Common.Models.UserModel
  .AddClientIntercepted(typeof(CacheProviderInterceptor))
 ```
 
+## 捐赠明细
+
+surging 接受来自社区的捐赠，所有款项将通过 [捐赠明细表](Statement-of-Income-and-Expense.md) 进行公示，接受社区监督。
+
 IDE:Visual Studio 2017 15.5,vscode
 <br/>
 框架：.NET core 2.1
 <br/>
 QQ群：615562965
-* [Demo](https://github.com/billyang/SurgingDemo)
 * [文档](http://docs.dotnet-china.org/surging/)
 * [简单示例](https://github.com/dotnetcore/surging/blob/master/docs/docs.en/INDEX.md)
+
+## 谁在使用
+
+
diff --git a/Statement-of-Income-and-Expense.md b/Statement-of-Income-and-Expense.md
@@ -0,0 +1,64 @@
+# 收支明细表
+
+说明：为保证surging财务公开透明，决定将每一笔捐赠和支出记录于本表，资金由 [fanly](https://github.com/fanliang11) 托管，并且受社区人员监督用于surging的生态发展
+
+
+## 汇总
+
+截止到 2018 年 12 月 28 日：
++ 共获得捐赠 `49` 笔计 `8679.06` 元人民币
++ 暂无支出项
+
+## 明细
+
+| 序号       | 捐赠人       | 时间        |    金额            | 说明               | 留言              | 类型 |
+|------------|:------------:|-------------|--------------------|-------------------|--------------------|-----|
+| 1 | Murphy | 2018-12-19 | 100      | Murphy 个人捐赠   |   这家伙很懒       |获赠 |
+| 2 | 宗国   | 2018-12-19 | 20       | 宗国 个人捐赠     |   这家伙很懒       |获赠 |
+| 3 | 紫能   | 2018-12-19 | 50       | 紫能 个人捐赠    |   这家伙很懒       |获赠 |
+| 4 | Damon  | 2018-12-19 | 18.8     | Damon 个人捐赠    |   支持一下      |获赠 |
+| 5 | 悉路  | 2018-12-19 | 10        | 悉路 个人捐赠    | 感谢作者的付出，希望能完善文档 |获赠 |
+| 6 | jiang  | 2018-12-19 | 16.66      | jiang 个人捐赠    | 这家伙很懒  |获赠 |
+| 7 |  伯锰 z.l  | 2018-12-19 | 20     | 伯锰 z.l  个人捐赠    | 期待1.0  |获赠 |
+| 8 |  匿名 | 2018-12-19 | 5000    | 匿名个人捐赠    |  这家伙很懒  |获赠 |
+| 9 |  爱吃牛排的牛仔 | 2018-12-19 | 66.66   |  爱吃牛排的牛仔个人捐赠    | 这家伙很懒     |获赠 |
+| 10 |  siyue | 2018-12-20 | 50  |  siyue个人捐赠    | 这家伙很懒     |获赠 |
+| 11 |  学飞 | 2018-12-20 | 200  |  学飞个人捐赠    |  还在学习，期待surging越来越好  |获赠 |
+| 12 |  昵称bai | 2018-12-21 | 10  |  昵称bai个人捐赠    | 这家伙很懒 |获赠 |
+| 13 |  半碗的彩霞 | 2018-12-21 | 10  | 半碗的彩霞个人捐赠    | 这家伙很懒 |获赠 |
+| 14 |  虎牙 | 2018-12-21 | 1000  | 虎牙个人捐赠    | 这家伙很懒 |获赠 |
+| 15 |  寸草无心 | 2018-12-21 | 100  | 寸草无心个人捐赠    | 关注surging已有大半年了 默默支持 |获赠 |
+| 16 |  洋 | 2018-12-24 | 1  | 洋个人捐赠    | dotnetty支持websocket了 |获赠 |
+| 17 |  高文 | 2018-12-24 | 10  | 高文个人捐赠    | 庆祝1.0 |获赠 |
+| 18 |  培根 | 2018-12-24 | 36 | 培根个人捐赠    | 捐赠一杯咖啡 |获赠 |
+| 19 |  gesneriana | 2018-12-24 | 26 | gesneriana个人捐赠    | 这家伙很懒 |获赠 |
+| 20 |  学军 | 2018-12-27 | 100 | 学军个人捐赠    | 这家伙很懒  |获赠 |
+| 21 |  高立哲 | 2018-12-27 | 30 | 高立哲个人捐赠    | 这家伙很懒  |获赠 |
+| 22 |  俊文 | 2018-12-27 | 10 | 俊文个人捐赠    | 这家伙很懒  |获赠 |
+| 23 |  根堂 | 2018-12-28 | 100 | 根堂个人捐赠    | 这家伙很懒  |获赠 |
+| 24 |  东周 | 2018-12-28 | 5 | 东周个人捐赠    | 辛苦  |获赠 |
+| 25 |  纯 | 2018-12-28 | 20 | 纯个人捐赠    | 这家伙很懒  |获赠 |
+| 26 |  夏志行 | 2018-12-28 | 88 | 夏志行个人捐赠    | 这家伙很懒  |获赠 |
+| 27 |  勇 | 2018-12-28 | 88.88 | 勇个人捐赠    | 这家伙很懒  |获赠 |
+| 28 |  启旺 | 2018-12-28 | 10 | 勇个人捐赠    | 这家伙很懒  |获赠 |
+| 29 |  雯昌 | 2018-12-28 | 20 | 雯昌个人捐赠    | 支持surging  |获赠 |
+| 30 |  宏伟 | 2018-12-28 | 500 | 宏伟个人捐赠    | 这家伙很懒   |获赠 |
+| 31 |  伟 | 2018-12-28 | 20 | 伟个人捐赠    | 这家伙很懒   |获赠 |
+| 32 |  建 | 2018-12-28 | 10 |建个人捐赠    | 希望大佬搞好文档，在下尽点微薄之力   |获赠 |
+| 33 |  林 | 2018-12-29 | 30 |林个人捐赠    | 这家伙很懒   |获赠 |
+| 34 |  俊强 | 2018-12-29 | 100 | 俊强个人捐赠    | 这家伙很懒   |获赠 |
+| 35 |  彪 | 2018-01-02 | 10 | 彪个人捐赠    | 支持一下surging   |获赠 |
+| 36 |  忠全 | 2018-01-02 | 200 | 忠全个人捐赠    | 学习一下  |获赠 |
+| 37 |  思恒 | 2018-01-03 | 10 | 思恒个人捐赠    | 这家伙很懒   |获赠 |
+| 38 |  松波 | 2018-01-04 | 100 | 松波个人捐赠    | 出精品   |获赠 |
+| 39 |  先鸿 | 2019-01-05 | 30 | 先鸿个人捐赠    | 加油   |获赠 |
+| 40 |  杨坚 | 2019-01-08 | 100 | 杨坚个人捐赠    | 加油，希望surging能形成自己的社区   |获赠 |
+| 41 |  济良 | 2019-01-09 | 10 |  济良个人捐赠    | 这家伙很懒   |获赠 |
+| 42 |  祥 | 2019-01-11 | 36 |  祥个人捐赠    | 支持大佬，希望.net社区越来越好   |获赠 |
+| 43 |  文斌 | 2019-01-14 | 50 |  文斌个人捐赠    | 读书也要交学费，买书起码花点钱  |获赠 |
+| 44 |  笋 | 2019-01-25 | 30 |  笋个人捐赠    | 支持一下  |获赠 |
+| 45 |  Leo | 2019-01-30 | 100 |  Leo个人捐赠    | 支持surging |获赠 |
+| 46 |  文丽 | 2019-02-01 | 20 |  文丽    | 这家伙很懒 |获赠 |
+| 47 |  卫东 | 2019-02-13 | 16 |  卫东    | 这家伙很懒 |获赠 |
+| 48 |  安平 | 2019-02-15 | 30 |  安平    | 支持surging,感谢作者付出. |获赠 |
+| 49 |  MyDAL | 2019-02-19 | 6.66 |  MyDAL    | 支持国人自己的轮子. |获赠 |
diff --git a/docfx.json b/docfx.json
@@ -0,0 +1,83 @@
+{
+  "metadata": [
+  ],
+  "build": {
+    "content": [
+      {
+        "files": [
+          "docs/**.md",
+          "docs/**/toc.yml",
+          "toc.yml",
+          "*.md"
+        ]
+      }
+    ],
+    "resource": [
+      {
+        "files": [
+          "**/images/**"
+        ]
+      }
+    ],
+    "overwrite": [
+      {
+        "files": [
+          "apidoc/**.md"
+        ],
+        "exclude": [
+          "obj/**",
+          "_site/**"
+        ]
+      }
+    ],
+    "dest": "_site",
+    "globalMetadataFiles": [],
+    "fileMetadataFiles": [],
+    "template": [
+      "default"
+    ],
+    "postProcessors": [],
+    "markdownEngineName": "markdig",
+    "noLangKeyword": false,
+    "keepFileLink": false,
+    "cleanupCacheHistory": false,
+    "disableGitFeatures": false
+  }
+//  "pdf": {
+//    "content": [
+//      {
+//        "files": [
+//          "docs/**.md",
+//          "docs/**/toc.yml",
+//          "toc.yml",
+//          "*.md"
+//        ]
+//      }
+//    ],
+//    "resource": [
+//      {
+//        "files": [
+//          "**/images/**"
+//        ],
+//        "exclude": [
+//          "**/bin/**",
+//          "**/obj/**",
+//          "_site_pdf/**"
+//        ]
+//      }
+//    ],
+//    "overwrite": [
+//      {
+//        "files": [
+//          "apidoc/**.md"
+//        ],
+//        "exclude": [
+//          "**/bin/**",
+//          "**/obj/**",
+//          "_site_pdf/**"
+//        ]
+//      }
+//    ],
+//    "dest": "_site_pdf"
+//  }
+}
diff --git a/docs/Architecture.png b/docs/Architecture.png
diff --git a/docs/CONTRIBUTING.md b/docs/CONTRIBUTING.md
@@ -0,0 +1,45 @@
+# Surging文档贡献指南
+
+## docfx的安装与使用
+### 1. 打开`powershell`,使用如下命令安装[Chocolatey](https://chocolatey.org/install)
+```shell
+Set-ExecutionPolicy Bypass -Scope Process -Force; iex ((New-Object System.Net.WebClient).DownloadString('https://chocolatey.org/install.ps1'))
+```
+
+### 2. 安装`docfx`工具
+```shell
+choco install docfx -y
+```
+> **Notes**
+> - 安装完`docfx`之后需要重启`powershell`,才会有`docfx`命令
+
+### 3. `docfx`的使用
+```shell
+# 构建文档
+docfx build
+
+# 构建文档同时本地预览
+docfx build -s
+
+# 本地预览文档
+docfx serve
+```
+> **Notes**
+> - 更多关于`docfx`工具使用教程的请[参考](https://dotnet.github.io/docfx/tutorial/docfx.exe_user_manual.html)
+
+## 如何成为开发者文档贡献者
+我们欢迎所有有能力的开发者为surging社区做出自己的贡献,为surging的发展贡献自己的力量。您可以通过qq群或是issues向作者申请成为文档作者。我们会将文档的贡献者显示在开发者文档相关页面,对所有做出贡献的开发者表示感谢。
+
+## 编写开发者文档
+
+### 1. 新增文档目录
+在[`./docs/toc.yml`](./toc.yml)新增文档目录，并在首页[`./docs/index.md`](./index.md)中创建相关的链接。
+
+### 2. 编写开发者文档
+使用`markdown`编写开发者文档,将文档存放到相关模块的目录下。关于文档写作规范请[参考](https://github.com/ruanyf/document-style-guide)。
+
+### 3. 提交并发起PR
+发起pr后,经作者审核通过,将会合并到主分支。
+
+## 投稿
+欢迎开发者向社区投稿关于surging或是微服务相关的博客,您可以选择同时发表到其他平台,但是必须是原创的。请将相关的博文存放在`./docs/blogs`目录下,并向社区提交`PR`。
diff --git a/docs/blogs/index.md b/docs/blogs/index.md
@@ -0,0 +1,3 @@
+# Surging相关博文
+
+## 欢迎投稿
diff --git a/docs/call-chain.png b/docs/call-chain.png
diff --git a/docs/docs.cn/INDEX.md b/docs/docs.cn/INDEX.md
@@ -1,3 +1,40 @@
-surging is a high-performance microservice framework based on the .NET core language,It was created by an individual and designed for use in the cloud,
-Then add to dotnetcore
+# surging的介绍 　　　　　　　　　　　　　
 
+```
+                                                                                           作者：fanly 校对：fanly
+```
+
+什么是Surging
+
+ surging 是微服务引擎,提供了轻量级，高性能，模块化的RPC请求管道，服务引擎支持http、TCP、WS、Mqtt、UDP、DNS协议，采用了Zookeeper、Consul作为注册中心，集成了哈希，随机，轮询，压力最小优先作为负载均衡的算法，内置了服务治理用来保证可靠性RPC通信
+
+使用surging你可以：
+
+   * 构建Web应用程序，微服务和api网关
+   * 微服务可以部署在docker。可以使用k8s、rancher服务编排弹性扩容
+   * 提供了多协议支持
+   * 支持负载平衡分流压力
+   * 基于.NET Core的跨平台可以在Windows，macOS和Linux上运行;也可以移植到其他操作系统。
+   * 简化的服务调用，通过服务规则的指定，就可以做到服务之间的远程调用，无需其它方式的侵入
+   * 服务自动注册与发现，不需要配置服务提供方地址，注册中心基于ServiceId 或者RoutePath查询服务提供者的地址和元数据，并且能够平滑添加或删除服务提供者。
+   * 软负载均衡及容错机制，通过surging内部负载算法和容错规则的设定，从而达到内部调用的负载和容错
+   * 分布式缓存中间件：通过哈希一致性算法来实现负载，并且有健康检查能够平滑的把不健康的服务从列表中删除
+   * 事件总线：通过对于事件总线的适配可以实现发布订阅交互模式
+   * 容器化持续集成与持续交付 ：通过构建一体化Devops平台,实现项目的自动化构建、部署、测试和发布，从而提高生产环境的可靠性、稳定性、弹性和安全性。
+   * 业务模块化驱动引擎，通过加载指定业务模块，能够更加灵活、高效的部署不同版本的业务功能模块
+
+基于surging微服务的开发人员提供以下好处：
+
+   * 统一构建微服务。
+   * 内置依赖注入，您可以自由组合依赖组件。
+   * 内置服务注册中心。
+   * 内置网关可以统一外部访问和管理。
+   * 轻量级，高性能，模块化的RPC请求管道。
+   * 能够在您自己的进程中托管IIS或自托管。
+   * 可以在.NET Core上运行，能够在Windows，macOS和Linux上构建和运行
+   * 简化繁琐的维护。
+   * 基于github平台的开源。
+   * 支持负载平衡分流压力。
+   * 支持多协议服务主机。
+   * 内置服务化治理。
+   * 支持引用、Nuget Install Package、扫描三种方式来加载组件和业务模块
diff --git a/docs/index.md b/docs/index.md
@@ -0,0 +1,62 @@
+# 关于开发者文档
+
+## 文档简介
+
+## 目录
+- [概述](quick-start/index.md)
+- -  [surging 简介]()
+- -  [版本更新]()
+- [教程]()
+- -  [服务主机如何构建]()
+- - -  [依赖注入服务]()
+- - -  [配置日志组件]()
+- - -  [如何设置成服务提供者]()
+- - -  [启动配置]()
+- - -  [配置文件构建]()
+- -  [协议主机构建]()
+- - - [构建TCP协议服务主机]()
+- - - [构建MQTT协议服务主机]()
+- - - [构建WS协议服务主机]()
+- - - [构建UDP协议服务主机]()
+- - - [构建Http协议服务主机]()
+- - - [构建Dns协议服务主机]()
+- - [如何构建微服务]()
+- - - [微服务规则]()
+- - - [配置routepath]()
+- - - [配置ServiceMetadata]()
+- - - [服务拦截器配置]()
+- - - [配置依赖注入]()
+- - - [如何配置和读取配置项]()
+- - [服务注册发现和服务治理]()
+- - - [consul的注册与发现]()
+- - - [zookeeper的注册与发现]()
+- - - [服务路由的负载均衡]()
+- - - [容错策略]()
+- - - [服务熔断]()
+- - [引擎核心组件]()
+- - - [配置使用Swagger组件]()
+- - - [配置ProtoBuffer、MessagePack或Json.net组件编解码消息]()
+- - - [配置Log4net日志组件]()
+- - - [配置NLog日志组件]()
+- - - [配置Stage关卡组件]()
+- - - [配置扩展SystemModule组件]()
+- - - [配置扩展BusinessModule组件]()
+- - - [配置扩展EnginePartModule组件]()
+- - - [配置扩展KestrelHttpModule组件]()
+- - [中间件]()
+- - - [缓存中间件]()
+- - - [消息中间件]()
+- - [网关]()
+- - - [配置gatewaySettings.json文件]()
+- - - [jwt鉴权]()
+- - - [基于Stage生成的第三方接口网关]()
+- [示例]()
+- -  [缓存中间件使用]()
+- -  [消息中间件使用]()
+- -  [服务之间本地和远程调用]()
+- [部署]()
+- -  [引擎部署到window环境中]()
+- -  [引擎部署到linux环境容器中]()
+- -  [引擎构建镜像push到镜像库]()
+- -  [扫描业务模块组件和中间件装载到引擎中]()
+- -  [基于rancher 服务编排 ]()
diff --git a/docs/quick-start/index.md b/docs/quick-start/index.md