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

v3.0, dev/how-to/maintain: fix wording in kubernetes doc #1607

Merged
merged 4 commits into from
Jul 12, 2019

Conversation

TomShawn
Copy link
Contributor

@TomShawn TomShawn commented Jul 11, 2019

What is changed, added or deleted?

This PR changes the abbreviation COS to its full name, Container-Optimized OS.

Related doc

https://github.com/pingcap/tidb-operator/blob/master/docs/operation-guide.md

Which version does your change affect?

v3.0, dev

Checklist

  • No Tab spaces anywhere
  • Keep the first level heading consistent with title in metadata
  • Use four spaces for each level of indentation except that in TOC.md

Copy link
Contributor

@DanielZhangQD DanielZhangQD left a comment

Choose a reason for hiding this comment

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

LGTM

* 确保 SSD 挂载选项中包含 `nobarrier`。

我们提供一个解决上述问题的 [Daemonset](https://raw.githubusercontent.com/pingcap/tidb-operator/master/manifests/gke/local-ssd-optimize.yaml)。还提供一个解决上述性能问题并且将多块 SSD 盘配置成一个 LVM 的
[Daemonset](https://raw.githubusercontent.com/pingcap/tidb-operator/master/manifests/gke/local-ssd-provision/local-ssd-provision.yaml)。通过 Terraform 部署的时候会自动安装。
[Daemonset](https://raw.githubusercontent.com/pingcap/tidb-operator/master/manifests/gke/local-ssd-optimize.yaml) 提供了一个解决上述性能问题的方案,并且将多块 SSD 盘配置成一个 LVM。通过 Terraform 部署的时候会进行自动安装。
Copy link
Member

Choose a reason for hiding this comment

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

I'm afraid this is not the original meaning. Please check.

Copy link
Contributor

Choose a reason for hiding this comment

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

Please refer to pingcap/tidb-operator#612 for latest update.
I have ported that change to docs.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I have already updated this part according to the English version. See the commit below.

@yikeke
Copy link
Contributor

yikeke commented Jul 11, 2019

Important Update: We have added a markdownlint static check in the CI check to improve the quality of our documentation, so your unclosed PR might fail the CI check now.

First, you should merge master to your branch, so the upstream changes might resolve the issues found by the CI check. Then, click details beside the ci/circleci: lint — Your tests failed on CircleCI message, and you can check the details for the failure and fix all the issues in your PR. It is recommended to install "markdownlint" extension in your VS Code editor, so it will check all potential issues that fail the CI check.

@TomShawn If you have any problem with troubleshooting, please consult @yikeke for help. Thanks for your cooperation~

Ref: #1494

@TomShawn
Copy link
Contributor Author

@yikeke Thank you!

Copy link
Member

@lilin90 lilin90 left a comment

Choose a reason for hiding this comment

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

LGTM

@lilin90 lilin90 merged commit b758194 into pingcap:master Jul 12, 2019
@TomShawn TomShawn deleted the fix-wording-in-kubernetes-doc branch July 12, 2019 03:33
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants