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

chore: add a doc about how to generate doc PDF locally #15946

Merged
merged 11 commits into from
Jan 3, 2024

Conversation

qiancai
Copy link
Collaborator

@qiancai qiancai commented Dec 29, 2023

What is changed, added or deleted? (Required)

As in title

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)
  • v7.6 (TiDB 7.6 versions)
  • v7.5 (TiDB 7.5 versions)
  • v7.4 (TiDB 7.4 versions)
  • v7.3 (TiDB 7.3 versions)
  • v7.1 (TiDB 7.1 versions)
  • v6.5 (TiDB 6.5 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

@ti-chi-bot ti-chi-bot bot added missing-translation-status This PR does not have translation status info. size/L Denotes a PR that changes 100-499 lines, ignoring generated files. labels Dec 29, 2023
@qiancai qiancai added the translation/doing This PR’s assignee is translating this PR. label Dec 29, 2023
@ti-chi-bot ti-chi-bot bot removed the missing-translation-status This PR does not have translation status info. label Dec 29, 2023
@qiancai qiancai requested review from lilin90 and Oreoxmt December 29, 2023 10:20
@qiancai qiancai added translation/welcome Waits for a contributor to translate this PR and create a PR to the pingcap/docs-cn repository. 2024-tidb-docs-dash This issue or PR is included in the 2024 TiDB Docs Dash event. labels Dec 29, 2023
@shawn0915
Copy link
Contributor

/assign

下面的步骤以克隆 TiDB 中文文档为例:

1. 打开 TiDB 中文文档仓库地址:<https://github.com/pingcap/docs-cn>
2. 点击页面右上角的 [**Fork**](https://help.github.com/articles/github-glossary/#fork) 按钮,等待 Fork 完成即可。
Copy link
Contributor

Choose a reason for hiding this comment

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

这里可以考虑直接放置fork docs-cn的link么?
https://github.com/pingcap/docs-cn/fork

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.

How about adding this tutorial to README.md as a section like "自助生成 TiDB 文档 PDF"? 🤔

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

Copy link

ti-chi-bot bot commented Jan 2, 2024

[LGTM Timeline notifier]

Timeline:

  • 2024-01-02 07:33:04.676704308 +0000 UTC m=+2155875.713931233: ☑️ agreed by lilin90.

@ti-chi-bot ti-chi-bot bot added the needs-1-more-lgtm Indicates a PR needs 1 more LGTM. label Jan 2, 2024
@lilin90 lilin90 added the lgtm label Jan 2, 2024
Copy link
Collaborator

@Oreoxmt Oreoxmt 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

@qiancai
Copy link
Collaborator Author

qiancai commented Jan 3, 2024

/approve

Copy link

ti-chi-bot bot commented Jan 3, 2024

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: qiancai

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

The pull request process is described here

Needs approval from an approver in each of these files:

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

@ti-chi-bot ti-chi-bot bot added the approved label Jan 3, 2024
@ti-chi-bot ti-chi-bot bot merged commit 7a78fac into pingcap:master Jan 3, 2024
@shawn0915
Copy link
Contributor

/translation done

@ti-chi-bot ti-chi-bot bot added the translation/done This PR has been translated from English into Chinese and updated to pingcap/docs-cn in a PR. label Jan 12, 2024
@shawn0915
Copy link
Contributor

shawn0915 commented Jan 12, 2024

/remove-translation doing

@ti-chi-bot ti-chi-bot bot removed the translation/doing This PR’s assignee is translating this PR. label Jan 12, 2024
benmaoer pushed a commit to benmaoer/docs-cn that referenced this pull request Jan 22, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
2024-tidb-docs-dash This issue or PR is included in the 2024 TiDB Docs Dash event. approved lgtm needs-1-more-lgtm Indicates a PR needs 1 more LGTM. size/L Denotes a PR that changes 100-499 lines, ignoring generated files. translation/done This PR has been translated from English into Chinese and updated to pingcap/docs-cn in a PR. translation/welcome Waits for a contributor to translate this PR and create a PR to the pingcap/docs-cn repository.
Development

Successfully merging this pull request may close these issues.

4 participants