Skip to content

resolve docs that are not in TOC#3431

Merged
ti-srebot merged 5 commits into
pingcap:masterfrom
yikeke:align-docs
Jul 31, 2020
Merged

resolve docs that are not in TOC#3431
ti-srebot merged 5 commits into
pingcap:masterfrom
yikeke:align-docs

Conversation

@yikeke
Copy link
Copy Markdown
Contributor

@yikeke yikeke commented Jul 28, 2020 •
edited
Loading

What is changed, added or deleted? (Required)

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

  • master (the latest development version)
  • 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)?

Do your changes match any of the following descriptions?

  • Delete files
  • Change aliases
  • Have version specific changes
  • Might cause conflicts

yikeke
yikeke commented Jul 28, 2020
View reviewed changes
Comment thread troubleshoot-tidb-lightning.md Outdated
@yikeke yikeke added needs-cherry-pick-4.0 translation/from-docs-cn This PR is translated from a PR in pingcap/docs-cn. requires-version-specific-changes After cherry-picked, the cherry-picked PR requires further changes. labels Jul 28, 2020
@yikeke yikeke requested a review from lilin90 July 28, 2020 05:07
@yikeke
Copy link
Copy Markdown
Contributor Author

yikeke commented Jul 28, 2020 •
edited
Loading

Also, import-example-data.md is not in TOC.md so https://docs.pingcap.com/tidb/dev/import-example-data has no entry on the left nav bar. Do you have any suggestion on where to put this file in TOC.md? @nullnotnil

@yikeke yikeke requested a review from a user July 28, 2020 05:10
@yikeke yikeke marked this pull request as ready for review July 28, 2020 05:10
@yikeke yikeke added the size/small Changes of a small size. label Jul 28, 2020
@ghost
Copy link
Copy Markdown

ghost commented Jul 29, 2020

Also, import-example-data.md is not in TOC.md so https://docs.pingcap.com/tidb/dev/import-example-data has no entry on the left nav bar. Do you have any suggestion on where to put this file in TOC.md? @nullnotnil

I think import example data can appear under quickstart?

To me it is still useful, but long term I think the user onboarding workflow can be improved by showing a RESTORE FROM {public s3 bucket}. If this is used, then the examples can switch to being the ontime database (larger, but under a license which permits redistribution).

ghost
ghost reviewed Jul 29, 2020
View reviewed changes
Comment thread TOC.md Outdated
@yikeke
Copy link
Copy Markdown
Contributor Author

yikeke commented Jul 30, 2020

Also, import-example-data.md is not in TOC.md so https://docs.pingcap.com/tidb/dev/import-example-data has no entry on the left nav bar. Do you have any suggestion on where to put this file in TOC.md? @nullnotnil

I think import example data can appear under quickstart?

To me it is still useful, but long term I think the user onboarding workflow can be improved by showing a RESTORE FROM {public s3 bucket}. If this is used, then the examples can switch to being the ontime database (larger, but under a license which permits redistribution).

Makes sense to me. Added.

@yikeke yikeke requested review from scsldb and uglyengineer July 30, 2020 03:09
lilin90
lilin90 approved these changes Jul 31, 2020
View reviewed changes
Copy link
Copy Markdown
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

@ti-srebot ti-srebot added the status/LGT1 Indicates that a PR has LGTM 1. label Jul 31, 2020
@yikeke yikeke added the require-LGT1 Indicates that the PR requires an LGTM. label Jul 31, 2020
@yikeke
Copy link
Copy Markdown
Contributor Author

yikeke commented Jul 31, 2020

/merge

@ti-srebot ti-srebot added the status/can-merge Indicates a PR has been approved by a committer. label Jul 31, 2020
@ti-srebot
Copy link
Copy Markdown
Contributor

ti-srebot commented Jul 31, 2020

/run-all-tests

@ti-srebot ti-srebot merged commit 9b47c3e into pingcap:master Jul 31, 2020
ti-srebot pushed a commit to ti-srebot/docs that referenced this pull request Jul 31, 2020
@yikeke @ti-srebot
cherry pick pingcap#3431 to release-4.0
df6c294 
Signed-off-by: ti-srebot <ti-srebot@pingcap.com>
@ti-srebot ti-srebot mentioned this pull request Jul 31, 2020
Merged
9 tasks
@ti-srebot
Copy link
Copy Markdown
Contributor

ti-srebot commented Jul 31, 2020

cherry pick to release-4.0 in PR #3492

ti-srebot added a commit that referenced this pull request Jul 31, 2020
@ti-srebot
resolve docs that are not in TOC (#3431) (#3492)
6c0f3ce 
Signed-off-by: ti-srebot <ti-srebot@pingcap.com>
@yikeke yikeke deleted the align-docs branch July 31, 2020 09:41
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@lilin90 lilin90 lilin90 approved these changes

@scsldb scsldb Awaiting requested review from scsldb

@uglyengineer uglyengineer Awaiting requested review from uglyengineer

+1 more reviewer
Reviewers whose approvals may not affect merge requirements

Assignees

No one assigned

Labels

require-LGT1 Indicates that the PR requires an LGTM. requires-version-specific-changes After cherry-picked, the cherry-picked PR requires further changes. size/small Changes of a small size. status/can-merge Indicates a PR has been approved by a committer. status/LGT1 Indicates that a PR has LGTM 1. translation/from-docs-cn This PR is translated from a PR in pingcap/docs-cn.

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

3 participants

@yikeke @ti-srebot @lilin90