Skip to content

Commit 7304d6a

Browse files
committed
docs: fix broken links and update references in contribution guide
- Line 43: Changed xref link to plain text '提交 Issue' - Lines 112-113: Updated CLA file URLs to new addresses - Line 160: Changed xref link to plain text '生态组件适配' - Line 164: Removed GitHub URL - Line 166: Added AtomGit URL (https://atomgit.com/IvorySQL/IvorySQL) - Line 167: Removed 码云 URL - Line 181: Changed email to proper mailto link - Line 915: Fixed source repository URL format - Lines 924, 946: Changed internal references to plain text - Line 1097: Changed internal reference to plain text - Line 1144: Changed xref link to plain text '签署 CLA' All problematic links have been fixed or converted to plain text where appropriate.
1 parent 6ffb236 commit 7304d6a

1 file changed

Lines changed: 13 additions & 12 deletions

File tree

CN/modules/ROOT/pages/master/contribution/contribution_guide.adoc

Lines changed: 13 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -40,7 +40,7 @@ IvorySQL由一个核心开发团队维护,该团队拥有对GitHub上的IvoryS
4040
* 发现 Bug、性能缺陷或文档不准确?
4141
* 有新的功能建议或使用体验改进?
4242

43-
如果您准备向社区上报 Bug 或者提交需求,请在 IvorySQL 社区对应的仓库上提交 Issue,并参考本指南的 xref:#_提_issue[提交 Issue] 章节。
43+
如果您准备向社区上报 Bug 或者提交需求,请在 IvorySQL 社区对应的仓库上提交 Issue,并参考本指南的"提交 Issue"章节。
4444

4545
==== 参与社区讨论
4646

@@ -109,8 +109,8 @@ IvorySQL 源码托管在 GitHub:<https://github.com/IvorySQL>。
109109

110110
在提交代码或文档贡献之前,为了确保代码合法合规,个人或企业贡献者需要签署贡献者许可协议(CLA)。签署 CLA 是 IvorySQL 社区接受贡献的必要条件,以确保您的贡献被合法分发。请根据下列链接下载 CLA 进行签署并将签署后的 CLA 发送至 cla@ivorysql.org。
111111

112-
* https://www.ivorysql.org/zh-CN/assets/files/individual_cla-a81f001209eb5ce0f8ea7c3be4cc69b5.pdf[个人贡献者]
113-
* https://www.ivorysql.org/zh-CN/assets/files/corporate_cla-76e89b6f17b0bc102cbc1105d438a917.pdf[企业贡献者]
112+
* https://www.ivorysql.org/zh-cn/assets/files/individual_cla-7703700da5e1ca8f26cb8a68f610d4f2.pdf[个人贡献者]
113+
* https://www.ivorysql.org/zh-cn/assets/files/corporate_cla-88aa01a7e770ecf89dc401f925c3438e.pdf[企业贡献者]
114114

115115
未签署 CLA 的 Pull Request 将无法进入评审阶段。
116116

@@ -157,13 +157,14 @@ IvorySQL社区提供的是中英文文档。英文文档保存在...文档存储
157157

158158
IvorySQL 作为一款基于 PostgreSQL 研发的 Oracle 兼容数据库,天然继承了 PostgreSQL 丰富的扩展生态。为了让更多的 PostgreSQL 生态组件能够在 IvorySQL 上稳定运行,IvorySQL 社区欢迎外部贡献者参与生态组件的适配工作。
159159

160-
适配工作主要包括:了解目标组件的特点、原理和使用方式,测试其在 IvorySQL 的 PG 模式和 Oracle 兼容模式下能否正常使用;最后基于上述调研与测试结果,编写一篇生态组件适配文档。详细步骤请参考 xref:#_生态组件适配_2[生态组件适配] 章节。
160+
适配工作主要包括:了解目标组件的特点、原理和使用方式,测试其在 IvorySQL 的 PG 模式和 Oracle 兼容模式下能否正常使用;最后基于上述调研与测试结果,编写一篇生态组件适配文档。详细步骤请参考"生态组件适配"章节。
161161

162162
==== 测试IvorySQL和报告问题
163163

164-
GitHub: https://github.com/IvorySQL/IvorySQL
164+
GitHub
165165

166-
​码云:https://gitee.com/IvorySQL/
166+
AtomGit:https://atomgit.com/IvorySQL/IvorySQL
167+
​码云
167168

168169

169170
==== 参与IvorySQL网站建设
@@ -177,7 +178,7 @@ IvorySQL官网下载:https://github.com/IvorySQL/Ivory-www
177178

178179
==== 贡献文章
179180

180-
您可以在IvorySQL-WWW代码仓库自己提交至blog贡献,也可以联系我们IvorySQL小助理发送至邮箱ivorysql@highgo.com 。
181+
您可以在IvorySQL-WWW代码仓库自己提交至blog贡献,也可以联系我们IvorySQL小助理发送至邮箱 mailto:ivorysql@highgo.com[ivorysql@highgo.com]
181182

182183
=== 如何做出贡献
183184

@@ -911,7 +912,7 @@ image::17.png[]
911912

912913
1、下载 https://markdown.com.cn/tools.html#%E7%BC%96%E8%BE%91%E5%99%A8[Markdown]或者 https://typoraio.cn/[Typora]文档编辑器。
913914

914-
​ 2、先下载博客源码到本地,检查源仓库(https://github.com/IvorySQL/Ivory-www)是否有更新, 如果有更新请先更新并同步到自己的仓库。请参阅以下步骤,更新至最新版本:
915+
​ 2、先下载博客源码到本地,检查源仓库 https://github.com/IvorySQL/Ivory-www 是否有更新,如果有更新请先更新并同步到自己的仓库。请参阅以下步骤,更新至最新版本:
915916

916917
``` bash
917918
# 拉取网站源码
@@ -920,7 +921,7 @@ git clone https://github.com/IvorySQL/Ivory-www.git
920921
git pull
921922
```
922923

923-
​ 3、熟悉样式风格 (<<#_规范说明_2>>)
924+
​ 3、熟悉样式风格(规范说明)
924925

925926
=== 贡献地方
926927

@@ -942,7 +943,7 @@ git clone https://github.com/IvorySQL/Ivory-www.git
942943
git checkout -b <branch-name>
943944
```
944945

945-
​ (3)在博客目录中创建自己文章的目录,目录名字规则参照 (<<#_规范说明_2>>)
946+
​ (3)在博客目录中创建自己文章的目录,目录名字规则参照规范说明
946947

947948
```bash
948949
# 生成英文博客目录及文件
@@ -1093,7 +1094,7 @@ image::13.png[]
10931094

10941095
如果您不满足于简单的在网页端进行提交或者仅修改网页内容,又或者您想要修改网页ui,本小节内容将会帮助到您。
10951096

1096-
在阅读本小节内容之前,您需要确认您的Github个人仓库是否已经 `fork` 了网页模板文件仓库和静态网页文件仓库,如果没有请参考<<#_如何贡献>>
1097+
在阅读本小节内容之前,您需要确认您的Github个人仓库是否已经 `fork` 了网页模板文件仓库和静态网页文件仓库,如果没有请参考"如何贡献"章节
10971098

10981099
=== 部署网页
10991100

@@ -1141,7 +1142,7 @@ IvorySQL 作为一款基于 PostgreSQL 研发的 Oracle 兼容数据库,天然
11411142

11421143
===== 签署 CLA
11431144

1144-
在提交文档贡献之前,请确保您已签署贡献者许可协议(CLA)。详情请参阅本指南的 xref:#_签署_cla[签署 CLA] 章节。
1145+
在提交文档贡献之前,请确保您已签署贡献者许可协议(CLA)。详情请参阅本指南的"签署 CLA"章节。
11451146

11461147
==== 第二步:环境准备
11471148

0 commit comments

Comments
 (0)