-
Notifications
You must be signed in to change notification settings - Fork 1.2k
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
add a doc for binary package #10401
Conversation
[REVIEW NOTIFICATION] This pull request has been approved by:
To complete the pull request process, please ask the reviewers in the list to review by filling The full list of commands accepted by this bot can be found here. Reviewer can indicate their review by submitting an approval review. |
binary-package.md
Outdated
|
||
`TiDB-community-server` 软件包包含以下内容物: | ||
|
||
* `tidb-{version}-linux-amd64.tar.gz` |
There was a problem hiding this comment.
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 之前的一些信息。
binary-package.md
Outdated
|
||
# TiDB 离线包 | ||
|
||
TiDB 提供两个离线包:`TiDB-community-server` 软件包和 `TiDB-community-toolkit` 软件包。下载地址见 [PingCAP 官网](https://pingcap.com/zh/product-community/)。 |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
- 文件名有 binary,是否可以说明下这里是二进制离线包?
- 是否可以说明下用户什么场景下要用到离线包?要不要附带提一下 TiDB Cloud?
binary-package.md
Outdated
|
||
TiDB 提供两个离线包:`TiDB-community-server` 软件包和 `TiDB-community-toolkit` 软件包。下载地址见 [PingCAP 官网](https://pingcap.com/zh/product-community/)。 | ||
|
||
`TiDB-community-server` 软件包包含以下内容物: |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
能否和 release manager 确认下,哪些版本的离线包会包含 PDF 版的用户文档?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
社区版离线包里应该不包含 PDF 的
Signed-off-by: Ran <huangran.alex@gmail.com>
Signed-off-by: Ran <huangran.alex@gmail.com>
binary-package.md
Outdated
|
||
`TiDB-community-server` 软件包的内容物如下: | ||
|
||
| 内容物 | 描述 | |
There was a problem hiding this comment.
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 起新增)
Co-authored-by: Grace Cai <qqzczy@126.com>
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
rest LGTM
Co-authored-by: TomShawn <41534398+TomShawn@users.noreply.github.com>
There was a problem hiding this 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
Co-authored-by: Grace Cai <qqzczy@126.com>
/merge |
This pull request has been accepted and is ready to merge. Commit hash: 21e342d
|
In response to a cherrypick label: new pull request created: #10468. |
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).
What is the related PR or file link(s)?
Do your changes match any of the following descriptions?