@@ -325,7 +325,7 @@ leave a comment
325325
3263262、点击右上角fork按钮,等待fork完成
327327
328- === 第2步: 将fork的仓库克隆至本地
328+ === 将fork的仓库克隆至本地
329329
330330```
331331cd $working_dir # 将 $working_dir 替换为你想放置 repo 的目录。例如,`cd ~/Documents/GitHub`
@@ -402,29 +402,29 @@ IvorySQL 文档中心由三部分组成:
402402
403403对于较大的改动或添加新页面,建议使用完整的 Git 工作流:
404404
405- ==== 第1步: Fork 文档仓库
405+ ==== Fork 文档仓库
406406
4074071、打开文档仓库 https://github.com/IvorySQL/ivorysql_docs
408408
4094092、点击右上角 fork 按钮,等待 fork 完成
410410
411- ==== 第2步: 将 fork 的仓库克隆至本地
411+ ==== 将 fork 的仓库克隆至本地
412412
413413```
414414cd $working_dir # 将 $working_dir 替换为你想放置 repo 的目录
415415
416416git clone git@github.com:$user/ivorysql_docs.git # 将 `$user` 替换为你的 GitHub ID
417417```
418418
419- ==== 第3步: 创建一个新的 Branch
419+ ==== 创建一个新的 Branch
420420
421421```
422422cd $working_dir/ivorysql_docs
423423
424424git checkout -b new-branch-name
425425```
426426
427- ==== 第4步: 编辑文档
427+ ==== 编辑文档
428428
429429在新建的 new-branch-name 中编辑文档。IvorySQL 文档使用 AsciiDoc 格式编写,请参考 xref:master/contribution/asciidoc_syntax_reference.adoc[AsciiDoc 语法参考]。
430430
@@ -433,15 +433,15 @@ git checkout -b new-branch-name
433433. 中英文文件应该同名
434434. 修改对应的 `nav.adoc` 文件添加导航链接
435435
436- ==== 第5步: 生成 commit
436+ ==== 生成 commit
437437
438438```
439439git add <file>
440440
441441git commit -m "commit-message"
442442```
443443
444- ==== 第6步: 将修改推送至远端
444+ ==== 将修改推送至远端
445445
446446```
447447git push -u origin new-branch-name
@@ -468,7 +468,7 @@ IvorySQL 作为一款基于 PostgreSQL 研发的 Oracle 兼容数据库,天然
468468
469469具体的选题、测试、文档编写等环节,请参考下面的详细步骤。
470470
471- ==== 第1步: 选题与沟通
471+ ==== 选题与沟通
472472
473473===== 确认组件未被适配
474474
@@ -490,7 +490,7 @@ IvorySQL 作为一款基于 PostgreSQL 研发的 Oracle 兼容数据库,天然
490490
491491在提交文档贡献之前,请确保您已签署贡献者许可协议(CLA)。详情请参阅本指南的签署 CLA。
492492
493- ==== 第2步: 适配测试
493+ ==== 适配测试
494494
495495生态组件适配的目标分为两个层面:
496496
@@ -565,7 +565,7 @@ Oracle 兼容模式测试不通过——尤其是执行 `CREATE EXTENSION` 就
565565
566566确认目标扩展属于适用场景后,您可以向 IvorySQL 仓库提交 PR,将扩展名加入 `PgDialectExtensions` 白名单,并在 PR 描述中附上两种模式下的测试结果;同时在适配文档的 "Oracle 兼容性" 章节中说明该扩展通过白名单机制运行。
567567
568- ==== 第3步: 文档编写
568+ ==== 文档编写
569569
570570IvorySQL 文档使用 AsciiDoc 编写的,其语法与 Markdown 类似但功能更加强大。如果不熟悉 AsciiDoc 语法,可参阅 xref:master/contribution/asciidoc_syntax_reference.adoc[asciidoc语法快速参考]。
571571
@@ -673,7 +673,7 @@ ivorysql=# SELECT * FROM pg_available_extensions WHERE name = '<扩展名>';
673673[NOTE]
674674中英文版本的概述页都需要同步更新。
675675
676- ==== 第4步: 提交 PR
676+ ==== 提交 PR
677677
678678===== 创建分支
679679
@@ -696,7 +696,7 @@ git checkout -b feature/adapt-<组件名称>
696696按照 xref:#_提交_pr[提交 PR] 章节的步骤创建 PR,并注意以下特殊要求:
697697
698698. 向 https://github.com/IvorySQL/ivorysql_docs[IvorySQL docs] 仓库的 master 分支提交 PR
699- . 在 PR 描述中使用 `Fixes IvorySQL/IvorySQL#<编号>` 关联第一步中认领或新建的适配 Issue
699+ . 在 PR 描述中使用 `Fixes IvorySQL/IvorySQL#<编号>` 关联中认领或新建的适配 Issue
700700. 在 PR 描述中说明:
701701* 适配的组件名称和版本
702702* 测试环境信息
@@ -738,7 +738,7 @@ $PG_CONFIG --version
738738. 扩展的 `.so` 文件是否正确安装到 IvorySQL 的 `lib` 目录
739739. 扩展的 `.sql` 和 `.control` 文件是否正确安装到 `share/extension` 目录
740740. IvorySQL 版本是否与组件要求的 PostgreSQL 版本兼容
741- . 若失败原因是 PG 专用语法无法解析,可参考第三步的 PG 语法白名单机制。
741+ . 若失败原因是 PG 专用语法无法解析,可参考的 PG 语法白名单机制。
742742
743743==== Oracle 兼容模式下功能异常
744744
0 commit comments