This is an automated email from the ASF dual-hosted git repository.
ningjiang pushed a commit to branch SCB-1568
in repository https://gitbox.apache.org/repos/asf/servicecomb-pack.git
commit 8af87a530d5eb2e230bc2301e2bc6862d53b0134
Author: Willem Jiang <willem.ji...@gmail.com>
AuthorDate: Wed Nov 6 19:56:37 2019 +0800
SCB-1568 Update the user document for the transport artifacts
---
docs/user_guide.md | 10 +++++-----
docs/user_guide_zh.md | 6 +++---
2 files changed, 8 insertions(+), 8 deletions(-)
diff --git a/docs/user_guide.md b/docs/user_guide.md
index c927bb5..6446fd7 100644
--- a/docs/user_guide.md
+++ b/docs/user_guide.md
@@ -63,7 +63,7 @@ After executing either one of the above command, you will
find alpha server's ex
### Saga Support
Add saga annotations and corresponding compensation methods
Take a transfer money application as an example:
-1. add `@SagaStart` at the starting point of the global transaction
+1. Add `@SagaStart` at the starting point of the global transaction to prepare
the new global transaction context. If you don't specify the SagaStart the
flowing sub-transaction will complain that the global transaction id is not
found.
```java
import org.apache.servicecomb.pack.omega.context.annotations.SagaStart;
@@ -75,7 +75,7 @@ Take a transfer money application as an example:
```
**Note:** By default, timeout is disable.
-2. add `@Compensable` at the sub-transaction and specify its corresponding
compensation method
+2. Add `@Compensable` at the sub-transaction and specify its corresponding
compensation method.
```java
import javax.transaction.Transactional;
import
org.apache.servicecomb.pack.omega.transaction.annotations.Compensable;
@@ -140,9 +140,9 @@ Here is how Omega does:
2.
[TransactionClientHttpRequestInterceptor][src-TransactionClientHttpRequestInterceptor]
injects transaction context into request headers when `RestTemplate` request
Service B.
3. When Service B receive the request,
[TransactionHandlerInterceptor][src-TransactionHandlerInterceptor] extract
context info from request headers.
-Omega supports following implicity transaction context passing:
+Omega supports following implicit transaction context passing:
-1. omega-transport-{dubbo,feign,resttemplate,servicecomb}.
+1. omega-transport-{dubbo,feign,resttemplate,servicecomb}. Please make sure
you add these transport artifacts into your classpath, otherwise you may face
an issue that Omega complains about cannot find global transaction id.
2. Method call in the same thread (based on `OmegaContext` thread local
fields).
3. `java.util.concurrent.Executor{Service}` annotated by `@OmegaContextAware`.
@@ -816,4 +816,4 @@ Alpha can be highly available by deploying multiple
instances, enable cluster su
## Experiment
-[State Machine Mode](fsm/fsm_manual.md)
\ No newline at end of file
+[State Machine Mode](fsm/fsm_manual.md)
diff --git a/docs/user_guide_zh.md b/docs/user_guide_zh.md
index 78f468b..e24eebd 100644
--- a/docs/user_guide_zh.md
+++ b/docs/user_guide_zh.md
@@ -64,7 +64,7 @@ Saga可通过以下任一方式进行构建：
### Saga 支持
添加Saga的注解及相应的补偿方法
以一个转账应用为例：
-1. 在全局事务的起点添加 `@SagaStart` 的注解。
+1. 在全局事务的起点添加 `@SagaStart`
的注解来让Omega创建一个新的全局事务。如果不标准这个事务起点的话，后续子事务在执行过程中会报找不到全局事务ID的错误。
```java
import org.apache.servicecomb.pack.omega.context.annotations.SagaStart;
@@ -142,7 +142,7 @@ public void bar() {
目前Omega支持以下形式的隐式事务上下文传递：
-1. omega-transport-{dubbo,feign,resttemplate,servicecomb}。
+1.
omega-transport-{dubbo,feign,resttemplate,servicecomb}。请注意在你有使用到相关服务调用组件时，请将以上的传输组件添加到你的class
path中，否则相关的全局事务ID是无法在服务调用过程中传递。
2. 同线程内调用（基于OmegaContext的ThreadLocal字段）。
3. 标注了@OmegaContextAware的java.util.concurrent.Executor{Service}。
@@ -802,4 +802,4 @@ Alpha 可以通过部署多实例的方式保证高可用，使用 `alpha.cluste
## 实验
-[状态机模式](fsm/fsm_manual_zh.md)
\ No newline at end of file
+[状态机模式](fsm/fsm_manual_zh.md)
