完善5.0 docs

codingapi · xlorne · Sep 1, 2021 · Apr 24, 2020 · May 14, 2020 · May 14, 2020
commit 2ed3f419144434c35e15b456b3a1db80a460e208
diff --git a/_data/docs.yml b/_data/docs.yml
@@ -8,4 +8,22 @@
      - txlcn-background
      - txlcn-start
      - txlcn-dependencies
-     -
+     - txlcn-demo-env
+     - txlcn-demo-dubbo
+     - txlcn-demo-springcloud
+     - txlcn-principle-control
+     - txlcn-principle-lcn
+     - txlcn-principle-tcc
+     - txlcn-principle-txc
+     - txlcn-setting-client
+     - txlcn-setting-distributed
+     - txlcn-setting-manager
+     - txlcn-expansion-message
+     - txlcn-expansion-rpc
+     - txlcn-expansion-transaction
+     - txlcn-communication
+     - txlcn-manageradmin
+     - txlcn-debug
+     - txlcn-test
+     - txlcn-developer
+     - txlcn-fqa
diff --git a/_docs/txlcn/communication.md b/_docs/txlcn/communication.md
@@ -1,4 +1,8 @@
-# 通讯指令手册
+---
+title: 通讯指令手册
+permalink: /docs/txlcn-communication/
+---
+
 
 TxClient 与 TxManager 通讯指令说明文档
 

diff --git a/_docs/txlcn/debug.md b/_docs/txlcn/debug.md
@@ -1,4 +1,7 @@
-# 问题排查手册
+---
+title: 问题排查手册
+permalink: /docs/txlcn-debug/
+---
 
 ## 一、概述
 TxManager 和 TxClient 都支持日志记录到数据库（TXManager默认开启日志记录）。  
@@ -56,4 +59,4 @@ where t_logger.group_id = '99937859659434961' and app_name='spring-demo-d'
 
 
 ### 2、TxManager
-TxManager 提供后台管理服务。[详情](manageradmin.html)
+TxManager 提供后台管理服务。[详情](manageradmin.html)
diff --git a/_docs/txlcn/demo/dubbo.md b/_docs/txlcn/demo/dubbo.md
@@ -1,4 +1,7 @@
-# Dubbo示例
+---
+title: Dubbo示例
+permalink: /docs/txlcn-demo-dubbo/
+---
 
 Dubbo 示例说明  
 共三个模块如下：  

diff --git a/_docs/txlcn/demo/env.md b/_docs/txlcn/demo/env.md
@@ -1,4 +1,8 @@
-# 尝试下简单的分布式事务
+---
+title: 尝试下简单的分布式事务
+permalink: /docs/txlcn-demo-env/
+---
+
 
 ## 步骤引导
 

diff --git a/_docs/txlcn/demo/springcloud.md b/_docs/txlcn/demo/springcloud.md
@@ -1,4 +1,7 @@
-# SpringCloud示例
+---
+title: SpringCloud示例
+permalink: /docs/txlcn-demo-springcloud/
+---
 
 SpringCloud 示例说明  
 共三个模块如下：  

diff --git a/_docs/txlcn/developer.md b/_docs/txlcn/developer.md
@@ -1,5 +1,7 @@
-# 开发者
-
+---
+title: 开发者
+permalink: /docs/txlcn-developer/
+---
 
 5.0版本研发者均为CodingApi成员。
 
@@ -33,4 +35,4 @@
 
 github 代码提交贡献人员:
 
-https://github.com/codingapi/tx-lcn/graphs/contributors
+https://github.com/codingapi/tx-lcn/graphs/contributors
diff --git a/_docs/txlcn/expansion/message.md b/_docs/txlcn/expansion/message.md
@@ -1,4 +1,8 @@
-# 通讯协议扩展
+---
+title: 通讯协议扩展
+permalink: /docs/txlcn-expansion-message/
+---
+
 
 通讯协议扩展是指txclient与txmanager通讯的协议扩展。
 

diff --git a/_docs/txlcn/expansion/rpc.md b/_docs/txlcn/expansion/rpc.md
@@ -1,4 +1,7 @@
-# RPC框架扩展
+---
+title: RPC框架扩展
+permalink: /docs/txlcn-expansion-rpc/
+---
 
 RPC扩展主要是指在分布式事务框架下对传递控制参数的支持、与负载均衡的扩展控制。   
 
@@ -135,4 +138,4 @@ class DubboTxlcnLoadBalance {
 }
 ```
 
-
+
diff --git a/_docs/txlcn/expansion/transaction.md b/_docs/txlcn/expansion/transaction.md
@@ -1,4 +1,7 @@
-# 事务模式扩展
+---
+title: 事务模式扩展
+permalink: /docs/txlcn-expansion-transaction/
+---
 
 TX-LCN不仅仅支持LCN TXC TCC模式，也可以由开发者自定义符合TX-LCN控制原理的请求事务模型。
 
@@ -148,4 +151,4 @@ public class LcnStartingTransaction implements DTXLocalControl {
 
 说明：
 
-若增加的新的模式最好创建一个新的模块，然后调整pom增加该模块的支持即可。
+若增加的新的模式最好创建一个新的模块，然后调整pom增加该模块的支持即可。
diff --git a/_docs/txlcn/fqa.md b/_docs/txlcn/fqa.md
@@ -1,4 +1,7 @@
-# FQA
+---
+title: FQA
+permalink: /docs/txlcn-fqa/
+---
 
 ## 1. TxManager配置分布式事务时间的作用是？为什么？
 > 自动补偿机制会自动修复在分布式事务时间后系统存在的可修复异常。为什么是`a >= 2c + (b + c + d) * (e - 1) - Δ`？
@@ -58,4 +61,4 @@ A:
 demo参考见https://github.com/codingapi/txlcn-demo 1.5.boot分支
 
 
-
+
diff --git a/_docs/txlcn/manageradmin.md b/_docs/txlcn/manageradmin.md
@@ -1,4 +1,8 @@
-# TxManager管理手册
+---
+title: TxManager管理手册
+permalink: /docs/txlcn-manageradmin/
+---
+
 
 访问 [http://127.0.0.1:8069/admin/index.html](http://127.0.0.1:8069/admin/index.html)进入管理后台，默认密码时`codingapi`。[指定密码](setting/manager.html)
 
@@ -30,4 +34,4 @@
  over join group： TxClient 成功加事务组
  notify group 1： TxManager通知TxClient提交本第事务（0回滚）
  notify unit exception： TxManager通知事务单元失败（此处会记录异常信息）
- notify group over：通知事务组结束（对于个别不能通知到的单元，会记下异常记录，不影响其它通知，异常的等待补偿）
+ notify group over：通知事务组结束（对于个别不能通知到的单元，会记下异常记录，不影响其它通知，异常的等待补偿）
diff --git a/_docs/txlcn/principle/control.md b/_docs/txlcn/principle/control.md
@@ -1,4 +1,8 @@
-# 事务控制原理
+---
+title: 事务控制原理
+permalink: /docs/txlcn-principle-control/
+---
+
 
 &nbsp;&nbsp;&nbsp;&nbsp;TX-LCN由两大模块组成, TxClient、TxManager，TxClient作为模块的依赖框架，提供TX-LCN的标准支持，TxManager作为分布式事务的控制放。事务发起方或者参与反都由TxClient端来控制。
 

diff --git a/_docs/txlcn/principle/lcn.md b/_docs/txlcn/principle/lcn.md
@@ -1,4 +1,8 @@
-# LCN事务模式
+---
+title: LCN事务模式
+permalink: /docs/txlcn-principle-lcn/
+---
+
 
 ## 一、原理介绍:     
 &nbsp;&nbsp;&nbsp;&nbsp;LCN模式是通过代理Connection的方式实现对本地事务的操作，然后在由TxManager统一协调控制事务。当本地事务提交回滚或者关闭连接时将会执行假操作，该代理的连接将由LCN连接池管理。

diff --git a/_docs/txlcn/principle/tcc.md b/_docs/txlcn/principle/tcc.md
@@ -1,4 +1,7 @@
-# TCC事务模式
+---
+title: TCC事务模式
+permalink: /docs/txlcn-principle-tcc/
+---
 
 ## 一、原理介绍:     
 &nbsp;&nbsp;&nbsp;&nbsp;TCC事务机制相对于传统事务机制（X/Open XA Two-Phase-Commit），其特征在于它不依赖资源管理器(RM)对XA的支持，而是通过对（由业务系统提供的）业务逻辑的调度来实现分布式事务。主要由三步操作，Try: 尝试执行业务、  Confirm:确认执行业务、  Cancel: 取消执行业务。

diff --git a/_docs/txlcn/principle/txc.md b/_docs/txlcn/principle/txc.md
@@ -1,4 +1,7 @@
-# TXC事务模式
+---
+title: TXC事务模式
+permalink: /docs/txlcn-principle-txc/
+---
 
 ## 一、原理介绍：    
 &nbsp;&nbsp;&nbsp;&nbsp;TXC模式命名来源于淘宝，实现原理是在执行SQL之前，先查询SQL的影响数据，然后保存执行的SQL快走信息和创建锁。当需要回滚的时候就采用这些记录数据回滚数据库，目前锁实现依赖redis分布式锁控制。
@@ -8,4 +11,4 @@
 * 该模式仅限于对支持SQL方式的模块支持。
 * 该模式由于每次执行SQL之前需要先查询影响数据，因此相比LCN模式消耗资源与时间要多。
 * 该模式不会占用数据库的连接资源。
-
+
diff --git a/_docs/txlcn/setting/client.md b/_docs/txlcn/setting/client.md
@@ -1,4 +1,8 @@
-# TxClient配置说明
+---
+title: TxClient配置说明
+permalink: /docs/txlcn-setting-client/
+---
+
 ## 一、application.properties
 ```properties
 

diff --git a/_docs/txlcn/setting/distributed.md b/_docs/txlcn/setting/distributed.md
@@ -1,4 +1,8 @@
-# 负载与集群配置
+---
+title: 负载与集群配置
+permalink: /docs/txlcn-setting-distributed/
+---
+
 
 &nbsp;&nbsp;&nbsp;&nbsp;负载集群分为业务模块与TxManager
 
@@ -100,4 +104,4 @@ springcloud下需要在application的配置文件下增加:
 
 ```
 tx-lcn.springcloud.loadbalance.enabled=true
-```
+```
diff --git a/_docs/txlcn/setting/manager.md b/_docs/txlcn/setting/manager.md
@@ -1,4 +1,7 @@
-# TxManager配置说明
+---
+title: TxManager配置说明
+permalink: /docs/txlcn-setting-manager/
+---
 
 ## application.properties
 ```properties
@@ -73,4 +76,4 @@ spring.mail.username=xxxxx@**.com
 spring.mail.password=*********
 ```
 
-----------------
+----------------
diff --git a/_docs/txlcn/test.md b/_docs/txlcn/test.md
@@ -1,4 +1,7 @@
-# TX-LCN 5.0.0 性能测试报告
+---
+title: TX-LCN 5.0.0 性能测试报告
+permalink: /docs/txlcn-test/
+---
 
 ## 方式说明
 
@@ -87,4 +90,4 @@ TCC > LCN > TXC
 * 下降率  
    是指在相同的RPC框架下各种事务模式相同条件下的吞吐量相比本地事务吞吐量的下降比例。    
 
-例如：1 - dubbo下LCN模式的吞吐量/dubbo下本地事务的吞吐量  
+例如：1 - dubbo下LCN模式的吞吐量/dubbo下本地事务的吞吐量  
diff --git a/img/5.0.0.zip b/img/5.0.0.zip
diff --git a/img/alibaba.png b/img/alibaba.png
diff --git a/img/alibaba_hover.png b/img/alibaba_hover.png
diff --git a/img/architecture.png b/img/architecture.png
diff --git a/img/brhtqqzh.jpeg b/img/brhtqqzh.jpeg
diff --git a/img/docs/abc.png b/img/docs/abc.png
diff --git a/img/docs/brhtqqzh.jpeg b/img/docs/brhtqqzh.jpeg
diff --git a/img/docs/dubbo-client.png b/img/docs/dubbo-client.png
diff --git a/img/docs/dubbo-d.png b/img/docs/dubbo-d.png
diff --git a/img/docs/dubbo-e.png b/img/docs/dubbo-e.png
diff --git a/img/docs/error-result.png b/img/docs/error-result.png
diff --git a/img/docs/maven-d.png b/img/docs/maven-d.png
diff --git a/img/docs/maven-e.png b/img/docs/maven-e.png
diff --git a/img/docs/maven-s.png b/img/docs/maven-s.png
diff --git a/img/docs/maven-sd.png b/img/docs/maven-sd.png
diff --git a/img/docs/maven-se.png b/img/docs/maven-se.png
diff --git a/img/docs/maven.png b/img/docs/maven.png
diff --git a/img/docs/result.png b/img/docs/result.png
diff --git a/img/docs/spring-client.png b/img/docs/spring-client.png
diff --git a/img/docs/spring-d.png b/img/docs/spring-d.png
diff --git a/img/docs/spring-e.png b/img/docs/spring-e.png
diff --git a/img/docs/tx_manager.png b/img/docs/tx_manager.png
diff --git a/img/docs/txex.png b/img/docs/txex.png
diff --git a/img/docs/yuanli.png b/img/docs/yuanli.png
diff --git a/img/docsite.ico b/img/docsite.ico
diff --git a/img/documents.png b/img/documents.png
diff --git a/img/erweima.png b/img/erweima.png
diff --git a/img/feature_hogh.png b/img/feature_hogh.png
diff --git a/img/feature_loadbalances.png b/img/feature_loadbalances.png
diff --git a/img/feature_maintenance.png b/img/feature_maintenance.png
diff --git a/img/feature_runtime.png b/img/feature_runtime.png
diff --git a/img/feature_service.png b/img/feature_service.png
diff --git a/img/feature_transpart.png b/img/feature_transpart.png
diff --git a/img/issue.png b/img/issue.png
diff --git a/img/jmeter-res.png b/img/jmeter-res.png
diff --git a/img/jmeter.png b/img/jmeter.png
diff --git a/img/mailinglist.png b/img/mailinglist.png
diff --git a/img/mailinglist_hover.png b/img/mailinglist_hover.png
diff --git a/img/pullrequest.png b/img/pullrequest.png
diff --git a/img/quick_arch.png b/img/quick_arch.png
diff --git a/img/quick_start.png b/img/quick_start.png
diff --git a/img/quick_start.png.old b/img/quick_start.png.old
diff --git a/img/res.png b/img/res.png
diff --git a/img/segmentfault.png b/img/segmentfault.png
diff --git a/img/segmentfault_hover.png b/img/segmentfault_hover.png
diff --git a/img/system/1.png b/img/system/1.png
diff --git a/img/system/arrow_down.png b/img/system/arrow_down.png
diff --git a/img/system/arrow_right.png b/img/system/arrow_right.png
diff --git a/img/system/blog.png b/img/system/blog.png
diff --git a/img/system/community.png b/img/system/community.png
diff --git a/img/system/docs.png b/img/system/docs.png
diff --git a/img/system/docs_hover.png b/img/system/docs_hover.png
diff --git a/img/system/docs_normal.png b/img/system/docs_normal.png
diff --git a/img/system/menu_gray.png b/img/system/menu_gray.png
diff --git a/img/system/menu_white.png b/img/system/menu_white.png
diff --git a/img/system/next.png b/img/system/next.png
diff --git a/img/system/prev.png b/img/system/prev.png
diff --git a/img/t_logger.png b/img/t_logger.png
diff --git a/img/tc.png b/img/tc.png
diff --git a/img/tm.png b/img/tm.png
diff --git a/img/tx_session.png b/img/tx_session.png
diff --git a/img/txlcn.png b/img/txlcn.png
diff --git a/img/txlcn_white.png b/img/txlcn_white.png
diff --git a/img/users_alibaba.png b/img/users_alibaba.png
diff --git a/img/weibo.png b/img/weibo.png
diff --git a/img/weibo_hover.png b/img/weibo_hover.png