incubator-seata-website
incubator-seata-website copied to clipboard
apache
【提案】创建新版本用户文档目录（Create user doc directory）
文档怎么撰写对于使用者至关重要，所以每个人可以在这里提出自己的意见和建议。对用户文档的目录做一个基本的草稿，可以讨论，然后分成各个issue，大家一起撰写文档
在线文档地址： http://seata.io/zh-cn/docs/overview/what-is-seata.html
中文文档编写规范参考： https://github.com/ruanyf/document-style-guide
项目地址：
注意： 本次优先编写中文版本文档，鼓励同时提交英文版本。
目录如下：
-
用户文档
-
认识分布式事务
- 概念
- 理论依据、论文
-
Seata 是什么
-
FAQ
-
事务模式：
- 介绍
- AT 模式
- TCC 模式
- SAGA 模式
- XA 模式（TODO）
-
快速启动：
- AT 模式
- TCC 模式
- SAGA 模式
- XA 模式（TODO）
-
配置：
- 介绍
- 注解配置
- 文件模式
- Zookeeper 配置中心
- nacos 配置中心
- Etcd 注册中心
- Consule 配置中心
- Apollo 配置中心
- Spring Cloud 配置中心
-
API 支持：
-
服务发现：
- 介绍
- Zookeeper 服务发现
- Redis 服务发现
- nacos 服务发现
- Etcd 服务发现
- Eureka 服务发现
- Consule 服务发现
- Sofa 服务发现
-
序列化
- 介绍
- Seata 序列化
- kyro 序列化
- protobuf 序列化
- hessian 序列化
-
微服务框架支持
- 介绍
- Dubbo
- grpc
- motan
- sofa-rpc
- Spring Cloud
-
分库分表支持
- 介绍
- shardingsphere
-
ORM 框架支持
- 介绍
- Mybatis 框架
- mybatis-plus 框架
- JPA
-
数据源支持
- Druid
- Hikari (TODO)
-
数据库支持
- Mysql
- Oracle
- PostgreSQL
-
服务追踪：
- skywalking
-
Spring支持：
- 介绍
- 注解
-
最佳实践
- 配置最佳实践
- AT 模式熔断配置
-
测试报告
- 单元测试
- 性能测试
-
-
开发者指南
- SPI扩展点
- 架构设计
- 测试
- 单元测试
- 集成测试
-
运维指南
-
部署
- 直接部署
- Docker部署
- Kubernetes部署
- Helm部署
-
Metrics 配置
-
按照之前的经验，在最开始需要每种模式有一个快速入门的文档，尽量简单，step by step 十分钟用户可以跑起来，然后再是详细的referance和主主题，最好还有一个最佳实践的章节。
SqlParser 和 metrics SqlParser 目前AT模式固定为Druid，后面会通过spi扩展，这个放spi里还是跟数据库相关的并列？
@lightClouds917
按照之前的经验，在最开始需要每种模式有一个快速入门的文档，尽量简单，step by step 十分钟用户可以跑起来，
添加“快速启动”：
- 快速启动：
然后再是详细的referance和主主题，
添加Seata各个支持功能和实现模块
最好还有一个最佳实践的章节。
添加“最佳实践”：
- 最佳实践
@long187
感觉目录内容很多，看看能不能精简一下，东西太多，一眼下去给用户压力好大。
嗯 看怎么缩减下。
目录很多的原因是将各个分层的插件支持全部都列出来 了。其实像
不用每个插件实现都用一篇文章介绍，可以在一两篇文章统一介绍，用户能知道每种实现是做什么的，关键配置是什么就够了。
- 微服务框架支持 建议加入 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
建议增加自动配置和手动配置的示例（yml配置，代码配置），建议能把每个版本缺陷写出来以及和各个版本之间的对比（支持项和不支持项），另外增加各种注册中心关键配置代码段以及对应的FAQ，包括哪些是是用户可以自定义实现特殊业务的接口列表，相信SpringCloud用户比较多，建议能增加针对原生SpringCloud各个版本(Dalston, Greenwich等)以及SpringBoot1和SpringBoot2各个版本之间的示例或者兼容性配置（尤其是对Feign的支持）以及使用SpringCloud搭建时常见的错误，因为目前看好像Hystrix开启就没法使用seata了，建议增加Linux的HA配置示例（各个注册中心），强烈建议增加“最佳实践”
