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.

Sign up for GitHub

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

Jump to bottom

Clinic: add new docs #8226

Merged
merged 109 commits into from
Mar 3, 2022
Merged

Clinic: add new docs #8226

merged 109 commits into from
Mar 3, 2022

Conversation

qqqdan
Copy link
Contributor

@qqqdan qqqdan commented Jan 25, 2022

First-time contributors' checklist

What is changed, added or deleted? (Required)

Which TiDB version(s) do your changes apply to? (Required)

Tips for choosing the affected version(s):

By default, CHOOSE MASTER ONLY so your changes will be applied to the next TiDB major or minor releases. If your PR involves a product feature behavior change or a compatibility change, CHOOSE THE AFFECTED RELEASE BRANCH(ES) AND MASTER.

For details, see tips for choosing the affected versions (in Chinese).

  • master (the latest development version)
  • v5.4 (TiDB 5.4 versions)
  • v5.3 (TiDB 5.3 versions)
  • v5.2 (TiDB 5.2 versions)
  • v5.1 (TiDB 5.1 versions)
  • v5.0 (TiDB 5.0 versions)
  • v4.0 (TiDB 4.0 versions)
  • v3.1 (TiDB 3.1 versions)
  • v3.0 (TiDB 3.0 versions)
  • v2.1 (TiDB 2.1 versions)

What is the related PR or file link(s)?

  • This PR is translated from:
  • Other reference link(s):

Do your changes match any of the following descriptions?

  • Delete files
  • Change aliases
  • Need modification after applied to another branch
  • Might cause conflicts after applied to another branch

@ti-chi-bot
Copy link
Member

ti-chi-bot commented Jan 25, 2022 •
edited
Loading

[REVIEW NOTIFICATION]

This pull request has been approved by:

  • en-jin19
  • qiancai

To complete the pull request process, please ask the reviewers in the list to review by filling /cc @reviewer in the comment.
After your PR has acquired the required number of LGTMs, you can assign this pull request to the committer in the list by filling /assign @committer in the comment to help you merge this pull request.

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

Reviewer can indicate their review by submitting an approval review.
Reviewer can cancel approval by submitting a request changes review.

@ti-chi-bot ti-chi-bot requested a review from TomShawn January 25, 2022 09:14
@ti-chi-bot ti-chi-bot added missing-translation-status This PR does not have translation status info. size/XL Denotes a PR that changes 500-999 lines, ignoring generated files. labels Jan 25, 2022
@qiancai qiancai requested review from en-jin19 and removed request for TomShawn January 25, 2022 10:39
@en-jin19 en-jin19 added the translation/doing This PR’s assignee is translating this PR. label Jan 26, 2022
@ti-chi-bot ti-chi-bot removed the missing-translation-status This PR does not have translation status info. label Jan 26, 2022
@en-jin19 en-jin19 changed the title the-first-two-clinic-doc Clinic: the first two clinic docs Jan 26, 2022
@en-jin19 en-jin19 self-assigned this Jan 26, 2022
@ti-chi-bot ti-chi-bot added size/XXL Denotes a PR that changes 1000+ lines, ignoring generated files. and removed size/XL Denotes a PR that changes 500-999 lines, ignoring generated files. labels Feb 6, 2022
@qqqdan qqqdan changed the title Clinic: the first two clinic docs Clinic: all the 5docs Feb 6, 2022
@qqqdan qqqdan changed the title Clinic: all the 5docs Clinic: all the 5 docs Feb 6, 2022
AstroProfundis
AstroProfundis reviewed Feb 7, 2022
View reviewed changes
clinic/Clinic 数据采集说明 - TiUP 环境.md Outdated Show resolved Hide resolved
clinic/Clinic 数据采集说明 - TiUP 环境.md Outdated Show resolved Hide resolved
clinic/Clinic 数据采集说明 - TiUP 环境.md Outdated Show resolved Hide resolved
clinic/TiUP 环境操作手册.md Outdated Show resolved Hide resolved
clinic/TiUP 环境操作手册.md Outdated Show resolved Hide resolved
clinic/TiUP 环境操作手册.md Outdated Show resolved Hide resolved
clinic/TiUP 环境操作手册.md Outdated Show resolved Hide resolved
en-jin19
en-jin19 reviewed Feb 8, 2022
View reviewed changes
clinic/clinic-introduce.md Outdated Show resolved Hide resolved
clinic/clinic-introduce.md Outdated Show resolved Hide resolved
clinic/clinic-introduce.md Outdated Show resolved Hide resolved
clinic/Clinic-user-guide-for-Operator.md Outdated Show resolved Hide resolved
clinic/Clinic-user-guide-for-Operator.md Outdated Show resolved Hide resolved
clinic/Clinic-user-guide-for-Operator.md Outdated Show resolved Hide resolved
clinic/Clinic-user-guide-for-Operator.md Outdated Show resolved Hide resolved
clinic/Clinic-user-guide-for-Operator.md Outdated Show resolved Hide resolved
clinic/Clinic-user-guide-for-Operator.md Outdated Show resolved Hide resolved
clinic/Clinic-user-guide-for-Operator.md Outdated Show resolved Hide resolved
en-jin19
en-jin19 reviewed Feb 8, 2022
View reviewed changes
clinic/clinic-data-instruction-for-tiup.md Outdated Show resolved Hide resolved
clinic/clinic-data-instruction-for-tiup.md Outdated Show resolved Hide resolved
clinic/clinic-data-instruction-for-tiup.md Outdated Show resolved Hide resolved
clinic/clinic-data-instruction-for-tiup.md Outdated Show resolved Hide resolved
clinic/clinic-data-instruction-for-tiup.md Outdated Show resolved Hide resolved
clinic/clinic-data-instruction-for-tiup.md Outdated Show resolved Hide resolved
clinic/clinic-data-instruction-for-tiup.md Show resolved Hide resolved
clinic/clinic-data-instruction-for-tiup.md Outdated Show resolved Hide resolved
clinic/clinic-data-instruction-for-tiup.md Outdated Show resolved Hide resolved
clinic/clinic-data-instruction-for-tiup.md Outdated Show resolved Hide resolved
qiancai
qiancai reviewed Mar 2, 2022
View reviewed changes
clinic/clinic-introduction.md Outdated Show resolved Hide resolved
clinic/clinic-user-guide-for-tiup.md Outdated Show resolved Hide resolved
clinic/clinic-user-guide-for-tiup.md Outdated Show resolved Hide resolved
clinic/clinic-user-guide-for-tiup.md Outdated Show resolved Hide resolved
clinic/clinic-user-guide-for-tiup.md Outdated Show resolved Hide resolved
TOC.md Outdated Show resolved Hide resolved
clinic/clinic-data-instruction-for-tiup.md Outdated
@@ -0,0 +1,140 @@
---
title: Clinic 数据采集说明
Copy link
Collaborator

Choose a reason for hiding this comment

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

Suggested change
title: Clinic 数据采集说明
title: TiDB Clinic 数据采集说明

clinic/clinic-data-instruction-for-tiup.md Outdated
@@ -0,0 +1,140 @@
---
title: Clinic 数据采集说明
summary: 详细说明 Clinic 诊断服务会在使用 TiUP 部署的集群中采集哪些诊断数据。
Copy link
Collaborator

Choose a reason for hiding this comment

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

Suggested change
summary: 详细说明 Clinic 诊断服务会在使用 TiUP 部署的集群中采集哪些诊断数据。
summary: 详细说明 TiDB Clinic 诊断服务在使用 TiUP 部署的集群中能够采集哪些诊断数据。

clinic/clinic-data-instruction-for-tiup.md Outdated
summary: 详细说明 Clinic 诊断服务会在使用 TiUP 部署的集群中采集哪些诊断数据。
---

# Clinic 数据采集说明
Copy link
Collaborator

Choose a reason for hiding this comment

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

Suggested change
# Clinic 数据采集说明
# TiDB Clinic 数据采集说明

clinic/clinic-data-instruction-for-tiup.md Outdated

# Clinic 数据采集说明

本文提供了 Clinic 诊断服务在使用 TiUP 部署的集群中的数据采集范围，并列出了各个采集项对应的采集参数。当执行 Clinic Diag 诊断工具（以下简称为 Diag）数据采集命令时，你可以依据所需采集的数据范围，在命令中添加所需的采集参数。
Copy link
Collaborator

Choose a reason for hiding this comment

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

Suggested change
本文提供了 Clinic 诊断服务在使用 TiUP 部署的集群中的数据采集范围，并列出了各个采集项对应的采集参数。当执行 Clinic Diag 诊断工具（以下简称为 Diag）数据采集命令时，你可以依据所需采集的数据范围，在命令中添加所需的采集参数。
本文提供了 TiDB Clinic 诊断服务在使用 TiUP 部署的集群中的数据采集范围，并列出了各个采集项对应的采集参数。当执行 Clinic Diag 诊断工具（以下简称为 Diag）数据采集命令时，你可以依据所需采集的数据范围，在命令中添加所需的采集参数。

en-jin19
en-jin19 reviewed Mar 2, 2022
View reviewed changes
clinic/clinic-introduction.md Outdated
Comment on lines 60 to 61
- [使用 TiDB Clinic](/clinic/clinic-user-guide-for-tiup.md)
- [TiDB Clinic 数据采集说明](/clinic/clinic-data-instruction-for-tiup.md)
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
- [使用 TiDB Clinic](/clinic/clinic-user-guide-for-tiup.md)
- [TiDB Clinic 数据采集说明](/clinic/clinic-data-instruction-for-tiup.md)
- [使用 TiDB Clinic](/clinic/clinic-user-guide-for-tiup.md)
- [TiDB Clinic 数据采集说明](/clinic/clinic-data-instruction-for-tiup.md)

@qiancai qiancai changed the title Clinic: all the 5 docs Clinic: add new docs Mar 3, 2022
qiancai
qiancai approved these changes Mar 3, 2022
View reviewed changes
Copy link
Collaborator

@qiancai qiancai left a comment

Choose a reason for hiding this comment

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

LGTM

@ti-chi-bot ti-chi-bot added the status/LGT1 Indicates that a PR has LGTM 1. label Mar 3, 2022
qqqdan
qqqdan commented Mar 3, 2022
View reviewed changes
clinic/clinic-introduction.md Outdated Show resolved Hide resolved
en-jin19
en-jin19 approved these changes Mar 3, 2022
View reviewed changes
Copy link
Contributor

@en-jin19 en-jin19 left a comment

Choose a reason for hiding this comment

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

LGTM

@ti-chi-bot ti-chi-bot added status/LGT2 Indicates that a PR has LGTM 2. and removed status/LGT1 Indicates that a PR has LGTM 1. labels Mar 3, 2022
@en-jin19 en-jin19 added translation/done This PR has been translated from English into Chinese and updated to pingcap/docs-cn in a PR. and removed translation/doing This PR’s assignee is translating this PR. labels Mar 3, 2022
@en-jin19
Copy link
Contributor

en-jin19 commented Mar 3, 2022

/merge

@ti-chi-bot
Copy link
Member

This pull request has been accepted and is ready to merge.

Commit hash: 700fa8e

@ti-chi-bot ti-chi-bot added the status/can-merge Indicates a PR has been approved by a committer. label Mar 3, 2022
@ti-chi-bot ti-chi-bot merged commit 1314f8a into pingcap:master Mar 3, 2022
@lilyjazz
Copy link
Member

lilyjazz commented Mar 3, 2022

这个文档，会进入到 v6.0 里面么？

@lilyjazz
Copy link
Member

lilyjazz commented Mar 4, 2022

@en-jin19 那如果想进入到正式文档，需要有哪些流程？等这个产品正式对外介绍的时候？

@en-jin19 en-jin19 added the area/clinic This PR relates to the area of TiDB Clinic. label Mar 10, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@qiancai qiancai qiancai approved these changes

@en-jin19 en-jin19 en-jin19 approved these changes

@lilyjazz lilyjazz lilyjazz approved these changes

@AstroProfundis AstroProfundis AstroProfundis approved these changes

Assignees

@en-jin19 en-jin19

Labels
area/clinic This PR relates to the area of TiDB Clinic. size/XXL Denotes a PR that changes 1000+ lines, ignoring generated files. status/can-merge Indicates a PR has been approved by a committer. status/LGT2 Indicates that a PR has LGTM 2. translation/done This PR has been translated from English into Chinese and updated to pingcap/docs-cn in a PR.
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
7 participants
@qqqdan @ti-chi-bot @en-jin19 @lilyjazz @AstroProfundis @qiancai @TomShawn