Skip to content

Commit 6666062

Browse files
gaoxueyugaoxueyu
authored
Merge pull request #121 from OreoYang/v4.4
update contribution guide and add README_zh
2 parents 3702a95 + f70ad06 commit 6666062

File tree

7 files changed

+750
-1
lines changed

7 files changed

+750
-1
lines changed

‎CN/modules/ROOT/images/14.png

1.99 KB
Loading

‎CN/modules/ROOT/nav.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -33,6 +33,6 @@
3333
** xref:v4.4/27.adoc[11、兼容Oracle sequence]
3434
** xref:v4.4/28.adoc[12、包]
3535
** xref:v4.4/29.adoc[13、不可见列]
36-
* xref:v4.4/23.adoc[社区贡献指南]
36+
* xref:v4.4/32.adoc[社区贡献指南]
3737
* xref:v4.4/24.adoc[工具参考]
3838
* xref:v4.4/25.adoc[FAQ]

‎CN/modules/ROOT/pages/v4.4/32.adoc

Lines changed: 83 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,83 @@
1+
2+
:sectnums:
3+
:sectnumlevels: 5
4+
5+
:imagesdir: ./_images
6+
= **IvorySQL社区贡献指南**
7+
8+
IvorySQL由一个核心开发团队维护，该团队拥有对GitHub上的IvorySQL主存储库的提交权限。同时，我们非常渴望从更广泛的IvorySQL社区中的成员那里获得贡献。如果您希望看到您的代码或文档更改被添加到IvorySQL并出现在将来的版本中，本节的内容介绍是您需要知道的。
9+
10+
​IvorySQL社区欢迎并赞赏所有类型的贡献，期待您的加入！
11+
12+
在参与社区贡献前，请先阅读并遵守 https://github.com/IvorySQL/IvorySQL/blob/master/CODE_OF_CONDUCT_CN.md[IvorySQL社区行为准则]。
13+
14+
== 注册Github账号
15+
16+
IvorySQL源码托管在github: <https://github.com/IvorySQL>。
17+
18+
请参考<https://docs.github.com/en/get-started/start-your-journey>注册您的github账号，并熟悉Git工具和工作流。
19+
20+
== 签署CLA
21+
22+
在提交代码或文档贡献之前，个人或企业贡献者需要签署贡献者许可协议(CLA)。签署CLA是IvorySQL社区接受贡献的必要条件，以确保您的贡献被合法分发。请根据下列链接下载CLA进行签署并将签署后的CLA发送至 cla@ivorysql.org。
23+
24+
* https://www.ivorysql.org/zh-CN/assets/files/individual_cla-a81f001209eb5ce0f8ea7c3be4cc69b5.pdf[个人贡献者]
25+
* https://www.ivorysql.org/zh-CN/assets/files/corporate_cla-76e89b6f17b0bc102cbc1105d438a917.pdf[企业贡献者]
26+
27+
未签署CLA的Pull Request将无法进入评审阶段。
28+
29+
== 找到您感兴趣的项目
30+
31+
您可以从如下列表中找到感兴趣的项目及其代码仓库
32+
33+
[cols="1,1"]
34+
|===
35+
|代码仓库 | 描述
36+
|https://github.com/IvorySQL/IvorySQL[IvorySQL] | 负责社区IvorySQL数据库的开发和维护
37+
|https://github.com/IvorySQL/Ivory-www[Ivory-www] | 负责社区的官网开发和维护
38+
|https://github.com/IvorySQL/ivory-operator[ivory-operator] | 负责IvorySQL云原生数据库及周边工具开发和维护
39+
|https://github.com/IvorySQL/docker_library[docker_library] | 负责IvorySQL多架构的镜像构建开发和维护
40+
|https://github.com/IvorySQL/ivory-cloud[ivory-cloud] | 负责IvorySQL云服务平台及周边生态开发和维护
41+
|https://github.com/IvorySQL/ivorysql_docs[Ivorysql_docs] | 负责社区的文档中心开发和维护
42+
|https://github.com/IvorySQL/ivory-doc-builder[ivory-doc-builder] | 负责Ivorysql_docs的编译
43+
|https://github.com/IvorySQL/ivorysql_web[Ivorysql_web] | 负责社区的文档中心网站维护
44+
|https://github.com/IvorySQL/ivorysql-wasm[Ivorysql_wasm] | 负责IvorySQL在线易用体验网站的开发和维护
45+
|===
46+
47+
== 开始您的贡献
48+
49+
=== 提交Issue
50+
如果您准备向社区上报 Bug 或者提交需求，请在 IvorySQL 社区对应的仓库上提交 Issue，并参考Issue xref:./33.adoc[提交指南]。
51+
52+
=== 给自己分配Issue
53+
您可以将自己创建的Issue或者愿意处理的Issue分配给自己。 只需要在评论框内输入/assign，机器人就会将问题分配给您。 每个 Issue 下面可能已经有参与者的交流和讨论，如果您感兴趣，也可以在评论框中发表自己的意见参与 Issue 讨论。
54+
55+
=== 提交Pull Request
56+
对于提交一个PR应该保持一个功能，或者一个bug提交一次。禁止多个功能一次提交。
57+
58+
59+
==== 第1步：创建一个Pull Request
60+
61+
1、打开你 Fork 的仓库： https://github.com/$user/$repo_addr （将 $user 替换为你的 GitHub ID）。
62+
63+
​2、点击 Compare & pull request 按钮
64+
65+
==== 第2步：填写PR信息
66+
67+
```
68+
Fix test
69+
功能描述
70+
```
71+
72+
```
73+
leave a comment
74+
对该提交功能进行比较详细的描述
75+
```
76+
77+
==== 第3步：提交PR
78+
79+
点击Create pull request 按钮即可提交。
80+
81+
82+
== 致谢
83+
我们欢迎所有人参与 IvorySQL 社区贡献，我们的目标是发展一个由贡献者组成的活跃、健康的社区。

‎CN/modules/ROOT/pages/v4.4/33.adoc

Lines changed: 88 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,88 @@
1+
2+
:sectnums:
3+
:sectnumlevels: 5
4+
5+
:imagesdir: ./_images
6+
= **问题提交指南**
7+
发现并提交问题，也是对社区良好的贡献方式。
8+
9+
本文详细描述如何提交一个问题。
10+
11+
以IvorySQL为例，提交一个bug report
12+
13+
== 确认问题所属仓库
14+
IvorySQL仓库： https://github.com/IvorySQL/IvorySQL
15+
16+
== **创建新的Issue**
17+
18+
=== 第1步 进入New issue 页面：
19+
20+
点击New issue
21+
22+
image::p3.png[]
23+
24+
25+
=== 第2步：选择需要填写的issue类型
26+
27+
**1、bug report**
28+
29+
```
30+
Title: 标题
31+
```
32+
33+
```
34+
## Bug Report
35+
对bug进行描述
36+
37+
38+
### IvorySQL Version
39+
在IvorySQL哪个版本发现的问题
40+
41+
### OS Version (uname -a)
42+
系统版本
43+
44+
### Configuration options ( config.status --config )
45+
配置参数
46+
47+
### Current Behavior
48+
当前的结果
49+
50+
### Expected behavior/code
51+
期望的结果
52+
53+
### Step to reproduce
54+
复现步骤
55+
56+
### Additional context that can be helpful for identifying the problem
57+
有助于识别问题的其它信息
58+
```
59+
60+
61+
**2、Enhancement**
62+
63+
```
64+
Title: 标题
65+
```
66+
67+
```
68+
## Enhancement
69+
对于期望强化的功能作一个描述
70+
```
71+
72+
**3、Feature Request**
73+
74+
```
75+
Title: 标题
76+
```
77+
78+
```
79+
## Feature Request
80+
描述你期望实现的一个功能
81+
```
82+
83+
84+
=== 第3步：提交
85+
86+
点击 submit new issue 按钮, 提交即可。
87+
88+
提交问题以后，如果问题的描述和复现步骤清晰明确和可定位，会有人直接定位和解决该问题。但也有可能会出现，负责跟进该问题的开发者需要您提供更加详细的信息的情况，也感谢您的配合。

‎EN/modules/ROOT/images/14.png

1.99 KB
Loading

‎README_zh.md

Lines changed: 107 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,107 @@
1+
# Ivorysql_docs
2+
3+
简体中文 | [English](./README.md)
4+
5+
## 介绍
6+
7+
欢迎来到IvorySQL社区文档的仓库。此仓库提供[IvorySQL文档中心](https://docs.ivorysql.org/cn/index.html)呈现的所有文档，包括发行说明、IvorySQL入门、IvorySQL高级、IvorySQL生态、IvorySQL架构设计、Oracle兼容功能列表、社区贡献指南、工具参考、FAQ等内容。
8+
## 贡献
9+
10+
我们非常欢迎您贡献文档！如果想要参与，请阅读[贡献范围](#贡献范围)、遵守文档写作[规范说明](#规范说明)、按照流程规则提交。审核通过后，修改会在社区的文档中心中呈现。
11+
12+
同时，如果您对文档有任何意见或建议，请在Issue中提交。
13+
14+
## 准备工作
15+
16+
（1）下载Asciidoc或者Typora文档编辑器。
17+
18+
（2）检查源仓库是否有更新，如果有更新请先更新并同步到自己的仓库。如有更新请参阅以下步骤，更新至最新版本：
19+
20+
```
21+
git remote
22+
23+
git fetch upstream
24+
25+
git merge upstream/main
26+
27+
git push
28+
```
29+
30+
（3）熟悉[文档写作规范](#规范说明)
31+
32+
## 贡献范围
33+
34+
IvorySQL社区提供双语文档。英文文档保存在EN/中，中文文档保存在CN/中。您可以为任何一方文档做出贡献，当然您也可以为两方同时做出贡献。
35+
36+
​ 您可以从以下任何一项开始，以帮助改进[IvorySQL文档中心](https://docs.ivorysql.org)上的文档：
37+
38+
​ (1) 编写完善文档
39+
40+
​ (2) 修复拼写错误或格式（标点符号、空格、缩进、代码块等）
41+
42+
​ (3) 修正或更新不当或过时的说明
43+
44+
​ (4) 添加缺少的内容（句子、段落或新文档）
45+
46+
​ (5) 将文档更改从英文翻译成中文，或从中文翻译成英文。
47+
48+
​ (6) 提交、回复和解决文档问题
49+
50+
​ (7) （高级）查看其他人创建的拉取请求
51+
52+
## 规范说明
53+
54+
IvorySQL文档是用“asciidoc”编写，具体请参考[adoc规范](./adoc_syntax_quick_reference.md)。
55+
56+
## 本地网页生成
57+
通过之前的内容，您就可以进行文档贡献，最终push到您个人的ivorysql_docs仓库中。
58+
59+
另外，您可能需要知道网页对应的ui的位置，如下图：
60+
61+
![image](CN/modules/ROOT/images/15.png)
62+
63+
中英文的网页ui模板基本一致，因此修改时应该尽量保证同时修改两个模板。
64+
65+
如果您文档贡献修改的内容较多，建议在提交PR前，先在本地进行预览，具体步骤如下：
66+
67+
### 环境准备
68+
69+
安装Node.js
70+
```
71+
sudo yum install -y nodejs
72+
sudo npm install -g serve@14.2.4
73+
```
74+
安装Antora
75+
```
76+
npm install antora@3.1.7
77+
npm install @antora/pdf-extension
78+
npm install @antora/lunr-extension
79+
npm install nodejieba
80+
npm install @asciidoctor/core asciidoctor-pdf
81+
npx antora -v
82+
alias antora='npx antora' #将npx antora更名为antora
83+
antora -v
84+
```
85+
最终，在终端上显示如下即为成功安装。
86+
87+
![image](CN/modules/ROOT/images/14.png)
88+
89+
90+
### 编译步骤
91+
92+
文档中心是由 `Antora` 进行搭建的，doc-builder仓库负责编译：
93+
* `fork` [doc-builder仓库](https://github.com/IvorySQL/ivory-doc-builder)
94+
* `clone` doc-builder仓库到本地
95+
96+
`git clone https://github.com/yourname/ivory-doc-builder.git`
97+
* doc-builder 编译
98+
99+
`antora generate --to-dir ../demo antora-playbook-CN.yml --stacktrace`
100+
101+
然后耐心等待，当成功运行结束后，你就可以到../demo 中查看自己生成的网页了。
102+
103+
检查之后，你就可以开始提交[PR](https://github.com/IvorySQL/ivorysql_docs/blob/v4.4/CN/modules/ROOT/pages/v4.4/32.adoc)，感谢您对社区的贡献^ _ ^，我们会在审核过后，考虑是否更新网站。
104+
105+
## Autobuild
106+
107+
在Ivorysql-docs的仓库中提交的每一个PR, PR会话中会分别产生中文/英文的Deploy Preview链接，点击链接即可实现预览。

0 commit comments

Comments
 (0)