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

add a doc for binary package #10401

Merged
merged 10 commits into from
Jul 12, 2022
Merged

add a doc for binary package #10401

merged 10 commits into from
Jul 12, 2022

Conversation

ran-huang
Copy link
Contributor

First-time contributors' checklist

What is changed, added or deleted? (Required)

Add a doc for binary package contents.

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)
  • v6.2 (TiDB 6.2 versions)
  • v6.1 (TiDB 6.1 versions)
  • 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)

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

@ran-huang ran-huang added translation/doing This PR’s assignee is translating this PR. area/deploy-upgrade-maintain Indicates that the Issue or PR belongs to the area of deployment, upgrade, and maintenance. needs-cherry-pick-release-6.1 Should cherry pick this PR to release-6.1 branch. labels Jul 7, 2022
@ran-huang ran-huang requested a review from lilin90 July 7, 2022 07:18
@ran-huang ran-huang self-assigned this Jul 7, 2022
@ti-chi-bot
Copy link
Member

ti-chi-bot commented Jul 7, 2022

[REVIEW NOTIFICATION]

This pull request has been approved by:

  • TomShawn
  • 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 added the size/M Denotes a PR that changes 30-99 lines, ignoring generated files. label Jul 7, 2022

`TiDB-community-server` 软件包包含以下内容物:

* `tidb-{version}-linux-amd64.tar.gz`
Copy link
Contributor

@TomShawn TomShawn Jul 7, 2022

Choose a reason for hiding this comment

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

是否需要对 {version} 占位符进行说明?下面所列内容物的版本不能低于 v6.0.0 吗? 如果是的话,可能得加上本文档的版本说明,包括 v6.0.0 之前的一些信息。


# TiDB 离线包

TiDB 提供两个离线包:`TiDB-community-server` 软件包和 `TiDB-community-toolkit` 软件包。下载地址见 [PingCAP 官网](https://pingcap.com/zh/product-community/)。
Copy link
Contributor

@TomShawn TomShawn Jul 7, 2022

Choose a reason for hiding this comment

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

  • 文件名有 binary,是否可以说明下这里是二进制离线包?
  • 是否可以说明下用户什么场景下要用到离线包?要不要附带提一下 TiDB Cloud?


TiDB 提供两个离线包:`TiDB-community-server` 软件包和 `TiDB-community-toolkit` 软件包。下载地址见 [PingCAP 官网](https://pingcap.com/zh/product-community/)。

`TiDB-community-server` 软件包包含以下内容物:
Copy link
Contributor

Choose a reason for hiding this comment

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

能否和 release manager 确认下,哪些版本的离线包会包含 PDF 版的用户文档?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

社区版离线包里应该不包含 PDF 的

ran-huang added 3 commits July 7, 2022 17:24
Signed-off-by: Ran <huangran.alex@gmail.com>
use table display

Signed-off-by: Ran <huangran.alex@gmail.com>
@ti-chi-bot ti-chi-bot added size/L Denotes a PR that changes 100-499 lines, ignoring generated files. and removed size/M Denotes a PR that changes 30-99 lines, ignoring generated files. labels Jul 7, 2022
Signed-off-by: Ran <huangran.alex@gmail.com>
@ti-chi-bot ti-chi-bot added size/M Denotes a PR that changes 30-99 lines, ignoring generated files. and removed size/L Denotes a PR that changes 100-499 lines, ignoring generated files. labels Jul 7, 2022
binary-package.md Show resolved Hide resolved
binary-package.md Outdated Show resolved Hide resolved

`TiDB-community-server` 软件包的内容物如下:

| 内容物 | 描述 |
Copy link
Collaborator

Choose a reason for hiding this comment

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

“描述” 听起来像是对内容物的介绍,如果不打算介绍下各个包,或许可以考虑以下两种方式之一:

  • Option 1: 把 “描述” 改成 “变更说明”
  • Option 2: 删除此列,对于有变化的,写成类似这种 diag-{version}-linux-amd64.tar.gz (从 v6.0.0 起新增)

ran-huang and others added 2 commits July 8, 2022 06:11
Co-authored-by: Grace Cai <qqzczy@126.com>
binary-package.md Outdated Show resolved Hide resolved
Copy link
Contributor

@TomShawn TomShawn left a comment

Choose a reason for hiding this comment

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

rest LGTM

@ti-chi-bot ti-chi-bot added the status/LGT1 Indicates that a PR has LGTM 1. label Jul 8, 2022
Co-authored-by: TomShawn <41534398+TomShawn@users.noreply.github.com>
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.

Minor comments. Rest LGTM

binary-package.md Outdated Show resolved Hide resolved
binary-package.md Outdated Show resolved Hide resolved
binary-package.md Outdated Show resolved Hide resolved
@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 Jul 8, 2022
Co-authored-by: Grace Cai <qqzczy@126.com>
@ran-huang
Copy link
Contributor Author

/merge

@ti-chi-bot
Copy link
Member

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

Commit hash: 21e342d

@ti-chi-bot ti-chi-bot added the status/can-merge Indicates a PR has been approved by a committer. label Jul 12, 2022
@ran-huang ran-huang merged commit 7651354 into pingcap:master Jul 12, 2022
@ran-huang ran-huang deleted the package branch July 12, 2022 06:00
@ti-chi-bot
Copy link
Member

In response to a cherrypick label: new pull request created: #10468.

@ran-huang ran-huang assigned shichun-0415 and unassigned ran-huang Aug 16, 2022
@ran-huang ran-huang 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 Aug 16, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area/deploy-upgrade-maintain Indicates that the Issue or PR belongs to the area of deployment, upgrade, and maintenance. needs-cherry-pick-release-6.1 Should cherry pick this PR to release-6.1 branch. size/M Denotes a PR that changes 30-99 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
Development

Successfully merging this pull request may close these issues.

5 participants