[zh-cn] sync issue-wrangler open-a-pr feature-gates diagram-guide

Signed-off-by: xin.li <xin.li@daocloud.io>
pull/43994/head
xin.li 2023-11-19 14:58:19 +08:00
parent ad63f71e0f
commit 0c80ff1df8
4 changed files with 70 additions and 37 deletions

View File

@ -231,7 +231,7 @@ flowchart LR
subgraph changes[你的变更]
direction TB
S[ ] -.-
3[创建一个分支<br>例如: my_new_branch] --> 3a[使用文本编辑器<br>进行修改] --> 4["使用 Hugo 在本地<br>预览你的变更<br>(localhost:1313)<br>或构建容器镜像"]
3[创建一个分支<br>例如my_new_branch] --> 3a[使用文本编辑器<br>进行修改] --> 4["使用 Hugo 在本地<br>预览你的变更<br>(localhost:1313)<br>或构建容器镜像"]
end
subgraph changes2[提交 / 推送]
direction TB
@ -592,11 +592,15 @@ Alternately, install and use the `hugo` command on your computer:
### 从你的克隆副本向 kubernetes/website 发起拉取请求PR {#open-a-pr}
<!--
Figure 3 shows the steps to open a PR from your fork to the kubernetes/website. The details follow.
Figure 3 shows the steps to open a PR from your fork to the [kubernetes/website](https://github.com/kubernetes/website). The details follow.
Please, note that contributors can mention `kubernetes/website` as `k/website`.
-->
图 3 显示了从你的克隆副本向 kubernetes/website 发起 PR 的步骤。
详细信息如下。
请注意,贡献者可以将 `kubernetes/website` 称为 `k/website`
<!-- See https://github.com/kubernetes/website/issues/28808 for live-editor URL to this figure -->
<!-- You can also cut/paste the mermaid code into the live editor at https://mermaid-js.github.io/mermaid-live-editor to play around with it -->
@ -1055,4 +1059,3 @@ possible when you file issues or PRs.
- Read [Reviewing](/docs/contribute/review/reviewing-prs) to learn more about the review process.
-->
- 阅读[评阅](/zh-cn/docs/contribute/review/reviewing-prs)节,学习评阅过程。

View File

@ -12,7 +12,10 @@ weight: 20
<!-- overview -->
<!--
Alongside the [PR Wrangler](/docs/contribute/participate/pr-wranglers),formal approvers, and reviewers, members of SIG Docs take week long shifts [triaging and categorising issues](/docs/contribute/review/for-approvers.md/#triage-and-categorize-issues) for the repository.
Alongside the [PR Wrangler](/docs/contribute/participate/pr-wranglers),formal approvers,
and reviewers, members of SIG Docs take week long shifts
[triaging and categorising issues](/docs/contribute/review/for-approvers.md/#triage-and-categorize-issues)
for the repository.
-->
除了承担 [PR 管理者](/zh-cn/docs/contribute/participate/pr-wranglers)的职责外,
SIG Docs 正式的批准人Approver、评审人Reviewer和成员Member
@ -25,7 +28,9 @@ SIG Docs 正式的批准人Approver、评审人Reviewer和成员M
Each day in a week-long shift the Issue Wrangler will be responsible for:
- Triaging and tagging incoming issues daily. See [Triage and categorize issues](https://github.com/kubernetes/website/blob/main/content/en/docs/contribute/review/for-approvers.md/#triage-and-categorize-issues) for guidelines on how SIG Docs uses metadata.
- Triaging and tagging incoming issues daily. See
[Triage and categorize issues](/docs/contribute/review/for-approvers.md/#triage-and-categorize-issues)
for guidelines on how SIG Docs uses metadata.
- Keeping an eye on stale & rotten issues within the kubernetes/website repository.
- Maintenance of the [Issues board](https://github.com/orgs/kubernetes/projects/72/views/1).
-->
@ -34,18 +39,19 @@ Each day in a week-long shift the Issue Wrangler will be responsible for:
在为期一周的轮值期内Issue 管理者每天负责:
- 对收到的 Issue 进行日常分类和标记。有关 SIG Docs 如何使用元数据的指导说明,
参阅[归类 Issue](https://github.com/kubernetes/website/blob/main/content/en/docs/contribute/review/for-approvers.md/#triage-and-categorize-issues)。
参阅[归类 Issue](/zh-cn/docs/contribute/review/for-approvers.md/#triage-and-categorize-issues)。
- 密切关注 kubernetes/website 代码仓库中陈旧和过期的 Issue。
- 维护 [Issues 看板](https://github.com/orgs/kubernetes/projects/72/views/1)。
<!--
### Requirements
## Requirements
- Must be an active member of the Kubernetes organization.
- A minimum of 15 [non-trivial](https://www.kubernetes.dev/docs/guide/pull-requests/#trivial-edits) contributions to Kubernetes (of which a certain amount should be directed towards kubernetes/website).
- Performing the role in an informal capacity already
- A minimum of 15 [non-trivial](https://www.kubernetes.dev/docs/guide/pull-requests/#trivial-edits)
contributions to Kubernetes (of which a certain amount should be directed towards kubernetes/website).
- Performing the role in an informal capacity already.
-->
### 要求 {#requirements}
## 要求 {#requirements}
- 必须是 Kubernetes 组织的活跃成员。
- 至少为 Kubernetes 做了 15
@ -54,12 +60,16 @@ Each day in a week-long shift the Issue Wrangler will be responsible for:
- 已经以非正式身份履行该职责。
<!--
### Helpful [Prow commands](https://prow.k8s.io/command-help) for wranglers
## Helpful Prow commands for wranglers
Below are some commonly used commands for Issue Wranglers:
-->
### 对管理者有帮助的 [Prow 命令](https://prow.k8s.io/command-help)
## 对管理者有帮助的 Prow 命令
以下是 Issue 管理者的一些常用命令:
<!--
```
```bash
# reopen an issue
/reopen
@ -94,7 +104,7 @@ Each day in a week-long shift the Issue Wrangler will be responsible for:
/close not-planned
```
-->
```
```bash
# 重新打开 Issue
/reopen
@ -130,11 +140,18 @@ Each day in a week-long shift the Issue Wrangler will be responsible for:
```
<!--
### When to close Issues
For an open source project to succeed, good issue management is crucial. But it is also critical to resolve issues in order to maintain the repository and communicate clearly with contributors and users.
To find more Prow commands, refer to the [Command Help](https://prow.k8s.io/command-help) documentation.
-->
### 何时关闭 Issue {#when-to-close-issues}
要查找更多 Prow 命令,请参阅[命令帮助](https://prow.k8s.io/command-help)文档。
<!--
## When to close Issues
For an open source project to succeed, good issue management is crucial.
But it is also critical to resolve issues in order to maintain the repository
and communicate clearly with contributors and users.
-->
## 何时关闭 Issue {#when-to-close-issues}
一个开源项目想要成功,良好的 Issue 管理非常关键。
但解决 Issue 也很重要,这样才能维护代码仓库,并与贡献者和用户进行清晰明确的交流。
@ -142,7 +159,8 @@ For an open source project to succeed, good issue management is crucial. But it
<!--
Close issues when:
- A similar issue is reported more than once.You will first need to tag it as /triage duplicate; link it to the main issue & then close it. It is also advisable to direct the users to the original issue.
- A similar issue is reported more than once.You will first need to tag it as `/triage duplicate`;
link it to the main issue & then close it. It is also advisable to direct the users to the original issue.
- It is very difficult to understand and address the issue presented by the author with the information provided.
However, encourage the user to provide more details or reopen the issue if they can reproduce it later.
- The same functionality is implemented elsewhere. One can close this issue and direct user to the appropriate place.
@ -152,7 +170,7 @@ Close issues when:
-->
关闭 Issue 的时机包括:
- 类似的 Issue 被多次报告。你首先需要将其标记为 /triage duplicate
- 类似的 Issue 被多次报告。你首先需要将其标记为 `/triage duplicate`
将其链接到主要 Issue 然后关闭它。还建议将用户引导至最初的 Issue。
- 通过所提供的信息很难理解和解决作者提出的 Issue。
但要鼓励用户提供更多细节,或者在以后可以重现 Issue 时重新打开此 Issue 。

View File

@ -420,11 +420,15 @@ and Netlify previews to verify the diagram is properly rendered.
{{< caution >}}
<!--
The Mermaid live editor feature set may not support the kubernetes/website Mermaid feature set.
The Mermaid live editor feature set may not support the [kubernetes/website](https://github.com/kubernetes/website) Mermaid feature set.
And please, note that contributors can mention `kubernetes/website` as `k/website`.
You might see a syntax error or a blank screen after the Hugo build.
If that is the case, consider using the Mermaid+SVG method.
-->
Mermaid 在线编辑器的功能特性可能不支持 K8s 网站的 Mermaid 特性。
Mermaid 在线编辑器的功能特性可能不支持
[kubernetes/website](https://github.com/kubernetes/website)
的 Mermaid 特性。
请注意,贡献者可以将 `kubernetes/website` 称为 `k/website`
你可能在 Hugo 构建过程中看到语法错误提示或者空白屏幕。
如果发生这类情况,可以考虑使用 Mermaid+SVG 方法。
{{< /caution >}}
@ -548,14 +552,15 @@ The following lists advantages of the Mermaid+SVG method:
* Live editor tool.
* Live editor tool supports the most current Mermaid feature set.
* Employ existing kubernetes/website methods for handling `.svg` image files.
* Employ existing [kubernetes/website](https://github.com/kubernetes/website) methods for handling `.svg` image files.
* Environment doesn't require Mermaid support.
-->
使用 Mermaid+SVG 方法的好处有:
* 可以直接使用在线编辑器工具
* 在线编辑器支持的 Mermaid 特性集合最新
* 可以利用 K8s 网站用来处理 `.svg` 图片文件的现有方法
* 可以利用 [kubernetes/website](https://github.com/kubernetes/website)
用来处理 `.svg` 图片文件的现有方法
* 工作环境不需要 Mermaid 支持
<!--

View File

@ -397,7 +397,7 @@ For a reference to old feature gates that are removed, please refer to
A feature can be in *Alpha*, *Beta* or *GA* stage.
An *Alpha* feature means:
-->
处于 **Alpha** 、**Beta** **GA** 阶段的特性。
处于 **Alpha**、**Beta**、**GA** 阶段的特性。
**Alpha** 特性代表:
@ -454,7 +454,7 @@ After they exit beta, it may not be practical for us to make more changes.
<!--
A *General Availability* (GA) feature is also referred to as a *stable* feature. It means:
-->
**General Availability** (GA) 特性也称为 **稳定** 特性,**GA** 特性代表着:
**General Availability**GA特性也称为**稳定**特性,**GA** 特性代表着:
<!--
* The feature is always enabled; you cannot disable it.
@ -479,7 +479,7 @@ Each feature gate is designed for enabling/disabling a specific feature:
- `AdmissionWebhookMatchConditions`: Enable [match conditions](/docs/reference/access-authn-authz/extensible-admission-controllers/#matching-requests-matchconditions)
on mutating & validating admission webhooks.
-->
- `AdmissionWebhookMatchConditions`: 在转换和验证准入 Webhook
- `AdmissionWebhookMatchConditions`在转换和验证准入 Webhook
上启用[匹配条件](/zh-cn/docs/reference/access-authn-authz/extensible-admission-controllers/#matching-requests-matchconditions)
<!--
- `APIListChunking`: Enable the API clients to retrieve (`LIST` or `GET`)
@ -623,7 +623,7 @@ Each feature gate is designed for enabling/disabling a specific feature:
on behalf of a CronJob.
- `CronJobTimeZone`: Allow the use of the `timeZone` optional field in [CronJobs](/docs/concepts/workloads/controllers/cron-jobs/).
-->
- `ComponentSLIs`: 在 kubelet、kube-scheduler、kube-proxy、kube-controller-manager、cloud-controller-manager
- `ComponentSLIs`在 kubelet、kube-scheduler、kube-proxy、kube-controller-manager、cloud-controller-manager
等 Kubernetes 组件上启用 `/metrics/slis` 端点,从而允许你抓取健康检查指标。
- `ConsistentHTTPGetHandlers`:使用探测器为生命周期处理程序规范化 HTTP get URL 和标头传递。
- `ConsistentListFromCache`:允许 API 服务器从缓存中提供一致的列表。
@ -1132,7 +1132,7 @@ Each feature gate is designed for enabling/disabling a specific feature:
允许 kube-proxy 来处理终止过程中的端点。
- `QOSReserved`:允许在 QoS 级别进行资源预留,以防止处于较低 QoS 级别的 Pod
突发进入处于较高 QoS 级别的请求资源(目前仅适用于内存)。
- `ReadWriteOncePod`: 允许使用 `ReadWriteOncePod` 访问模式的 PersistentVolume。
- `ReadWriteOncePod`允许使用 `ReadWriteOncePod` 访问模式的 PersistentVolume。
<!--
- `RecoverVolumeExpansionFailure`: Enables users to edit their PVCs to smaller
sizes so as they can recover from previously issued volume expansion failures.
@ -1196,16 +1196,23 @@ Each feature gate is designed for enabling/disabling a specific feature:
-->
- `SeccompDefault`:启用 `RuntimeDefault` 作为所有工作负载的默认 seccomp 配置文件。
此 seccomp 配置文件在 Pod 和/或 Container 的 `securityContext` 中被指定。
- `SecurityContextDeny`: 此门控表示 `SecurityContextDeny` 准入控制器已弃用。
- `SecurityContextDeny`此门控表示 `SecurityContextDeny` 准入控制器已弃用。
- `ServerSideApply`:在 API 服务器上启用[服务器端应用SSA](/zh-cn/docs/reference/using-api/server-side-apply/)。
- `ServerSideFieldValidation`:启用服务器端字段验证。
这意味着验证资源模式在 API 服务器端而不是客户端执行
(例如,`kubectl create` 或 `kubectl apply` 命令行)。
<!--
- `ServiceNodePortStaticSubrange`: Enables the use of different port allocation
strategies for NodePort Services. For more details, see
[reserve NodePort ranges to avoid collisions](/docs/concepts/services-networking/service/#avoid-nodeport-collisions).
-->
- `ServiceNodePortStaticSubrange`:允许对 NodePort Service
使用不同的端口分配策略。有关更多详细信息,
请参阅[保留 NodePort 范围以避免冲突](/zh-cn/docs/concepts/services-networking/service/#avoid-nodeport-collisions)。
<!--
- `SidecarContainers`: Allow setting the `restartPolicy` of an init container to
`Always` so that the container becomes a sidecar container (restartable init containers).
See
[Sidecar containers and restartPolicy](/docs/concepts/workloads/pods/init-containers/#sidecar-containers-and-restartpolicy)
See [Sidecar containers and restartPolicy](/docs/concepts/workloads/pods/init-containers/#sidecar-containers-and-restartpolicy)
for more details.
-->
- `SidecarContainers`:允许将 Init 容器的 `restartPolicy` 设置为 `Always`
@ -1225,7 +1232,7 @@ Each feature gate is designed for enabling/disabling a specific feature:
-->
- `SizeMemoryBackedVolumes`:允许 kubelet 检查基于内存制备的卷的尺寸约束(目前主要针对 `emptyDir` 卷)。
- `SkipReadOnlyValidationGCE`:跳过对 GCE 的验证,将在下个版本中启用。
- `StableLoadBalancerNodeSet`: 允许服务控制器KCCM根据节点状态变化来减少负载均衡器的重新配置。
- `StableLoadBalancerNodeSet`允许服务控制器KCCM根据节点状态变化来减少负载均衡器的重新配置。
- `StatefulSetStartOrdinal`:允许在 StatefulSet 中配置起始序号。
更多细节请参阅[起始序号](/zh-cn/docs/concepts/workloads/controllers/statefulset/#start-ordinal)。
<!--
@ -1258,10 +1265,10 @@ Each feature gate is designed for enabling/disabling a specific feature:
- `TopologyManager`:启用一种机制来协调 Kubernetes 不同组件的细粒度硬件资源分配。
详见[控制节点上的拓扑管理策略](/zh-cn/docs/tasks/administer-cluster/topology-manager/)。
- `TopologyManagerPolicyAlphaOptions`允许微调拓扑管理器策略的实验性的、Alpha 质量的选项。
此特性门控守护 **一组** 质量级别为 Alpha 的拓扑管理器选项。
此特性门控守护**一组**质量级别为 Alpha 的拓扑管理器选项。
此特性门控绝对不会进阶至 Beta 或稳定版。
- `TopologyManagerPolicyBetaOptions`允许微调拓扑管理器策略的实验性的、Beta 质量的选项。
此特性门控守护 **一组** 质量级别为 Beta 的拓扑管理器选项。
此特性门控守护**一组**质量级别为 Beta 的拓扑管理器选项。
此特性门控绝对不会进阶至稳定版。
<!--
- `TopologyManagerPolicyOptions`: Allow fine-tuning of topology manager policies,
@ -1283,7 +1290,7 @@ Each feature gate is designed for enabling/disabling a specific feature:
topologies based on available PV capacity.
-->
- `ValidatingAdmissionPolicy`:启用准入控制中所用的对 CEL 校验的 [ValidatingAdmissionPolicy](/zh-cn/docs/reference/access-authn-authz/validating-admission-policy/) 支持。
- `VolumeCapacityPriority`: 基于可用 PV 容量的拓扑,启用对不同节点的优先级支持。
- `VolumeCapacityPriority`基于可用 PV 容量的拓扑,启用对不同节点的优先级支持。
<!--
- `WatchBookmark`: Enable support for watch bookmark events.
- `WatchList` : Enable support for [streaming initial state of objects in watch requests](/docs/reference/using-api/api-concepts/#streaming-lists).
@ -1291,7 +1298,7 @@ Each feature gate is designed for enabling/disabling a specific feature:
- `WinOverlay`: Allows kube-proxy to run in overlay mode for Windows.
-->
- `WatchBookmark`:启用对 watch 操作中 bookmark 事件的支持。
- `WatchList` : 启用对
- `WatchList`启用对
[在 watch 请求中流式传输对象的初始状态](/zh-cn/docs/reference/using-api/api-concepts/#streaming-lists)的支持。
- `WinDSR`:允许 kube-proxy 为 Windows 创建 DSR 负载均衡。
- `WinOverlay`:允许在 Windows 的覆盖网络模式下运行 kube-proxy。