Skip to content

Conversation

@lucklove
Copy link
Member

@lucklove lucklove commented Nov 10, 2020

What is changed, added or deleted? (Required)

At this time the document for tiup is hard to search, it's time we should refactor it.

This PR added 70+ reference docs:

  • tiup-reference.md
  • tiup-mirror-reference.md
  • tiup-dm-topology-reference.md
  • tiup-cluster-topology-reference.md
  • tiup-command-xxx.md // 具体命令的 reference
  • tiup-component-xxx.md // 具体组件的 reference

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

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

Do your changes match any of the following descriptions?

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

@lucklove lucklove mentioned this pull request Nov 10, 2020
9 tasks
@TomShawn TomShawn added needs-cherry-pick-4.0 size/large Changes of a large size. translation/doing This PR’s assignee is translating this PR. type/refactor The issue belongs to a refactor work. labels Nov 10, 2020
@TomShawn TomShawn changed the title Refactor tiup document tiup: refactor tiup documents Nov 10, 2020
@lucklove lucklove marked this pull request as ready for review January 7, 2021 10:27
@lucklove lucklove changed the title tiup: refactor tiup documents tiup: refactor tiup reference Jan 7, 2021
@lucklove
Copy link
Member Author

lucklove commented Jan 8, 2021

@9547 Could you help on tech review on this?

@9547
Copy link

9547 commented Jan 8, 2021

Thanks for the invite, I'll review it over this weekend

This was referenced Apr 15, 2021
@TomShawn
Copy link
Contributor

/remove-translation doing
/translation done

@ti-chi-bot ti-chi-bot 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 Apr 23, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

size/large Changes of a large size. status/LGT2 Indicates that a PR has LGTM 2. status/PTAL This PR is ready for reviewing. translation/done This PR has been translated from English into Chinese and updated to pingcap/docs-cn in a PR. type/refactor The issue belongs to a refactor work.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

10 participants