/ 详情

[优化]API配置变更历史文档优化

Backlog
Opened this issue  
2021-05-14 15:43

目标

优化文档:

  1. 将API变更历史迁移到统一目录下,方便用户查找。
  2. 内容校对,检查各模式下变更历史的正确性,对内容不完整的进行补充。

简介

目前,ShardingSphere-JDBC各种模式的变更历史分布在用户手册配置说明的不同章节中,包括:

  1. 4.1.2.配置手册->Java API->变更历史
  2. 4.1.2.配置手册->YAML配置->变更历史
  3. 4.1.2.配置手册->Spring Boot Starter配置->变更历史
  4. 4.1.2.配置手册->Spring 命名空间配置->变更历史

本次优化,期望将以上变更历史统一迁移到其他目录下,进行如下调整:

  1. 将文档中7.FAQ修改为7.其他,原FAQ目录下沉为7.1.FAQ
  2. 新增7.2.变更历史目录层级;
  3. 将API变更历史4.用户手册中迁移到新增的7.2.变更历史目录下,并在此过程中检查文档内容是否正确;
  4. 新增ShardingSphere-Proxy模块的API变更历史;

调整后的目录层级如下:

├── 6.下载
└── 7.其他
    ├── 7.1.FAQ
    └── 7.2.API变更历史
    	├── 7.2.1.ShardingSphere-JDBC
        │   ├── Java API
        │   ├── YAML配置
        │   ├── Spring Boot Starter配置
        │   └── Spring 命名空间配置
        ├── 7.2.2.ShardingSphere-Proxy
        ...

注意:所有文档兼顾中文和英文版本,其中FAQ字符无需翻译。

任务

Comments (2)

RaigorJiang created任务
RaigorJiang changed description
RaigorJiang changed description
RaigorJiang changed description
RaigorJiang changed description
展开全部操作日志

我在跟这个Issue,请问是每个任务分开做吗?在不同的分支上,还是做在一个分支上?

Hi @张博奇
欢迎参与,#I3RBY2:[优化]API配置变更历史文档优化 这个是需求的总体描述,因为工作量较大,因此拆分为了多个任务。
一般情况下是各个issue单独用分支提交,避免单次影响太多文件,减少冲突的可能和review的难度。

ShardingSphere开发规范中有提到:
“应尽量将设计精细化拆分;做到小幅度修改,多次数提交,但应保证提交的完整性”

更多信息请参考 https://shardingsphere.apache.org/community/cn/contribute/code-conduct/

Sign in to comment

状态
Assignees
Milestones
Pull Requests
关联的 Pull Requests 被合并后可能会关闭此 issue
Branches
Planed to start   -   Planed to end
-
Top level
Priority
参与者(2)
421770 raigor 1616146907