Open lovepoem opened 4 years ago
add API.
add API.
done
按照之前的经验,在最开始需要每种模式有一个快速入门的文档,尽量简单,step by step 十分钟用户可以跑起来,然后再是详细的referance和主主题,最好还有一个最佳实践的章节。
SqlParser 和 metrics SqlParser 目前AT模式固定为Druid,后面会通过spi扩展,这个放spi里还是跟数据库相关的并列?
需要一个版本说明,类似这种:版本说明
作为用户可能主要两大方面的关注:开发和运维,建议加入运维方面的内容。
作为用户可能主要两大方面的关注:开发和运维,建议加入运维方面的内容。
@sharajava 添加了“运维指南”目录
按照之前的经验,在最开始需要每种模式有一个快速入门的文档,尽量简单,step by step 十分钟用户可以跑起来,
添加“快速启动”:
然后再是详细的referance和主主题,
添加Seata各个支持功能和实现模块
最好还有一个最佳实践的章节。
添加“最佳实践”:
@long187
感觉目录内容很多,看看能不能精简一下,东西太多,一眼下去给用户压力好大。
感觉目录内容很多,看看能不能精简一下,东西太多,一眼下去给用户压力好大。
嗯 看怎么缩减下。
目录很多的原因是将各个分层的插件支持全部都列出来 了。其实像
不用每个插件实现都用一篇文章介绍,可以在一两篇文章统一介绍,用户能知道每种实现是做什么的,关键配置是什么就够了。
是否应该加入个性能测试报告,类似tx-lcn的性能测试报告
- 微服务框架支持 建议加入 SpringCloud
这个需要加
- 分库分表支持 建议合并到ORM框架
应该是不同类吧? 分库分表
比ORM框架
更靠近数据运维层面 。 应该是介于·数据库
和ORM
之间
- 数据源支持 建议加入 Hikari
这个目前代码还没有实现吧? 可以加TODO
ORM 框架支持
介绍 Mybatis 框架 mybatis-plus 框架 JPA 这仅仅是个介绍,还是只是列出目前已支持的orm框架,1.0的自动代理目前测试下来,mp跟jpa的已经是可以完美注入了,只要开启自动代理即可,貌似没有什么写文档的必要?
部署
增加高可用部署。
以及生产环境的最佳实践
增加视频讲解功能,比如像springcloud-eureka-feign-mybatis-seata和dubbo这种常用的例子可以试着录制一个新手quick start教程。
ORM 框架支持
介绍 Mybatis 框架 mybatis-plus 框架 JPA 这仅仅是个介绍,还是只是列出目前已支持的orm框架,1.0的自动代理目前测试下来,mp跟jpa的已经是可以完美注入了,只要开启自动代理即可,貌似没有什么写文档的必要?
如果很少这种,就不用Mybatis 框架、 mybatis-plus 框架、JPA每个写一篇了。可以在一篇文章里介绍下支持的框架和关键的配置。
Springboot1.5的jackson版本不兼容的解决方案应该在文档中说明,以下是我实践过的解决方案:https://github.com/seata/seata.github.io/issues/152
@Zane-Zeng http://seata.io/zh-cn/docs/overview/faq.html 第9个已加
缺少高可用 HA 的配置方法 和说明
缺少高可用 HA 的配置方法 和说明
会在文档突出这一点
seata能做什么,对应的还有不能做什么。 建议增加个不支持栏,记录不支持的点,让用户少入坑,并考虑将不支持点转换为任务。
把mvcc机制加入进来,是不是比用全局锁解决全局事务隔离性更好
建议增加自动配置和手动配置的示例(yml配置,代码配置),建议能把每个版本缺陷写出来以及和各个版本之间的对比(支持项和不支持项),另外增加各种注册中心关键配置代码段以及对应的FAQ,包括哪些是是用户可以自定义实现特殊业务的接口列表,相信SpringCloud用户比较多,建议能增加针对原生SpringCloud各个版本(Dalston, Greenwich等)以及SpringBoot1和SpringBoot2各个版本之间的示例或者兼容性配置(尤其是对Feign的支持)以及使用SpringCloud搭建时常见的错误,因为目前看好像Hystrix开启就没法使用seata了,建议增加Linux的HA配置示例(各个注册中心),强烈建议增加“最佳实践”
由于用户使用方式多种多样,希望添加一些解决问题的最佳实践,比如遇到全局异常处理的回滚,遇到降级的回滚等等!
文档怎么撰写对于使用者至关重要,所以每个人可以在这里提出自己的意见和建议。对用户文档的目录做一个基本的草稿,可以讨论,然后分成各个issue,大家一起撰写文档
在线文档地址: http://seata.io/zh-cn/docs/overview/what-is-seata.html 中文文档编写规范参考: https://github.com/ruanyf/document-style-guide 项目地址:
注意: 本次优先编写中文版本文档,鼓励同时提交英文版本。
目录如下:
用户文档
认识分布式事务
Seata 是什么
FAQ
事务模式:
快速启动:
配置:
API 支持:
服务发现:
序列化
微服务框架支持
分库分表支持
ORM 框架支持
数据源支持
数据库支持
服务追踪:
Spring支持:
最佳实践
测试报告
开发者指南
运维指南
部署
Metrics 配置