Skip to content

Commit d951099

Browse files
committed
解决合并冲突,保留中文翻译版本
Signed-off-by: cchongyang <[email protected]>
2 parents 96f1e8b + baca1ea commit d951099

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

59 files changed

+818
-795
lines changed

.github/ISSUE_TEMPLATE/good-first.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -28,4 +28,4 @@ Then, the issue will be assigned to you.
2828
**How to ask for help**:
2929

3030
If you need help or have questions, please feel free to ask on this issue.
31-
The issue author or other members of the community will guide you through the contribution process.
31+
The issue author or other members of the community will guide you through the contribution process.

.github/workflows/main.yml

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,6 @@ on:
1313
required: true
1414

1515
jobs:
16-
1716
build:
1817
runs-on: ubuntu-22.04
1918
strategy:

.github/workflows/markdownlint.yml

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
name: Lint Workflow
2+
3+
on:
4+
pull_request:
5+
paths-ignore:
6+
- "**.svg"
7+
- "**.png"
8+
9+
jobs:
10+
build:
11+
runs-on: ubuntu-22.04
12+
strategy:
13+
matrix:
14+
go-version: ["1.23"]
15+
16+
steps:
17+
- uses: actions/checkout@v3
18+
- uses: DavidAnson/markdownlint-cli2-action@v20
19+
with:
20+
globs: "**/*.md,!docs/ctl"
21+
separator: ","

.markdownlint.yml

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
line-length: false
2+
no-inline-html: false
3+
first-line-heading: false
4+
no-alt-text: false
5+
ol-prefix: false
6+
no-duplicate-heading: false
7+
single-h1: false
8+
no-emphasis-as-heading: false

CODE_OF_CONDUCT.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,4 +2,4 @@
22

33
Kmesh follows the [CNCF Code of Conduct](https://github.com/cncf/foundation/blob/master/code-of-conduct.md).
44

5-
Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at [email protected].
5+
Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at <[email protected]>.

CONTRIBUTING.md

Lines changed: 19 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -17,39 +17,39 @@ Welcome to Kmesh!
1717
- [Code Review](#code-review)
1818
- [Membership](#membership)
1919

20-
# Before you get started
20+
## Before you get started
2121

22-
## Code of Conduct
22+
### Code of Conduct
2323

2424
Please make sure to read and observe our [Code of Conduct](/CODE_OF_CONDUCT.md).
2525

26-
## Community Expectations
26+
### Community Expectations
2727

2828
Kmesh is a community project driven by its community which strives to promote a healthy, friendly and productive environment.
2929
Kmesh aims to provide turnkey automation for multi-cluster application management in multi-cloud and hybrid cloud scenarios,
3030
and intended to realize multi-cloud centralized management, high availability, failure recovery and traffic scheduling.
3131

32-
# Getting started
32+
## Getting started
3333

3434
- Fork the repository on GitHub.
3535
- Make your changes on your fork repository.
3636
- Submit a PR.
3737

38-
# Your First Contribution
38+
## Your First Contribution
3939

4040
We will help you to contribute in different areas like filing issues, developing features, fixing critical bugs and
4141
getting your work reviewed and merged.
4242

4343
If you have questions about the development process,
4444
feel free to [file an issue](https://github.com/Kmesh-net/Kmesh/issues/new/choose).
4545

46-
## Find something to work on
46+
### Find something to work on
4747

4848
We are always in need of help, be it fixing documentation, reporting bugs or writing some code.
4949
Look at places where you feel best coding practices aren't followed, code refactoring is needed or tests are missing.
5050
Here is how you get started.
5151

52-
### Find a good first topic
52+
#### Find a good first topic
5353

5454
There are [multiple repositories](https://github.com/Kmesh-net/) within the Kmesh organization.
5555
Each repository has beginner-friendly issues that provide a good first issue.
@@ -66,7 +66,7 @@ Please see [Contributing](#contributing) below for the workflow.
6666

6767
When you are willing to take on an issue, just reply on the issue. The maintainer will assign it to you.
6868

69-
### File an Issue
69+
#### File an Issue
7070

7171
While we encourage everyone to contribute code, it is also appreciated when someone reports an issue.
7272
Issues should be filed under the appropriate Kmesh sub-repository.
@@ -75,7 +75,7 @@ Issues should be filed under the appropriate Kmesh sub-repository.
7575

7676
Please follow the prompted submission guidelines while opening an issue.
7777

78-
# Contributor Workflow
78+
## Contributor Workflow
7979

8080
Please do not ever hesitate to ask a question or send a pull request.
8181

@@ -86,28 +86,28 @@ This is a rough outline of what a contributor's workflow looks like:
8686
- Push changes in a topic branch to a personal fork of the repository.
8787
- Submit a pull request to [Kmesh-net/Kmesh](https://github.com/Kmesh-net/Kmesh).
8888

89-
## Creating Pull Requests
89+
### Creating Pull Requests
9090

9191
Pull requests are often called simply "PR".
9292
Kmesh generally follows the standard [github pull request](https://help.github.com/articles/about-pull-requests/) process.
9393
To submit a proposed change, please develop the code/fix and add new test cases.
9494
After that, run these local verifications before submitting pull request to predict the pass or
9595
fail of continuous integration.
9696

97-
* Run and pass `make gen-check`, if want to run with sudo privileges `sudo env PATH=$PATH make gen-check`
98-
* To compile, refer to [Compile and Build Kmesh](https://kmesh.net/en/docs/developer/build-guide/)
99-
* To run unit test, refer to [Run Unit Test](https://kmesh.net/en/docs/developer/run-ut/)
100-
* To run e2e test, refer to [Run E2E Test](https://kmesh.net/en/docs/developer/e2e-guide/)
97+
- Run and pass `make gen-check`, if want to run with sudo privileges `sudo env PATH=$PATH make gen-check`
98+
- To compile, refer to [Compile and Build Kmesh](https://kmesh.net/en/docs/developer/build-guide/)
99+
- To run unit test, refer to [Run Unit Test](https://kmesh.net/en/docs/developer/run-ut/)
100+
- To run e2e test, refer to [Run E2E Test](https://kmesh.net/en/docs/developer/e2e-guide/)
101101

102-
## Code Review
102+
### Code Review
103103

104104
To make it easier for your PR to receive reviews, consider the reviewers will need you to:
105105

106-
* follow [good coding guidelines](https://github.com/golang/go/wiki/CodeReviewComments).
107-
* write [good commit messages](https://chris.beams.io/posts/git-commit/).
108-
* break large changes into a logical series of smaller patches which individually make easily understandable changes, and in aggregate solve a broader issue.
106+
- follow [good coding guidelines](https://github.com/golang/go/wiki/CodeReviewComments).
107+
- write [good commit messages](https://chris.beams.io/posts/git-commit/).
108+
- break large changes into a logical series of smaller patches which individually make easily understandable changes, and in aggregate solve a broader issue.
109109

110-
# Membership
110+
## Membership
111111

112112
We encourage all contributors to become members. Learn more about requirements and responsibilities of membership in our [Community Membership doc](https://kmesh.net/docs/community/membership/).
113113

README-zh.md

Lines changed: 11 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -21,31 +21,31 @@ Kmesh创新性的提出将流量治理下沉OS,在数据路径上无需经过
2121

2222
### Kmesh关键特性
2323

24-
**平滑兼容**
24+
#### 平滑兼容
2525

2626
- 应用透明的流量治理
2727
- 自动对接Istiod
2828

29-
**高性能**
29+
#### 高性能
3030

3131
- 网格转发时延**60%↓**
3232
- 服务启动性能**40%↑**
3333

34-
**低开销**
34+
#### 低开销
3535

3636
- 网格底座开销**70%↓**
3737

38-
**安全隔离**
38+
#### 安全隔离
3939

4040
- ebpf虚机安全
4141
- cgroup级编排隔离
4242

43-
**全栈可视化**
43+
#### 全栈可视化
4444

4545
- 端到端指标采集*
4646
- 主流观测平台对接*
4747

48-
**开放生态**
48+
#### 开放生态
4949

5050
- 支持XDS协议标准
5151

@@ -55,7 +55,7 @@ Kmesh创新性的提出将流量治理下沉OS,在数据路径上无需经过
5555

5656
- 前提条件
5757

58-
- Kmesh当前是对接Istio控制面,启动Kmesh前,需要提前安装好Istio的控制面软件;具体安装步骤参考:https://istio.io/latest/docs/setup/getting-started/#install
58+
- Kmesh当前是对接Istio控制面,启动Kmesh前,需要提前安装好Istio的控制面软件;具体安装步骤参考:<https://istio.io/latest/docs/setup/getting-started/#install>
5959
- 完整的Kmesh能力依赖对OS的增强,需确认执行环境是否在Kmesh支持的[OS列表](docs/kmesh_support-zh.md)中,对于其他OS环境需要参考[Kmesh编译构建](docs/kmesh_compile-zh.md);也可以使用[兼容模式的kmesh镜像](build/docker/README.md#兼容模式镜像)在其他OS环境中进行尝试,关于kmesh各种镜像的说明请参考[详细文档](build/docker/README.md)
6060

6161
- Docker镜像:
@@ -69,9 +69,7 @@ Kmesh创新性的提出将流量治理下沉OS,在数据路径上无需经过
6969
- 针对所有OS版本:
7070

7171
为了兼容不同的OS版本,Kmesh提供在线编译并运行的镜像。在Kmesh被部署之后,它会基于宿主机的内核能力自动选择运行的Kmesh特性,从而满足一个镜像在不同OS环境运行的要求。
72-
73-
74-
72+
7573
考虑到kmesh使用的通用性,我们也发布了用于kmesh编译构建的镜像。用户可以基于此镜像方便的制作出可以在当前OS版本上运行的kmesh镜像。默认命名为ghcr.io/kmesh-net/kmesh:latest,用户可自行调整,参考[Kmesh编译构建](docs/kmesh_compile-zh.md#docker image编译)
7674

7775
```bash
@@ -131,7 +129,7 @@ Kmesh创新性的提出将流量治理下沉OS,在数据路径上无需经过
131129

132130
- 安装waypoint
133131

134-
```
132+
```bash
135133
[root@ ~]# istioctl x waypoint apply --service-account default
136134
[root@ ~]# kubectl get pods
137135
NAME READY STATUS RESTARTS AGE
@@ -142,8 +140,8 @@ Kmesh创新性的提出将流量治理下沉OS,在数据路径上无需经过
142140

143141
- 用kmesh自定义的镜像替换waypoint的原生镜像
144142

145-
```
146-
[root@ ~]# kubectl get gateway
143+
```bash
144+
kubectl get gateway
147145
NAME CLASS ADDRESS PROGRAMMED AGE
148146
default istio-waypoint 10.96.143.232 True 5m7s
149147
```

README.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
<img src="docs/pics/logo/KMESH-horizontal-colour.png" alt="kmesh-logo" style="zoom: 100%;" />
22

3-
[![LICENSE](https://img.shields.io/github/license/kmesh-net/kmesh)](/LICENSE) [![codecov](https://codecov.io/gh/kmesh-net/kmesh/graph/badge.svg?token=0EGQ84FGDU)](https://codecov.io/gh/kmesh-net/kmesh)
3+
[![LICENSE](https://img.shields.io/github/license/kmesh-net/kmesh)](/LICENSE) [![codecov](https://codecov.io/gh/kmesh-net/kmesh/graph/badge.svg?token=0EGQ84FGDU)](https://codecov.io/gh/kmesh-net/kmesh)
44

55
## Introduction
66

@@ -46,30 +46,30 @@ Kmesh also provide a Dual-Engine Mode, which makes use of eBPF and waypoint to p
4646

4747
### Key features of Kmesh
4848

49-
**Smooth Compatibility**
49+
#### Smooth Compatibility
5050

5151
- Application-transparent Traffic Management
5252

53-
**High Performance**
53+
#### High Performance
5454

5555
- Forwarding delay **60%↓**
5656
- Workload startup performance **40%↑**
5757

58-
**Low Resource Overhead**
58+
#### Low Resource Overhead
5959

6060
- ServiceMesh data plane overhead **70%↓**
6161

62-
**Zero Trust**
62+
#### Zero Trust
6363

6464
- Provide zero trust security with default mutual TLS
6565
- Policy enforcement both in eBPF and waypoints
6666

67-
**Safety Isolation**
67+
#### Safety Isolation
6868

6969
- eBPF Virtual machine security
7070
- Cgroup level orchestration isolation
7171

72-
**Open Ecology**
72+
#### Open Ecology
7373

7474
- Supports XDS protocol standards
7575
- Support [Gateway API](https://gateway-api.sigs.k8s.io/)

SECURITY.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
For further details please see [Security Policy](https://github.com/kmesh-net/community/blob/main/security-team/SECURITY.md) for our security process and how to report vulnerabilities.
1+
For further details please see [Security Policy](https://github.com/kmesh-net/community/blob/main/security-team/SECURITY.md) for our security process and how to report vulnerabilities.

bpf/kmesh/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,3 @@
11
# BPF-KMESH
2-
## Usage Tutorial
32

3+
## Usage Tutorial

0 commit comments

Comments
 (0)