Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[zh] translate document releasing docs #408

Merged
merged 1 commit into from
Jul 6, 2023

Conversation

wlq1212
Copy link
Contributor

@wlq1212 wlq1212 commented Jul 5, 2023

What type of PR is this?
/kind documentation

What this PR does / why we need it:
translate document releasing docs

  1. i18n/zh/docusaurus-plugin-content-docs/current/developers/document-releasing.md

Which issue(s) this PR fixes:
Fixes #

Special notes for your reviewer:

@karmada-bot karmada-bot added the kind/documentation Categorizes issue or PR as related to documentation. label Jul 5, 2023
@karmada-bot
Copy link
Collaborator

Welcome @wlq1212! It looks like this is your first PR to karmada-io/website 🎉

@karmada-bot karmada-bot added the size/M Denotes a PR that changes 30-99 lines, ignoring generated files. label Jul 5, 2023
@samzong
Copy link
Member

samzong commented Jul 5, 2023

@wlq1212 Thanks for your contribution, �please sign all commit at first.

Copy link
Member

@Poor12 Poor12 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

中文单词与英文单词之间最好有个空格。


Sometimes contributors do not update the content of the documentation in all languages. Before releasing, ensure the multilingual documents are in sync.
This will be tracked by an issue. The issue should follow the format:
有时贡献者不会以所有语言更新文档的内容。在发布之前,请确保多语种文档同步。这将通过一个 issue 来跟踪。issue 应遵循以下格式:
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
有时贡献者不会以所有语言更新文档的内容。在发布之前,请确保多语种文档同步。这将通过一个 issue 来跟踪。issue 应遵循以下格式:
有时贡献者不会更新所有语言文档的内容。在发布之前,请确保多语种文档同步。这将通过一个 issue 来跟踪。issue 应遵循以下格式:

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

done


Before releasing, we need to update reference docs in the website, which includes CLI references and component references. The whole process is done by scripts automatically.
Follow these steps to update reference docs.
在发布之前,我们需要更新网站中的参考文档,包括CLI引用和组件引用。整个过程由脚本自动完成。按照以下步骤更新参考文档。
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
在发布之前,我们需要更新网站中的参考文档,包括CLI引用和组件引用。整个过程由脚本自动完成。按照以下步骤更新参考文档。
在发布之前,我们需要更新网站中的参考文档,包括 CLI 引用和组件引用。整个过程由脚本自动完成。按照以下步骤更新参考文档。

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

done

@@ -32,15 +30,15 @@ $ tree -L 1
#├── website
```

2. Run generate command in karmada root dir.
2. 在 karma 根目录下执行 generate 命令。
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
2.karma 根目录下执行 generate 命令。
2.karmada 根目录下执行 generate 命令。

注意不要有错别字,漏字

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

done

@@ -49,9 +47,9 @@ go build ./hack/tools/gencomponentdocs/.
./gencomponentdocs ../website/i18n/zh/docusaurus-plugin-content-docs/current/reference/components/ karmada-apiserver
```

## Setup release-1.x(manually)
## 安装release-1.x(手动)
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
## 安装release-1.x(手动)
## 安装 release-1.x (手动)

建议保持中英文间的空格

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

done


```shell
cp i18n/zh/docusaurus-plugin-content-docs/current.json i18n/zh/docusaurus-plugin-content-docs/version-v1.5.json
sed -i'' -e "s/Next/v1.5/g" i18n/zh/docusaurus-plugin-content-docs/version-v1.5.json
```

## Check the difference of website and send a pull request(manually)
## 检查 website 差异并发送 pull 请求(手动)
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
## 检查 website 差异并发送 pull 请求(手动)
## 检查变更的文件和主仓库的差异部分,并创建 Pull Request(手动)

Pull Request 不可以拆开翻译

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

done

Copy link
Member

@samzong samzong left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

/lgtm @Poor12

Comment on lines 11 to 14
```
This issue is to track documents which needs to sync zh for release 1.x:
* #268
```
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

我觉得可以有一个issue template,每当一个英文文档PR合入后,即刻创建一个issue用于跟踪多语言(当前只有中文)文档的更新。
@samzong

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Okay, I will create an issue for this.

#409

@@ -49,9 +47,9 @@ go build ./hack/tools/gencomponentdocs/.
./gencomponentdocs ../website/i18n/zh/docusaurus-plugin-content-docs/current/reference/components/ karmada-apiserver
```

## Setup release-1.x(manually)
## 安装 release-1.x(手动)
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
## 安装 release-1.x(手动)
## 建立 release-1.x(手动)

这个叫建立好一些,感觉。

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

done

Copy link
Member

@RainbowMango RainbowMango left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

/approve

@karmada-bot
Copy link
Collaborator

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: RainbowMango

The full list of commands accepted by this bot can be found here.

The pull request process is described here

Needs approval from an approver in each of these files:

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

@karmada-bot karmada-bot added the approved Indicates a PR has been approved by an approver from all required OWNERS files. label Jul 6, 2023
@RainbowMango
Copy link
Member

/lgtm

@karmada-bot karmada-bot added the lgtm Indicates that a PR is ready to be merged. label Jul 6, 2023
@karmada-bot karmada-bot merged commit d9b94a0 into karmada-io:main Jul 6, 2023
@RainbowMango
Copy link
Member

Thanks @wlq1212 and welcome to Karmada community~

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
approved Indicates a PR has been approved by an approver from all required OWNERS files. kind/documentation Categorizes issue or PR as related to documentation. lgtm Indicates that a PR is ready to be merged. size/M Denotes a PR that changes 30-99 lines, ignoring generated files.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants