You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@servicecomb.apache.org by ni...@apache.org on 2018/11/09 01:53:21 UTC
[servicecomb-docs] 01/02: SCB-973 Clean up the saga-refernce
documents
This is an automated email from the ASF dual-hosted git repository.
ningjiang pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/servicecomb-docs.git
commit e94f3be9eb659f88e2234f1f08fb31c89bda0ea4
Author: Willem Jiang <ji...@huawei.com>
AuthorDate: Fri Nov 9 09:47:27 2018 +0800
SCB-973 Clean up the saga-refernce documents
---
saga-reference/en_US/README.md | 16 ++++++++--------
saga-reference/en_US/old_saga.md | 8 ++++----
saga-reference/en_US/user_guide.md | 14 +++++++-------
saga-reference/zh_CN/README.md | 12 ++++++------
saga-reference/zh_CN/user_guide_zh.md | 12 ++++++------
5 files changed, 31 insertions(+), 31 deletions(-)
diff --git a/saga-reference/en_US/README.md b/saga-reference/en_US/README.md
index bd4a052..bbe6d61 100644
--- a/saga-reference/en_US/README.md
+++ b/saga-reference/en_US/README.md
@@ -1,5 +1,5 @@
# Saga
-Apache ServiceComb (incubating) Saga is an eventually data consistency solution for micro-service applications.
+Apache ServiceComb Saga is an eventually data consistency solution for micro-service applications.
## Features
* High availability. The coordinator is stateless and thus can have multiple instances.
@@ -26,11 +26,11 @@ Now we have different lanaguage implementation of Omega
* C# version of Omega here https://github.com/OpenSagas-csharp/servicecomb-saga-csharp
## Get Started
-* For ServiceComb Java Chassis application, please see [Booking Demo](https://github.com/apache/incubator-servicecomb-saga/tree/master/saga-demo/saga-servicecomb-demo/README.md) for details.
-* For Spring applications, please see [Booking Demo](https://github.com/apache/incubator-servicecomb-saga/tree/master/saga-demo/saga-spring-demo/README.md) for details.
-* For Dubbo applications, please see [Dubbo Demo](https://github.com/apache/incubator-servicecomb-saga/tree/master/saga-demo/saga-dubbo-demo/README.md) for details.
-* For TCC with Spring application, please see [Tcc Demo](https://github.com/apache/incubator-servicecomb-saga/tree/master/saga-demo/tcc-spring-demo/README.md) for details.
-* To debug the applications, please see [Spring Demo Debugging](https://github.com/apache/incubator-servicecomb-saga/tree/master/saga-demo/saga-spring-demo#debugging) for details.
+* For ServiceComb Java Chassis application, please see [Booking Demo](https://github.com/apache/servicecomb-saga/tree/master/saga-demo/saga-servicecomb-demo/README.md) for details.
+* For Spring applications, please see [Booking Demo](https://github.com/apache/servicecomb-saga/tree/master/saga-demo/saga-spring-demo/README.md) for details.
+* For Dubbo applications, please see [Dubbo Demo](https://github.com/apache/servicecomb-saga/tree/master/saga-demo/saga-dubbo-demo/README.md) for details.
+* For TCC with Spring application, please see [Tcc Demo](https://github.com/apache/servicecomb-saga/tree/master/saga-demo/tcc-spring-demo/README.md) for details.
+* To debug the applications, please see [Spring Demo Debugging](https://github.com/apache/servicecomb-saga/tree/master/saga-demo/saga-spring-demo#debugging) for details.
## Build and Run the tests from source
* Build the source code and run the tests
@@ -40,9 +40,9 @@ Now we have different lanaguage implementation of Omega
* Build the source demo docker images and run the accept tests
```bash
$ mvn clean install -Pdemo,docker
- ```
+ ```
* Current Saga code supports Spring Boot 1.x and Spring Boot 2.x at the same time, saga uses Spring Boot 1.x by default, you can use *-Pspring-boot-2* to switch Spring Boot version to 2.x.
Since Spring Boot supports JDK9 since 2.x, if you want to build and run test the Saga with JDK9 or JDK10, you need to use the spring-boot-2 profile.
```bash
$ mvn clean install -Pdemo,docker,spring-boot-2
- ```
+ ```
diff --git a/saga-reference/en_US/old_saga.md b/saga-reference/en_US/old_saga.md
index 2b79d22..ff8c799 100755
--- a/saga-reference/en_US/old_saga.md
+++ b/saga-reference/en_US/old_saga.md
@@ -6,7 +6,7 @@
* saga-discovery(service discovery)
* saga-spring(restful service framework)
-
+
## Prerequisites
You will need:
@@ -22,14 +22,14 @@ You will need:
[maven]: https://maven.apache.org/install.html
[docker]: https://www.docker.com/get-docker
[postgres]: https://www.postgresql.org/download/
-[service_center]: https://github.com/apache/incubator-servicecomb-service-center
+[service_center]: https://github.com/apache/servicecomb-service-center
[docker_compose]: https://docs.docker.com/compose/install/
[docker_machine]: https://docs.docker.com/machine/install-machine/
## Building
Download the source code.
```
-git clone https://github.com/apache/incubator-servicecomb-saga.git
+git clone https://github.com/apache/servicecomb-saga.git
```
Enter the Saga root directory,build Saga project by maven command and generate a docker image named saga-spring in local.
@@ -50,4 +50,4 @@ docker-compose up
See [Saga API](docs/api/api.md) for details.
## Example
-See [Saga demo](https://github.com/apache/incubator-servicecomb-saga/tree/master/saga-demo) for details.
+See [Saga demo](https://github.com/apache/servicecomb-saga/tree/master/saga-demo) for details.
diff --git a/saga-reference/en_US/user_guide.md b/saga-reference/en_US/user_guide.md
index eecc681..51f5754 100644
--- a/saga-reference/en_US/user_guide.md
+++ b/saga-reference/en_US/user_guide.md
@@ -13,8 +13,8 @@ You will need:
Retrieve the source code:
```bash
-$ git clone https://github.com/apache/incubator-servicecomb-saga.git
-$ cd incubator-servicecomb-saga
+$ git clone https://github.com/apache/servicecomb-saga.git
+$ cd servicecomb-saga
```
Saga can be built in either of the following ways.
@@ -27,7 +27,7 @@ Saga can be built in either of the following ways.
```bash
$ mvn clean install -DskipTests -Pdocker
```
-
+
* build the executable file and saga-distribution
```bash
$ mvn clean install -DskipTests -Prelease
@@ -63,7 +63,7 @@ Take a transfer money application as an example:
}
}
```
-
+
2. add `@SagaStart` at the starting point of the global transaction
```java
@SagaStart(timeout=10)
@@ -80,7 +80,7 @@ Take a transfer money application as an example:
public boolean transferOut(String from, int amount) {
repo.reduceBalanceByUsername(from, amount);
}
-
+
public boolean cancel(String from, int amount) {
repo.addBalanceByUsername(from, amount);
}
@@ -94,14 +94,14 @@ Take a transfer money application as an example:
4. Repeat step 3 for the `transferIn` service.
-5. Since Saga-0.3.0, you can access the [OmegaContext](https://github.com/apache/incubator-servicecomb-saga/blob/master/omega/omega-context/src/main/java/org/apache/servicecomb/saga/omega/context/OmegaContext.java) for the gloableTxId and localTxId in the @Compensable annotated method or the cancel method.
+5. Since Saga-0.3.0, you can access the [OmegaContext](https://github.com/apache/servicecomb-saga/blob/master/omega/omega-context/src/main/java/org/apache/servicecomb/saga/omega/context/OmegaContext.java) for the gloableTxId and localTxId in the @Compensable annotated method or the cancel method.
## How to run
1. run postgreSQL.
```bash
docker run -d -e "POSTGRES_DB=saga" -e "POSTGRES_USER=saga" -e "POSTGRES_PASSWORD=password" -p 5432:5432 postgres
```
- Please check out [this document](https://github.com/apache/incubator-servicecomb-saga/blob/master/docs/faq/en/how_to_use_mysql_as_alpha_backend_database.md), if you want to use the MySQL instead of postgreSQL.
+ Please check out [this document](https://github.com/apache/servicecomb-saga/blob/master/docs/faq/en/how_to_use_mysql_as_alpha_backend_database.md), if you want to use the MySQL instead of postgreSQL.
2. run alpha. Before running alpha, please make sure postgreSQL is already up. You can run alpha through docker or executable file.
* Run alpha through docker.
diff --git a/saga-reference/zh_CN/README.md b/saga-reference/zh_CN/README.md
index f1d3974..b2f96f2 100644
--- a/saga-reference/zh_CN/README.md
+++ b/saga-reference/zh_CN/README.md
@@ -1,5 +1,5 @@
# Saga
-Apache ServiceComb (incubating) Saga 是一个微服务应用的数据最终一致性解决方案。
+Apache ServiceComb Saga 是一个微服务应用的数据最终一致性解决方案。
## 特性
* 高可用。支持集群模式。
@@ -26,11 +26,11 @@ Saga Pack 架构是由 **alpha** 和 **omega**组成，其中：
## 快速入门
-* Saga在ServiceComb Java Chassis应用可以参考[出行预订](https://github.com/apache/incubator-servicecomb-saga/tree/master/saga-demo/saga-servicecomb-demo/README.md)
-* Saga在Spring应用的用法可参考[出行预订示例](https://github.com/apache/incubator-servicecomb-saga/tree/master/saga-demo/saga-spring-demo/README.md)。
-* Saga在Dubbo应用的用法可参考[Dubbo示例](https://github.com/apache/incubator-servicecomb-saga/tree/master/saga-demo/saga-dubbo-demo/README.md).
-* TCC在Spring应用的用法可以参考[TCC示例](https://github.com/apache/incubator-servicecomb-saga/tree/master/saga-demo/tcc-spring-demo/README.md)
-* 示例的的调试方法可以参考[调试Spring示例](https://github.com/apache/incubator-servicecomb-saga/tree/master/saga-demo/saga-spring-demo#debugging).
+* Saga在ServiceComb Java Chassis应用可以参考[出行预订](https://github.com/apache/servicecomb-saga/tree/master/saga-demo/saga-servicecomb-demo/README.md)
+* Saga在Spring应用的用法可参考[出行预订示例](https://github.com/apache/servicecomb-saga/tree/master/saga-demo/saga-spring-demo/README.md)。
+* Saga在Dubbo应用的用法可参考[Dubbo示例](https://github.com/apache/servicecomb-saga/tree/master/saga-demo/saga-dubbo-demo/README.md).
+* TCC在Spring应用的用法可以参考[TCC示例](https://github.com/apache/servicecomb-saga/tree/master/saga-demo/tcc-spring-demo/README.md)
+* 示例的的调试方法可以参考[调试Spring示例](https://github.com/apache/servicecomb-saga/tree/master/saga-demo/saga-spring-demo#debugging).
## 编译和运行代码
* 编译代码并且运行相关的单元测试
diff --git a/saga-reference/zh_CN/user_guide_zh.md b/saga-reference/zh_CN/user_guide_zh.md
index c3eab1a..3a1ff5a 100644
--- a/saga-reference/zh_CN/user_guide_zh.md
+++ b/saga-reference/zh_CN/user_guide_zh.md
@@ -12,8 +12,8 @@
获取源码：
```bash
-$ git clone https://github.com/apache/incubator-servicecomb-saga.git
-$ cd incubator-servicecomb-saga
+$ git clone https://github.com/apache/servicecomb-saga.git
+$ cd servicecomb-saga
```
Saga可通过以下任一方式进行构建：
@@ -31,7 +31,7 @@ Saga可通过以下任一方式进行构建：
```bash
$ mvn clean install -DskipTests -Prelease
```
-
+
在执行以上任一指令后，可在`alpha/alpha-server/target/saga/alpha-server-${version}-exec.jar`中找到alpha server的可执行文件。
@@ -80,7 +80,7 @@ Saga可通过以下任一方式进行构建：
public boolean transferOut(String from, int amount) {
repo.reduceBalanceByUsername(from, amount);
}
-
+
public boolean cancel(String from, int amount) {
repo.addBalanceByUsername(from, amount);
}
@@ -94,7 +94,7 @@ Saga可通过以下任一方式进行构建：
4. 对转入服务重复第三步即可。
-5. 从Saga-0.3.0, 你可以在服务函数或者取消函数中通过访问 [OmegaContext](https://github.com/apache/incubator-servicecomb-saga/blob/master/omega/omega-context/src/main/java/org/apache/servicecomb/saga/omega/context/OmegaContext.java) 来获取 gloableTxId 以及 localTxId 信息。
+5. 从Saga-0.3.0, 你可以在服务函数或者取消函数中通过访问 [OmegaContext](https://github.com/apache/servicecomb-saga/blob/master/omega/omega-context/src/main/java/org/apache/servicecomb/saga/omega/context/OmegaContext.java) 来获取 gloableTxId 以及 localTxId 信息。
## 如何运行
@@ -102,7 +102,7 @@ Saga可通过以下任一方式进行构建：
```bash
docker run -d -e "POSTGRES_DB=saga" -e "POSTGRES_USER=saga" -e "POSTGRES_PASSWORD=password" -p 5432:5432 postgres
```
- 如果你想使用MySQL做为后台数据库，可以参考 [此文档](https://github.com/apache/incubator-servicecomb-saga/blob/master/docs/faq/en/how_to_use_mysql_as_alpha_backend_database.md)。
+ 如果你想使用MySQL做为后台数据库，可以参考 [此文档](https://github.com/apache/servicecomb-saga/blob/master/docs/faq/en/how_to_use_mysql_as_alpha_backend_database.md)。
2. 运行alpha。在运行alpha前，请确保postgreSQL已正常启动。可通过docker或可执行文件的方式来启动alpha。