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

dev, v3.0: change tidb-cluster deploy doc #1585

Merged
merged 12 commits into from
Jul 9, 2019

Conversation

xiaojingchen
Copy link
Contributor

What is changed, added or deleted?

changed docs:

  • dev/how-to/maintain/tidb-in-kubernetes/tidb-cluster.md
  • v3.0/how-to/maintain/tidb-in-kubernetes/tidb-cluster.md

main fixes:

  1. add configuration doc link
  2. change the struct of doc

@yikeke yikeke added the dev label Jul 7, 2019
@yikeke yikeke changed the title change tidb-cluster deploy doc dev, v3.0: change tidb-cluster deploy doc Jul 7, 2019
mkdir -p /home/tidb/${releaseName} && \
helm inspect values pingcap/tidb-cluster --version=${chartVersion} > /home/tidb/${releaseName}/values-${releaseName}.yaml
```

> **注意:**
Copy link
Contributor

Choose a reason for hiding this comment

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

这里的“注意”是承接着上文的内容,请一并挪到下面相应的位置上。

mkdir -p /home/tidb/${releaseName} && \
helm inspect values pingcap/tidb-cluster --version=${chartVersion} > /home/tidb/${releaseName}/values-${releaseName}.yaml
```

> **注意:**
Copy link
Contributor

Choose a reason for hiding this comment

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

同上。

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.

Please apply Coco's comments.

xiaojingchen and others added 5 commits July 9, 2019 14:14
Co-Authored-By: Keke Yi <40977455+yikeke@users.noreply.github.com>
Co-Authored-By: Keke Yi <40977455+yikeke@users.noreply.github.com>
Co-Authored-By: Keke Yi <40977455+yikeke@users.noreply.github.com>
Co-Authored-By: Keke Yi <40977455+yikeke@users.noreply.github.com>
Copy link
Contributor

@yikeke yikeke left a comment

Choose a reason for hiding this comment

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

LGTM. PTAL @DanielZhangQD

@yikeke
Copy link
Contributor

yikeke commented Jul 9, 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.

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.

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

Ref: #1494

@xiaojingchen
Copy link
Contributor Author

what does MD031 mean?

@xiaojingchen xiaojingchen merged commit fd2c5f4 into pingcap:master Jul 9, 2019
@lilin90
Copy link
Member

lilin90 commented Jul 11, 2019

@xiaojingchen It means this rule.

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