apache / apache/incubator-seata-website

【提案】创建新版本用户文档目录(Create user doc directory)

Open
#136 27 comments 0 reactions 1 assignee Claimed by @lovepoem View on GitHub
discussion wanted question
Dominant language
JavaScript
Stars
110
Forks
137
Avg merge
18d 23h
Merged PRs (30d)
1

Description

### 文档怎么撰写对于使用者至关重要,所以每个人可以在这里提出自己的意见和建议。对用户文档的目录做一个基本的草稿,可以讨论,然后分成各个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 配置

Contributor guide

No contributing guide indexed for this repository

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.