Skip to content

Commit 6ec42ad

Browse files
lightislostlightislost
committed
add new contribution page
1 parent e00051a commit 6ec42ad

File tree

13 files changed

+75
-42
lines changed

13 files changed

+75
-42
lines changed

content/en/docs/acknowledgements/d1.acknowledgements.md renamed to content/en/contribution/acknowledgements/d1.acknowledgements.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,9 +2,9 @@
22
title: Acknowledgements
33
slug: Acknowledgements
44
description: 介绍主要功能
5-
url: "docs/acknowledgements"
5+
url: "contribution/acknowledgements"
66
aliases:
7-
- "/docs/acknowledgements"
7+
- "/contribution/acknowledgements"
88
---
99

1010
The documentation homepage of CodeFuse-ai is built on [docura](https://github.com/docura/docura)

content/en/docs/acknowledgements/d1.contribution.md renamed to content/en/contribution/contribute/d1.contribution.md

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -2,14 +2,15 @@
22
title: Contribution Guide
33
slug: Contribution Guide
44
description: 介绍主要功能
5-
url: "docs/contribution-guide"
5+
url: "contribution/contribution-guide"
66
aliases:
7-
- "/docs/contribution-guide"
7+
- "/contribution/contribution-guide"
8+
- "/contribution"
89
---
910

1011

1112
<p align="left">
12-
<a href="/docs/contribution-guide-zh">中文</a>&nbsp ｜ &nbsp<a>English&nbsp </a>
13+
<a href="/contribution/contribution-guide-zh">中文</a>&nbsp ｜ &nbsp<a>English&nbsp </a>
1314
</p>
1415

1516

@@ -50,11 +51,11 @@ If you are interested in improving the quality of the documentation, whether it
5051
Most of our documentation is written in markdown format. You can directly modify and submit documentation changes in the docs/ directory on GitHub. For submitting code changes, please refer to Pull Requests.
5152

5253
### If You Discover a Bug or Issue
53-
If you discover a bug or issue, you can directly submit a new Issue through GitHub Issues, and someone will handle it regularly. For more details, see Issue Template.[Issue Template](/docs/issue-report)
54+
If you discover a bug or issue, you can directly submit a new Issue through GitHub Issues, and someone will handle it regularly. For more details, see Issue Template.[Issue Template](/contribution/issue-report)
5455

5556
You can also choose to read and analyze the code to fix it yourself (it is best to communicate with us before doing so, as someone might already be working on the same issue), and then submit a Pull Request.
5657

5758
### Modify Code and Submit a PR (Pull Request)
58-
You can download the code, compile, install, and deploy to try it out (you can refer to the compilation documentation to see if it works as you expected). If there are any issues, you can directly contact us, submit an Issue, or fix it yourself by reading and analyzing the source code. For more details, see[How to Submit a PR.](/docs/pull-request)
59+
You can download the code, compile, install, and deploy to try it out (you can refer to the compilation documentation to see if it works as you expected). If there are any issues, you can directly contact us, submit an Issue, or fix it yourself by reading and analyzing the source code. For more details, see[How to Submit a PR.](/contribution/pull-request)
5960

6061
Whether it's fixing a bug or adding a feature, we warmly welcome it. If you wish to submit code to Doris, you need to fork the code repository to your project space on GitHub, create a new branch for your submitted code, add the original project as an upstream, and submit a PR. The method for submitting a PR can be referenced in the Pull Request documentation.

content/en/docs/acknowledgements/d1.issue.md renamed to content/en/contribution/contribute/d1.issue.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2,14 +2,14 @@
22
title: Issue Report
33
slug: Issue Report
44
description: 介绍主要功能
5-
url: "docs/issue-report"
5+
url: "contribution/issue-report"
66
aliases:
7-
- "/docs/issue-report"
7+
- "/contribution/issue-report"
88
---
99

1010

1111
<p align="left">
12-
<a href="/docs/issue-report-zh">中文</a>&nbsp ｜ &nbsp<a>English&nbsp </a>
12+
<a href="/contribution/issue-report-zh">中文</a>&nbsp ｜ &nbsp<a>English&nbsp </a>
1313
</p>
1414

1515

content/en/docs/acknowledgements/d1.pr.md renamed to content/en/contribution/contribute/d1.pr.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2,14 +2,14 @@
22
title: Pull Request
33
slug: Pull Request
44
description: 介绍主要功能
5-
url: "docs/pull-request"
5+
url: "contribution/pull-request"
66
aliases:
7-
- "/docs/pull-request"
7+
- "/contribution/pull-request"
88
---
99

1010

1111
<p align="left">
12-
<a href="/docs/pull-request-zh">中文</a>&nbsp ｜ &nbsp<a>English&nbsp </a>
12+
<a href="/contribution/pull-request-zh">中文</a>&nbsp ｜ &nbsp<a>English&nbsp </a>
1313
</p>
1414

1515

content/zh/docs/acknowledgements/d1.acknowledgements.md renamed to content/zh/contribution/acknowledgements/d1.acknowledgements.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2,10 +2,10 @@
22
title: 致谢
33
slug: 致谢
44
description: 介绍主要功能
5-
url: "docs/致谢"
5+
url: "contribution/致谢"
66
aliases:
7-
- "/docs/致谢"
8-
- "/docs/zh-acknowledgements"
7+
- "/contribution/致谢"
8+
- "/contribution/zh-acknowledgements"
99
---
1010

1111
CodeFuse-ai 文档主页基于[docura](https://github.com/docura/docura)构建！

content/zh/docs/acknowledgements/d1.contribution.md renamed to content/zh/contribution/contribute/d1.contribution.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -2,15 +2,15 @@
22
title: 贡献指南
33
slug: 贡献指南
44
description: 介绍主要功能
5-
url: "docs/贡献指南"
5+
url: "contribution/贡献指南"
66
aliases:
7-
- "/docs/贡献指南"
8-
- "/docs/contribution-guide-zh"
7+
- "/contribution/贡献指南"
8+
- "/contribution/contribution-guide-zh"
99
---
1010

1111

1212
<p align="left">
13-
<a>中文</a>&nbsp ｜ &nbsp<a href="/docs/contribution-guide">English&nbsp </a>
13+
<a>中文</a>&nbsp ｜ &nbsp<a href="/contribution/contribution-guide">English&nbsp </a>
1414
</p>
1515

1616

@@ -49,12 +49,12 @@ aliases:
4949
我们的文档大多数是使用 markdown 格式编写的，您可以直接通过在 GitHub 中的 docs/ 中修改并提交文档变更。如果提交代码变更，可以参阅 Pull Request。
5050

5151
### 如果发现了一个 Bug 或问题
52-
如果发现了一个 Bug 或问题，您可以直接通过 GitHub 的 Issues 提一个新的 Issue，我们会有人定期处理。详情见[Issue模板](/docs/issuereport-zh)
52+
如果发现了一个 Bug 或问题，您可以直接通过 GitHub 的 Issues 提一个新的 Issue，我们会有人定期处理。详情见[Issue模板](/contribution/issuereport-zh)
5353

5454
您也可以通过阅读分析代码自己修复（当然在这之前最好能和我们交流下，或许已经有人在修复同样的问题了），然后提交一个 Pull Request。
5555

5656
### 修改代码和提交PR（Pull Request）
57-
您可以下载代码，编译安装，部署运行试一试（可以参考编译文档，看看是否与您预想的一样工作。如果有问题，您可以直接联系我们，提 Issue 或者通过阅读和分析源代码自己修复。详情见[如何提交pr](/docs/pull-request-zh)
57+
您可以下载代码，编译安装，部署运行试一试（可以参考编译文档，看看是否与您预想的一样工作。如果有问题，您可以直接联系我们，提 Issue 或者通过阅读和分析源代码自己修复。详情见[如何提交pr](/contribution/pull-request-zh)
5858

5959
无论是修复 Bug 还是增加 Feature，我们都非常欢迎。如果您希望给 Doris 提交代码，您需要从 GitHub 上 fork 代码库至您的项目空间下，为您提交的代码创建一个新的分支，添加源项目为upstream，并提交PR。 提交PR的方式可以参考文档 Pull Request。
6060

content/zh/docs/acknowledgements/d1.issue.md renamed to content/zh/contribution/contribute/d1.issue.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -2,15 +2,15 @@
22
title: 如何提交Issue
33
slug: 如何提交Issue
44
description: 介绍主要功能
5-
url: "docs/如何提交issue"
5+
url: "contribution/如何提交issue"
66
aliases:
7-
- "/docs/如何提交issue"
8-
- "/docs/issue-report-zh"
7+
- "/contribution/如何提交issue"
8+
- "/contribution/issue-report-zh"
99
---
1010

1111

1212
<p align="left">
13-
<a>中文</a>&nbsp ｜ &nbsp<a href="/docs/issue-report">English&nbsp </a>
13+
<a>中文</a>&nbsp ｜ &nbsp<a href="/contribution/issue-report">English&nbsp </a>
1414
</p>
1515

1616

content/zh/docs/acknowledgements/d1.pr.md renamed to content/zh/contribution/contribute/d1.pr.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -2,15 +2,15 @@
22
title: 如何提交PR
33
slug: 如何提交PR
44
description: 介绍主要功能
5-
url: "docs/如何提交pr"
5+
url: "contribution/如何提交pr"
66
aliases:
7-
- "/docs/pull-request-zh"
8-
- "/docs/如何提交pr"
7+
- "/contribution/pull-request-zh"
8+
- "/contribution/如何提交pr"
99
---
1010

1111

1212
<p align="left">
13-
<a>中文</a>&nbsp ｜ &nbsp<a href="/docs/pull-request">English&nbsp </a>
13+
<a>中文</a>&nbsp ｜ &nbsp<a href="/contribution/pull-request">English&nbsp </a>
1414
</p>
1515

1616

‎data/en/contribution/sidebar.yml‎

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
2+
3+
- title: ❤️ Contributing Guide
4+
pages:
5+
- title: Contribution Guide
6+
- title: Issue Report
7+
- title: Pull Request
8+
9+
- title: ❤️ Acknowledgments
10+
pages:
11+
- title: Acknowledgements

‎data/en/docs/sidebar.yml‎

Lines changed: 7 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -19,10 +19,11 @@
1919
- title: Start-Detail
2020
- title: LLM-Configuration
2121
- title: ChatBot-RoadMap
22-
- title: ❤️ Contributing Guide and Acknowledgments
23-
pages:
24-
- title: Contribution Guide
25-
- title: Issue Report
26-
- title: Pull Request
27-
- title: Acknowledgements
22+
23+
# - title: ❤️ Contributing Guide and Acknowledgments
24+
# pages:
25+
# - title: Contribution Guide
26+
# - title: Issue Report
27+
# - title: Pull Request
28+
# - title: Acknowledgements
2829

0 commit comments

Comments
 (0)