Skip to content

Commit

Permalink
[Doc] improve some doc and added localdebug doc (DataLinkDC#2816)
Browse files Browse the repository at this point in the history
* improve-some-doc-and-add-localdebug-doc

* delete flink1.13 doc
  • Loading branch information
Zzm0809 authored Dec 27, 2023
1 parent 59825fa commit 118d336
Show file tree
Hide file tree
Showing 18 changed files with 251 additions and 330 deletions.
8 changes: 4 additions & 4 deletions dinky-web/src/pages/RegCenter/Document/constans.ts
Original file line number Diff line number Diff line change
Expand Up @@ -217,10 +217,6 @@ export const DOCUMENT_SUBTYPE_ENUMS = {
* versions select options
*/
export const VERSIONS = [
{
text: 'Flink-1.13',
value: '1.13'
},
{
text: 'Flink-1.14',
value: '1.14'
Expand All @@ -237,6 +233,10 @@ export const VERSIONS = [
text: 'Flink-1.17',
value: '1.17'
},
{
text: 'Flink-1.18',
value: '1.18'
},
{
text: 'All Versions',
value: 'All Versions'
Expand Down
17 changes: 6 additions & 11 deletions docs/docs/developer_guide/contribution/commit_code.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
sidebar_position: 6
sidebar_position: 3
position: 3
id: commit_code
title: 提交代码须知
---
Expand All @@ -10,16 +11,10 @@ title: 提交代码须知

* 首先从远端仓库 *https://github.com/DataLinkDC/dlink.git* fork 一份代码到自己的仓库中

* 远端仓库中目前有三个分支:

* master 正常交付分支
发布稳定版本以后,将稳定版本分支的代码合并到 master 上。

* dev 日常开发分支
日常 dev 开发分支,新提交的代码都可以 pull request 到这个分支上。

* 0.6.0 发布版本分支
发布版本分支,后续会有 1.0... 等版本分支。
* 远端仓库中分支:
* dev 日常开发分支: 日常 dev 开发分支,新提交的代码都可以 pull request 到这个分支上。
* 0.7.x 发布版本分支: 0.7.x 发布版本分支,目前仅接受 bugfix
* 1.x.x 发布版本分支

* 把自己仓库 clone 到本地

Expand Down
7 changes: 2 additions & 5 deletions docs/docs/developer_guide/contribution/commit_message.md
Original file line number Diff line number Diff line change
@@ -1,14 +1,11 @@
---
sidebar_position: 5
sidebar_position: 3
position: 3
id: commit_message
title: Commit Message 须知
---






一个好的 commit message 是能够帮助其他的开发者(或者未来的开发者)快速理解相关变更的上下文,同时也可以帮助项目管理人员确定该提交是否适合包含在发行版中。但当我们在查看了很多开源项目的 commit log 后,发现一个有趣的问题,一部分开发者,代码质量很不错,但是 commit message 记录却比较混乱,当其他贡献者或者学习者在查看代码的时候,并不能通过 commit log 很直观的了解
该提交前后变更的目的,正如 Peter Hutterer 所言:Re-establishing the context of a piece of code is wasteful. We can’t avoid it completely, so our efforts should go to reducing it as much as possible. Commit messages can do exactly that and as a result, a commit message shows whether a developer is a good collaborator. 因此,DolphinScheduler 结合其他社区以及 Apache 官方文档制定了该规约。

Expand Down
10 changes: 4 additions & 6 deletions docs/docs/developer_guide/contribution/document.md
Original file line number Diff line number Diff line change
@@ -1,22 +1,20 @@
---
sidebar_position: 2
sidebar_position: 5
position: 5
id: document
title: 文档贡献
---




良好的使用文档对任何类型的软件都是至关重要的。欢迎任何可以改进 Dinky 文档的贡献。

### 获取文档项目

Dinky 项目的文档维护在 [dinky-website](https://github.com/DataLinkDC/dinky-website)
Dinky 项目的文档维护在 [dinky主仓库/docs 下](https://github.com/DataLinkDC/dinky/tree/dev/docs)

首先你需要先将源项目 fork 到自己的 github 仓库中,然后将 fork 的文档克隆到本地计算机中。

```shell
git clone https://github.com/<your-github-user-name>/dinky-website
git clone https://github.com/<your-github-user-name>/dinky
```
### 文档环境

Expand Down
3 changes: 2 additions & 1 deletion docs/docs/developer_guide/contribution/how_contribute.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
sidebar_position: 1
sidebar_position: 4
position: 4
id: how_contribute
title: 如何贡献
---
Expand Down
3 changes: 2 additions & 1 deletion docs/docs/developer_guide/contribution/issue.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
sidebar_position: 3
sidebar_position: 1
position: 1
id: issue
title: Issue 须知
---
Expand Down
3 changes: 2 additions & 1 deletion docs/docs/developer_guide/contribution/pull_request.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
sidebar_position: 4
sidebar_position: 2
position: 2
id: pull_request
title: Pull Request 须知
---
Expand Down
Loading

0 comments on commit 118d336

Please sign in to comment.