This is an automated email from the ASF dual-hosted git repository.
casion pushed a commit to branch dev
in repository https://gitbox.apache.org/repos/asf/incubator-linkis-website.git
The following commit(s) were added to refs/heads/dev by this push:
new 73a1f1bf16 Repair some community docs format (#565)
73a1f1bf16 is described below
commit 73a1f1bf1659954af22ebe7fdd716c0deee17a0b
Author: 成彬彬 <[email protected]>
AuthorDate: Sat Nov 5 16:21:36 2022 +0800
Repair some community docs format (#565)
---
community/how-to-ask-for-help.md | 6 ++--
community/how-to-contribute-to-website.md | 2 +-
community/how-to-contribute.md | 38 +++++++++-------------
community/how-to-email.md | 4 +--
.../how-to-participate-in-developer-meetings.md | 2 +-
community/how-to-release.md | 24 +++++++-------
community/how-to-sign-apache-icla.md | 4 +--
community/how-to-verify.md | 4 +--
community/how-to-vote-a-committer-ppmc.md | 6 ++--
community/ppmc-related-permission-configuration.md | 2 +-
community/site-map.md | 2 +-
.../current/how-to-contribute.md | 10 +++---
12 files changed, 48 insertions(+), 56 deletions(-)
diff --git a/community/how-to-ask-for-help.md b/community/how-to-ask-for-help.md
index 36cb1d3b0f..17442717c3 100644
--- a/community/how-to-ask-for-help.md
+++ b/community/how-to-ask-for-help.md
@@ -19,7 +19,7 @@ step2 Copy the template content
-->
-## Method 1 Github-Issue ask questions (recommended)
+## Method 1 Github-issue ask questions (recommended)
### Precautions
:::caution note
@@ -41,7 +41,7 @@ In many browsers you can copy and paste the image directly
into the box
The log file should not exceed 25MB
:::
-### Completion Instructions
+### Completion instructions
- Entry: https://github.com/apache/incubator-linkis/issues
** Step1: Enter the issue column, click to create issue **
@@ -66,7 +66,7 @@ The log file should not exceed 25MB
-## Method 2 Email consultation
+## Method 2 email consultation
Email Question Process
diff --git a/community/how-to-contribute-to-website.md
b/community/how-to-contribute-to-website.md
index 955bd0c2db..a098010a39 100644
--- a/community/how-to-contribute-to-website.md
+++ b/community/how-to-contribute-to-website.md
@@ -103,7 +103,7 @@ Positive example: `render-dom.js / signup.css / index.html
/ company-logo.png`
Counter example: `renderDom.js / UserManagement.html`
-### 3.3 Resource Path
+### 3.3 Resource path
Image resources are unified under `static/{module name}`
diff --git a/community/how-to-contribute.md b/community/how-to-contribute.md
index 3b7b1680e7..a25d367305 100644
--- a/community/how-to-contribute.md
+++ b/community/how-to-contribute.md
@@ -4,14 +4,6 @@ sidebar_position: 2
---
# Contributing
-| **Version Management Information Form** | |
-| ----------- | --------------------------------- |
-| Current version | Version 1.2 |
-| Current version release date | December 17, 2021 |
-| Revision information | 1. Due to the transfer of the git repository to
apache and the migration of Linkis-Doc documents to the linkis official
website, corresponding links were modified |
-
-Thank you very much for contributing to the Linkis project! Before
participating in the contribution, please read the following guidelines
carefully.
-
## 1. Contribution category
### 1.1 Bug feedback and fixes
@@ -26,7 +18,7 @@ In the communication process, a detailed description,
mechanisms and usage scena
Helping answering the questions in the Linkis community is a very valuable way
to contribute; there will always be new users in the community that will keep
coming in. While helping new users, you can also show your expertise.
-### 1.4 Documentation Refinements
+### 1.4 Documentation refinements
You can find linkis documentations at
[linkis-Website](https://linkis.apache.org/docs/latest/introduction), and the
supplement of the document is also crucial to the development of Linkis.
@@ -35,7 +27,7 @@ Including participating in and helping to organize community
exchanges, communit
---
-## 2. How to Contribution
+## 2. How to contribution
### 2.1 Branch structure
@@ -111,7 +103,7 @@ git push
Please note: The dev branch of major features will be named with corresponding
naming instructions in addition to the version number, such as:
dev-0.10.0-flink, which refers to the flink feature development branch of
0.10.0.
-### 2.2 Development Guidelines
+### 2.2 Development guidelines
Linkis front-end and back-end code share the same code base, but they are
separated in development. Before starting the development, please fork the
Linkis project to your Github Repositories. When developing, please develop
based on the Linkis code base in your Github Repositories.
@@ -159,7 +151,7 @@ The user configuration is in the project root directory
/config/, the project st
├── logs # log root directory
```
-##### 2.2.1.2 Environment Variables
+##### 2.2.1.2 Environment variables
Configure system environment variable or IDE environment variable
LINKIS_HOME, it is recommended to use IDE environment variable first.
@@ -182,7 +174,7 @@ Modify the `application.yml` file in the resources/
directory of each microservi
- Issue name, which should briefly describe your problem or suggestion in one
sentence; for the international promotion of the project, please write the
issue in English or both Chinese and English.
- For each Issue, please bring at least two labels, component and type, such
as component=Computation Governance/EngineConn, type=Improvement. Reference:
[issue #590](https://github.com/apache/incubator-linkis/issues/590)
-### 2.3 Pull Request(PR) Submission Guidelines
+### 2.4 Pull Request(PR) submission guidelines
- If you still don’t know how to initiate a PR to an open source project,
please refer to [About pull
requests](https://docs.github.com/en/github/collaborating-with-issues-and-pull-requests/about-pull-requests)
Whether it is a bug fix or a new feature development, please submit a PR to
the dev-* branch.
@@ -191,11 +183,11 @@ Modify the `application.yml` file in the resources/
directory of each microservi
- If this PR is not ready to merge, please add [WIP] prefix to the head of the
name (WIP = work-in-progress).
- All submissions to dev-* branches need to go through at least one review
before they can be merged
-### 2.4 Review Standard
+### 2.5 Review standard
Before contributing code, you can find out what kind of submissions are
popular in Review. Simply put, if a submission can bring as many gains as
possible and as few side effects or risks as possible, the higher the
probability of it being merged, the faster the review will be. Submissions with
high risk and low value are almost impossible to merge, and may be rejected
Review.
-#### 2.4.1 Gain
+#### 2.5.1 Gain
- Fix the main cause of the bug
- Add or fix a function or problem that a large number of users urgently need
@@ -204,7 +196,7 @@ Before contributing code, you can find out what kind of
submissions are popular
- Reduce complexity and amount of code
- Issues that have been discussed by the community and identified for
improvement
-#### 2.4.2 Side effects and risks
+#### 2.5.2 Side effects and risks
- Only fix the surface phenomenon of the bug
- Introduce new features with high complexity
@@ -215,7 +207,7 @@ Before contributing code, you can find out what kind of
submissions are popular
- Change the dependency version at will
- Submit a large number of codes or changes at once
-#### 2.4.3 Reviewer notes
+#### 2.5.3 Reviewer notes
- Please use a constructive tone to write comments
- If you need to make changes by the submitter, please clearly state all the
content that needs to be modified to complete the Pull Request
@@ -223,11 +215,11 @@ Before contributing code, you can find out what kind of
submissions are popular
---
-##3, Outstanding Contributor
+## 3, Outstanding contributor
-### 3.1 About Committers (Collaborators)
+### 3.1 About committers (Collaborators)
-#### 3.1.1 How to become Committer
+#### 3.1.1 How to become committer
If you have submitted a valuable PR to Linkis and have been merged, or
contributed continuously for more than half a year, and have led the release of
at least one version, you can find a PMC of the Linkis project through the
official WeChat group, if he is willing to nominate you as a committer , And
are willing to state your contribution to all PMC and Committer, then a vote
will be initiated; PMC and other Committers will vote together to decide
whether to allow you to join, if you ge [...]
@@ -239,13 +231,13 @@ If you have submitted a valuable PR to Linkis and have
been merged, or contribut
- You can review the PR submitted to the dev-* branch
- Can apply to become a Committee member
-### 3.2 About Committee
+### 3.2 About committee
-#### 3.2.1 How to become a Committee member
+#### 3.2.1 How to become a committee member
If you are the Committer of the Linkis project, and all your contributions
have been recognized by other Committee members, you can apply to become a
member of the Linkis Committee, and other Committee members will vote together
to decide whether to allow you to join. If you pass unanimously, you will
become a member of the Linkis Committee.
-#### 3.2.2 Rights of Committee members
+#### 3.2.2 Rights of committee members
- You can merge PRs submitted by other Committers and contributors to the
dev-** branch
- Participate in determining the roadmap and development direction of the
Linkis project
diff --git a/community/how-to-email.md b/community/how-to-email.md
index 34447dc2ca..8d7e10e37f 100644
--- a/community/how-to-email.md
+++ b/community/how-to-email.md
@@ -21,7 +21,7 @@ The subject of the email can be roughly divided into the
following types
-## 2. Mail Specifications
+## 2. Mail specifications
:::caution general specification
- Whenever possible do not send plain HTML messages, but plain text. If you
use QQ mailbox, its email content is in html format by default. Please switch
to plain text text format when writing. For detailed switching instructions,
see the appendix of this article.
- Developers/community users/PPMC members initiate email discussions/needs for
help/notifications for the content of the above scenarios, please send them to
[email protected]
@@ -80,7 +80,7 @@ From the determination of a version to the release, it may
involve specific comm
4. New committer/ppmc votes need to be sent to [email protected]. See
https://community.apache.org/newcommitter.html for the new committee/ppmc
selection process
-## 5. How to Reply to Version Release Voting Emails
+## 5. How to reply to version release voting emails
If a release vote is initiated, after verification (see [How to
verify](how-to-verify.md) for the detailed verification process), you can refer
to this reply example for email reply
If you initiate a posting vote, you can refer to this response example to
reply to the email after verification
diff --git a/community/how-to-participate-in-developer-meetings.md
b/community/how-to-participate-in-developer-meetings.md
index a2fffa6084..2befbbd901 100644
--- a/community/how-to-participate-in-developer-meetings.md
+++ b/community/how-to-participate-in-developer-meetings.md
@@ -3,7 +3,7 @@ title: How to Participate in Developer Meetings
sidebar_position: 2.2
---
-# How to Participate in Developer Meetings
+# How to Participate in developer meetings
## Introduction to developer meetings
diff --git a/community/how-to-release.md b/community/how-to-release.md
index 85d8838629..c1a4474dfd 100644
--- a/community/how-to-release.md
+++ b/community/how-to-release.md
@@ -3,7 +3,7 @@ title: How to Release
sidebar_position: 3
---
-# Apache Publishing Guide
+# Apache publishing guide
> This article takes the release of 1.0.3 Apache version as an example. If it
> is a non-Apache version, please refer to the [detailed
> information](https://incubator.apache.org/guides/releasemanagement.html)
> https://incubator.apache.org/guides/releasemanagement.html
Understand the content and process of Apache's release. Source Release is the
focus of Apache’s attention and is also a required content for release; Binary
Release is optional. Please refer to the following link to find more ASF
release guidelines:
@@ -135,7 +135,7 @@ Go directly to https://keyserver.ubuntu.com/ and enter the
username mingXiao to
- Linkis Release branch
https://dist.apache.org/repos/dist/release/incubator/linkis
-#### 1.5.1 Add public key to KEYS in dev branch
+#### 1.5.1 Add public key to keys in dev branch
Used to release RC version
@@ -155,7 +155,7 @@ $ svn add KEYS
$ svn ci -m "add gpg key for YOUR_NAME"
```
-#### 1.5.2 Add public key to KEYS in release branch
+#### 1.5.2 Add public key to keys in release branch
Used to release the official version
@@ -217,9 +217,9 @@ For encryption settings, please refer to
[here](http://maven.apache.org/guides/m
```
-## 2 Prepare material package & release of Apache Nexus
+## 2 Prepare material package & release of apache nexus
-### 2.1 Prepare branch/Tag/Release Notes
+### 2.1 Prepare branch/tag/\release notes
Pull the new branch from the branch to be released as the branch to be
released. If you want to release the $`{release_version}` version now, check
out the new branch `release-${release_version}-${condition_version}` from the
branch to be released, and all after that The operations are all performed on
the `release-${release_version}-${condition_version}` branch, and merge into
the main branch after the final release is completed.
@@ -272,7 +272,7 @@ Archives: 0
If it is not 0, you need to confirm whether there is a license for the binary
or compressed file in the source code. You can refer to
`linkis-engineconn-plugins/python/src/main/py4j/py4j-0.10.7- src.zip`
</font>
-### 2.3 Publish jar package to Apache Nexus repository
+### 2.3 Publish jar package to apache nexus repository
```shell
# Start to compile and upload, it takes about 1h40min
$ mvn -DskipTests deploy -Prelease -Dmaven.javadoc.skip=true
@@ -392,7 +392,7 @@ The detailed verification process can be found in
[Verification Candidate Versio
-## 3 Publish the Apache SVN repository
+## 3 Publish the apache svn repository
- The Linkis [DEV
branch](https://dist.apache.org/repos/dist/dev/incubator/linkis) is used to
store the source code and binary materials of the candidate version
- The RC version voted by the Linkis [Release
branch](https://dist.apache.org/repos/dist/release/incubator/linkis) will
eventually be moved to the release library
@@ -406,7 +406,7 @@ $ svn co
https://dist.apache.org/repos/dist/dev/incubator/linkis dist/linkis_svn
```
-### 3.2 Add the content to be published to the SVN directory
+### 3.2 Add the content to be published to the svn directory
Create a version number directory and name it in the way of
`${release_version}-${RC_version}`, RC_version starts from 1, that is, the
candidate version starts from RC1. During the release process, there is a
problem that causes the vote to be rejected, and it needs to be corrected and
iterated. RC version, RC version number should be +1.
For example: 1.0.3-RC1 version is voted, if the vote is passed without any
problems, the RC1 version material will be released as the final version
material.
@@ -422,7 +422,7 @@ Add the source code package, binary package, and Linkis
executable binary packag
$ cp -f dist/apache-linkis/* dist/linkis_svn_dev/1.0.3-RC1
```
-### 3.3 Submit Apache SVN
+### 3.3 Submit apache svn
```shell
$ cd dist/linkis_svn_dev/
@@ -438,7 +438,7 @@ $ svn commit -m "prepare for 1.0.3-RC1"
```
If Chinese garbled characters appear in the svn command, you can try to set
the encoding format (set the encoding format: export LANG=en_US.UTF-8).
-## 4 Verify Release Candidates
+## 4 Verify release candidates
For details, please refer to [How to Verify release](/how-to-verify.md)
@@ -465,7 +465,7 @@ The DISCLAIMER-WIP disclaimer is currently used, please add
this description `As
- To vote in the Linkis community, send a voting email to
`[email protected]`. PMC needs to check the correctness of the version
according to the document, and then vote. After at least 72 hours have passed
and three `+1 PMC member` votes have been counted, you can enter the next stage
of voting.
- Announce the results of the voting and send an email to the result of the
voting to `[email protected]`.
-#### 5.1.1 Linkis Community Voting Template
+#### 5.1.1 Linkis community voting template
```html
title:
@@ -658,7 +658,7 @@ $ svn cp
https://dist.apache.org/repos/dist/dev/incubator/linkis/KEYS https://di
$ svn delete
https://dist.apache.org/repos/dist/release/incubator/linkis/${last_release_version}
-m "Delete ${last_release_version}"
````
-### 6.3 Release version in Apache Staging repository
+### 6.3 Release version in apache staging repository
- Log in to http://repository.apache.org , log in with your Apache account
- Click on Staging repositories on the left,
diff --git a/community/how-to-sign-apache-icla.md
b/community/how-to-sign-apache-icla.md
index cddd746e17..ecad132b1f 100644
--- a/community/how-to-sign-apache-icla.md
+++ b/community/how-to-sign-apache-icla.md
@@ -3,7 +3,7 @@ title: ICLA Signing Process
sidebar_position: 7
---
-## Apache Sign ICLA Guide {#apache-sign-icla-guide}
+## Apache sign icla guide {#apache-sign-icla-guide}
Note: This article refers to the Apache icla signing process guide document of
the incubator-shenyu-website project https://shenyu.apache.org/community/icla
Apache CLA short for Apache Contributor License Agreement, the purpose of this
agreement is to clearly define the terms under which intellectual property has
been contributed to the ASF and thereby allow us to defend the project should
there be a legal dispute regarding the software at some future time.
@@ -52,7 +52,7 @@ Here is a specific example:
**6.After the email is sent successfully, Apache ShenYu official community
informs**
-## Manual signature and PDF software signature Demo
{#manual-signature-and-pdf-software-signature-demo}
+## Manual signature and PDF software signature demo
{#manual-signature-and-pdf-software-signature-demo}
> PDF online signature
> - Download the PDF source file
diff --git a/community/how-to-verify.md b/community/how-to-verify.md
index dca114b64a..be89476429 100644
--- a/community/how-to-verify.md
+++ b/community/how-to-verify.md
@@ -3,7 +3,7 @@ title: How to Verify Release
sidebar_position: 4
---
-# Verify the Candidate Version
+# Verify the candidate version
For detailed check list, please refer to the official [check
list](https://cwiki.apache.org/confluence/display/INCUBATOR/Incubator+Release+Checklist)
@@ -120,7 +120,7 @@ $ tar -xvf
apache-linkis-${release_version}-incubating-src.tar.gz
$ cd apache-linkis-${release_version}-incubating-src
```
-#### 2.4.1 ASF License RAT Check
+#### 2.4.1 Asf license rat check
Mac OS/Linux
```shell
#normally can be executed within 5 minutes
diff --git a/community/how-to-vote-a-committer-ppmc.md
b/community/how-to-vote-a-committer-ppmc.md
index f8bb45fc67..c584154702 100644
--- a/community/how-to-vote-a-committer-ppmc.md
+++ b/community/how-to-vote-a-committer-ppmc.md
@@ -4,7 +4,7 @@ sidebar_position: 6
---
> Introduce the selection requirements and process for Committer and PPMC.
> Official guidelines can be found at:
> https://incubator.apache.org/guides/ppmc.html
-## 1. Candidate Requirements
+## 1. Candidate requirements
When voting, all PPMC members need to decide for themselves whether candidates
should be approved as committers. This can be done by searching the [mailing
list](https://lists.apache.org/[email protected])/[ISSUES/PR](https://github.com/apache/incubator-linkis/issues
)/[Official Website Documentation
Contribution](https://github.com/apache/incubator-linkis-website) to understand
how candidates interact with others, and the contributions they make (code or
documentation patches, [...]
Below are some points to consider when evaluating candidates for commitment
eligibility.
@@ -207,7 +207,7 @@ Hello Joe Bloggs,
The Apache Linkis(Incubating) PPMC
````
-### 2.6 Invitation Acceptance Process
+### 2.6 Invitation acceptance process
>Requires candidates for processing
The new Committer should reply to `[email protected]` (select `reply
all`) and express his/her acceptance of the invitation.
@@ -240,7 +240,7 @@ In a few days, new committers will receive an email
confirming account creation
After receiving the notification email that the account was created
successfully, you can reply to the previous invitation email again to inform
Linkis PPMC that your Apache Id account has been created, and request that your
Apache Id be added to Linkis' official submitter list.
(Inform the PPMC responsible for nominating you to add the new committer to
the official committer list via the
[Roster](https://whismy.apache.org/roster/committee/linkis) page)
-### 2.7 Setting up Apache ID and development environment
+### 2.7 Setting up apache id and development environment
>Requires candidates for processing
- Enter [Apache Account Utility Platform] (https://id.apache.org/), create a
password, set up a personal email address (`forwarding email address`) and a
GitHub account (`Your GitHub Username`).
diff --git a/community/ppmc-related-permission-configuration.md
b/community/ppmc-related-permission-configuration.md
index 60b7384a33..36243779c9 100644
--- a/community/ppmc-related-permission-configuration.md
+++ b/community/ppmc-related-permission-configuration.md
@@ -73,7 +73,7 @@ After the successful invitation, the personal github account
information can be
-### 1.5 Related Links Documentation
+### 1.5 Related links documentation
[github uses TOTP to enable 2FA authentication]
https://docs.github.com/cn/authentication/securing-your-account-with-two-factor-authentication-2fa/configuring-two-factor-authentication
[Create a private token]
https://docs.github.com/cn/authentication/keeping-your-account-and-data-secure/creating-a-personal-access-token
diff --git a/community/site-map.md b/community/site-map.md
index 48650ce79b..6b613c601c 100644
--- a/community/site-map.md
+++ b/community/site-map.md
@@ -3,7 +3,7 @@ title: Site Map
sidebar_position: 12
---
-## Related Links
+## Related links
- Successful Graduation Guide
https://incubator.apache.org/guides/graduation.html
diff --git
a/i18n/zh-CN/docusaurus-plugin-content-docs-community/current/how-to-contribute.md
b/i18n/zh-CN/docusaurus-plugin-content-docs-community/current/how-to-contribute.md
index 44c773091a..84702ed5ed 100644
---
a/i18n/zh-CN/docusaurus-plugin-content-docs-community/current/how-to-contribute.md
+++
b/i18n/zh-CN/docusaurus-plugin-content-docs-community/current/how-to-contribute.md
@@ -182,7 +182,7 @@ git push origin dev-fix dev-fix
- Issue 名称，应一句话简单描述您的问题或建议；为了项目的国际化推广，请用英文，或中英文双语书写 issue.
- 每个Issue，请至少带上component 和type 两个label，如component=Computation
Governance/EngineConn，type=Improvement.参考:[issue
#590](https://github.com/apache/incubator-linkis/issues/590)
-### 2.3 Pull Request(PR) 提交指引
+### 2.4 Pull Request(PR) 提交指引
- 如果您还不知道怎样向开源项目发起 PR，请参考[About pull
requests](https://docs.github.com/en/github/collaborating-with-issues-and-pull-requests/about-pull-requests)
- 无论是 Bug 修复，还是新功能开发，请将 PR 提交到 dev-* 分支。
@@ -191,11 +191,11 @@ git push origin dev-fix dev-fix
- 如果本次 PR 尚未准备好合并，请在名称头部加上 [WIP] 前缀（WIP = work-in-progress）。
- 所有提交到 dev-* 分支的提交至少需要经过一次 Review 才可以被合并
-### 2.4 Review 标准
+### 2.5 Review 标准
在贡献代码之前，可以了解一下什么样的提交在 Review
中是受欢迎的。简单来说，如果一项提交能带来尽可能多增益和尽可能少的副作用或风险，那它被合并的几率就越高，Review
的速度也会越快。风险大、价值低的提交是几乎不可能被合并的，并且有可能会被拒绝 Review。
-#### 2.4.1 增益
+#### 2.5.1 增益
- 修复导致 Bug 的主要原因
- 添加或修复一个大量用户亟需的功能或问题
@@ -204,7 +204,7 @@ git push origin dev-fix dev-fix
- 减少复杂度以及代码量
- 经社区讨论过的、确定需要改进的问题
-#### 2.4.2 副作用和风险
+#### 2.5.2 副作用和风险
- 仅仅修复 Bug 的表面现象
- 引入复杂度高的新功能
@@ -215,7 +215,7 @@ git push origin dev-fix dev-fix
- 随意改变依赖版本
- 一次性提交大量代码或改动
-#### 2.4.3 Reviewer 注意事项
+#### 2.5.3 Reviewer 注意事项
- 请使用建设性语气撰写评论
- 如果需要提交者进行修改，请明确说明完成此次 Pull Request 所需要修改的所有内容
---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]
