Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

add seata doc && update mysql-connector-java version #2918

Merged
merged 5 commits into from
Nov 25, 2022

Conversation

fszhang1998
Copy link
Contributor

@fszhang1998 fszhang1998 commented Nov 20, 2022

Describe what this PR does / why we need it

  1. add seata doc : related to [Seata]Add Seata relevant docs  #2610
  2. There are 1 security vulnerabilities found in mysql:mysql-connector-java 5.1.47, so update mysql-connector-java version:from 5.1.47 to 8.0.28
    CVE-2022-21363

Does this pull request fix one issue?

Describe how you did it

  1. Fixed the document format and content
  2. update mysql-connector-java version:from 5.1.47 to 8.0.28

Describe how to verify it

Special notes for reviews

@CLAassistant
Copy link

CLAassistant commented Nov 20, 2022

CLA assistant check
All committers have signed the CLA.

@fszhang1998
Copy link
Contributor Author

fszhang1998 commented Nov 20, 2022 via email

@fszhang1998 fszhang1998 changed the title add seata doc add seata doc && update mysql-connector-java version Nov 20, 2022
</dependency>
----

=== 在运行 https://github.com/alibaba/spring-cloud-alibaba/tree/2021.x/spring-cloud-alibaba-examples/seata-example[spring-cloud-alibaba-examples/seata-example]之前,您需要完成以下步骤:
Copy link
Collaborator

@steverao steverao Nov 22, 2022

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

这样写太直接了,这个文档最终会转换成用户帮助文档。最好还是一步一步的引导用户去做比较好,这个是我们其他模块的帮助文档内容可以参考一下写法。
或者改成:项目提供了相关实例 Example,在运行之前,您需要完成以下步骤:

1. 保证本地已经运行 `nacos-server` 在 `8848` 端口。
2. 配置数据库,将 `account-server`、`order-service`、`storage-service` 这三个应用中的 resources 目录下的 `application.yml` 文件中的如下配置修改成你运行环境中的实际配置。

base:
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please modify here like below:

base:
  config:
    mdb:
      hostname: 127.0.0.1 #your mysql server ip address
      dbname: seata #your database name for test
      port: 3306 #your mysql server listening port
      username: root #your mysql server username
      password: root #your mysql server password

- 当服务调用者通过 RestTemplate 调用时,支持自动传递 Seata 上下文。
- 当服务调用者通过 FeignClient 调用时,支持自动传递 Seata 上下文。
- 支持同时使用 SeataClient 和 Hystrix 的场景。
- 支持 SeataClient 和 entinel 使用的场景。
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please modify spelling problem of entinel.

</dependency>
----

=== 项目提供了相关实例 https://github.com/alibaba/spring-cloud-alibaba/tree/2021.x/spring-cloud-alibaba-examples/seata-example[Example],在运行之前,您需要完成以下步骤:
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

You should delete === here, this is a sentence instead of a title.



=== 如何验证分布式事务的成功?
### Xid 信息是否成功传递
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

You should use ==== instead of ### here.


在 `account-server`、`order-service` 和 `storage-service` 三个 服务的 Controller 中,第一个执行的逻辑都是输出 RootContext 中的 Xid 信息,如果看到都输出了正确的 Xid 信息,即每次都发生变化,且同一次调用中所有服务的 Xid 都一致。则表明 Seata 的 Xid 的传递和还原是正常的。

### 数据库中数据的一致性
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

You should use ==== instead of ### here.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

okay

@fszhang1998
Copy link
Contributor Author

I have revised it according to comments.

@steverao
Copy link
Collaborator

LGTM, thanks @fszhang1998

@steverao steverao merged commit add08b6 into alibaba:2021.x Nov 25, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants