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

Organize directory #19162

Closed
wants to merge 2 commits into from
Closed

Conversation

UTSAVS26
Copy link

First-time contributors' checklist

What is changed, added or deleted? (Required)

I have reorganized the TiDB documentation directory structure to improve clarity and maintainability. The files have been categorized into relevant folders, which include:

  • data_types/: Contains files related to various data types supported by TiDB, such as data-type-json.md and data-type-string.md.
  • features/: Documents specific features and functionalities of TiDB, including best practices and optimization techniques, e.g., agg-distinct-optimization.md and clustered-indexes.md.
  • monitoring/: Includes monitoring tools and dashboards relevant to TiDB performance, with files like grafana-pd-dashboard.md and grafana-tidb-dashboard.md.
  • migration/: Guides and tools for migrating to and from TiDB, featuring files such as migrate-from-csv-files-to-tidb.md and migrate-large-mysql-shards-to-tidb.md.
  • troubleshooting/: Provides resources for diagnosing and resolving issues in TiDB, such as troubleshoot-data-inconsistency-errors.md and troubleshoot-high-disk-io.md.
  • licensing/: Contains licensing information and related files like LICENSE and README.md.
  • other/: Miscellaneous documentation files that do not fit into the above categories, including the organizing script (organize_directory.bat) and other configurations.

This restructuring aims to make it easier for users to navigate the documentation and find specific topics quickly.

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

  • master (the latest development version)
  • v8.4 (TiDB 8.4 versions)
  • v8.3 (TiDB 8.3 versions)
  • v8.2 (TiDB 8.2 versions)
  • v8.1 (TiDB 8.1 versions)
  • v7.5 (TiDB 7.5 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)

What is the related PR or file link(s)?

  • This PR is translated from: N/A
  • Other reference link(s): N/A

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

Copy link

ti-chi-bot bot commented Oct 18, 2024

[APPROVALNOTIFIER] This PR is NOT APPROVED

This pull-request has been approved by:
Once this PR has been reviewed and has the lgtm label, please assign hfxsd for approval. For more information see the Code Review Process.

The full list of commands accepted by this bot can be found 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

@CLAassistant
Copy link

CLA assistant check
Thank you for your submission! We really appreciate it. Like many open source projects, we ask that you sign our Contributor License Agreement before we can accept your contribution.
You have signed the CLA already but the status is still pending? Let us recheck it.

@ti-chi-bot ti-chi-bot bot added contribution This PR is from a community contributor. first-time-contributor Indicates that the PR was contributed by an external member and is a first-time contributor. needs-ok-to-test Indicates a PR created by contributors and need ORG member send '/ok-to-test' to start testing. labels Oct 18, 2024
Copy link

ti-chi-bot bot commented Oct 18, 2024

Hi @UTSAVS26. Thanks for your PR.

I'm waiting for a pingcap member to verify that this patch is reasonable to test. If it is, they should reply with /ok-to-test on its own line. Until that is done, I will not automatically test new commits in this PR, but the usual testing commands by org members will still work. Regular contributors should join the org to skip this step.

Once the patch is verified, the new status will be reflected by the ok-to-test label.

I understand the commands that are listed here.

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes/test-infra repository.

@ti-chi-bot ti-chi-bot bot added missing-translation-status This PR does not have translation status info. size/XS Denotes a PR that changes 0-9 lines, ignoring generated files. labels Oct 18, 2024
Copy link

ti-chi-bot bot commented Oct 25, 2024

PR needs rebase.

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes-sigs/prow repository.

@ti-chi-bot ti-chi-bot bot added the needs-rebase Indicates a PR cannot be merged because it has merge conflicts with HEAD. label Oct 25, 2024
@UTSAVS26
Copy link
Author

@quest-bot embark

@qiancai
Copy link
Collaborator

qiancai commented Nov 4, 2024

Hi @UTSAVS26,

Thank you for your effort in reorganizing the TiDB documentation directory structure. We appreciate your initiative to improve clarity and maintainability.

However, after careful consideration, we have decided not to proceed with these changes at this time. Our primary concerns include the potential for broken links in other documents that reference these source files, the likelihood of cherry-pick conflicts when merging master PRs into other branches, and the risk of file name duplications across different folders.

Btw, the source files in this repository are mainly for updates only. To view TiDB documentation, you can go to https://docs.pingcap.com/tidb/stable directly.

We value your contributions and encourage you to continue sharing your ideas and suggestions for improvement. Thank you for your understanding.

@UTSAVS26 UTSAVS26 closed this Nov 4, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
contribution This PR is from a community contributor. first-time-contributor Indicates that the PR was contributed by an external member and is a first-time contributor. missing-translation-status This PR does not have translation status info. needs-ok-to-test Indicates a PR created by contributors and need ORG member send '/ok-to-test' to start testing. needs-rebase Indicates a PR cannot be merged because it has merge conflicts with HEAD. size/XS Denotes a PR that changes 0-9 lines, ignoring generated files.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants