update MariaDB documentation links from kb/ to docs/ (#21848)
#21850
Conversation
Signed-off-by: ti-chi-bot <[email protected]>
ti-chi-bot
added
area/develop
|
@Oreoxmt This PR has conflicts, I have hold it. |
|
@ti-chi-bot: ## If you want to know how to resolve it, please read the guide in TiDB Dev Guide. 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 ti-community-infra/tichi repository. |
Summary of ChangesHello @ti-chi-bot, I'm Gemini Code Assist1! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed! This pull request primarily addresses the migration of MariaDB documentation links from an outdated knowledge base path to the current documentation platform, ensuring the accuracy and accessibility of external references. Additionally, it introduces a valuable new resource that outlines the steps and considerations for migrating data from MariaDB to a TiDB cluster. Highlights
Using Gemini Code AssistThe full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips. Invoking Gemini You can request assistance from Gemini at any point by creating a comment using either
Customization To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a Limitations & Feedback Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments. If you're interested in giving your feedback about your experience with Gemini Code Assist for Github and other Google products, sign up here. You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension. Footnotes
|
ti-chi-bot
bot
added
size/XL
![gemini-code-assist[bot]](https://avatars.githubusercontent.com/in/956858?s=60&v=4){kind=small}
There was a problem hiding this comment.
Code Review
This pull request updates MariaDB documentation links across several files and introduces a new guide for migrating from MariaDB to TiDB. The link updates are correct, but the file dm/dm-glossary.md contains several unresolved merge conflicts that must be addressed. I've also provided some suggestions for the new migrate-from-mariadb.md file to improve clarity, grammar, and adherence to the style guide.
dm/dm-glossary.md
Outdated
| <<<<<<< HEAD | ||
| The GTID is the global transaction ID of MySQL or MariaDB. With this feature enabled, the GTID information is recorded in the binlog files. Multiple GTIDs form a GTID set. Refer to [MySQL GTID Format and Storage](https://dev.mysql.com/doc/refman/5.7/en/replication-gtids-concepts.html) and [MariaDB Global Transaction ID](https://mariadb.com/kb/en/library/gtid/) for details. | ||
| ======= | ||
| The GTID is the global transaction ID of MySQL or MariaDB. With this feature enabled, the GTID information is recorded in the binlog files. Multiple GTIDs form a GTID set. Refer to [MySQL GTID Format and Storage](https://dev.mysql.com/doc/refman/8.0/en/replication-gtids-concepts.html) and [MariaDB Global Transaction ID](https://mariadb.com/docs/server/ha-and-performance/standard-replication/gtid) for details. | ||
| >>>>>>> 6f1d2cc612 (update MariaDB documentation links from `kb/` to `docs/` (#21848)) |
There was a problem hiding this comment.
Another unresolved merge conflict exists in this section. Please resolve it. The version below the ======= seems to be the correct one with updated links.
| <<<<<<< HEAD | |
| The GTID is the global transaction ID of MySQL or MariaDB. With this feature enabled, the GTID information is recorded in the binlog files. Multiple GTIDs form a GTID set. Refer to [MySQL GTID Format and Storage](https://dev.mysql.com/doc/refman/5.7/en/replication-gtids-concepts.html) and [MariaDB Global Transaction ID](https://mariadb.com/kb/en/library/gtid/) for details. | |
| ======= | |
| The GTID is the global transaction ID of MySQL or MariaDB. With this feature enabled, the GTID information is recorded in the binlog files. Multiple GTIDs form a GTID set. Refer to [MySQL GTID Format and Storage](https://dev.mysql.com/doc/refman/8.0/en/replication-gtids-concepts.html) and [MariaDB Global Transaction ID](https://mariadb.com/docs/server/ha-and-performance/standard-replication/gtid) for details. | |
| >>>>>>> 6f1d2cc612 (update MariaDB documentation links from `kb/` to `docs/` (#21848)) | |
| The GTID is the global transaction ID of MySQL or MariaDB. With this feature enabled, the GTID information is recorded in the binlog files. Multiple GTIDs form a GTID set. Refer to [MySQL GTID Format and Storage](https://dev.mysql.com/doc/refman/8.0/en/replication-gtids-concepts.html) and [MariaDB Global Transaction ID](https://mariadb.com/docs/server/ha-and-performance/standard-replication/gtid) for details. |
dm/dm-glossary.md
Outdated
| <<<<<<< HEAD | ||
| The relay log refers to the binlog files that DM-worker pulls from the upstream MySQL or MariaDB, and stores in the local disk. The format of the relay log is the standard binlog file, which can be parsed by tools such as [mysqlbinlog](https://dev.mysql.com/doc/refman/8.0/en/mysqlbinlog.html) of a compatible version. Its role is similar to [MySQL Relay Log](https://dev.mysql.com/doc/refman/5.7/en/replica-logs-relaylog.html) and [MariaDB Relay Log](https://mariadb.com/kb/en/library/relay-log/). | ||
| ======= | ||
| The relay log refers to the binlog files that DM-worker pulls from the upstream MySQL or MariaDB, and stores in the local disk. The format of the relay log is the standard binlog file, which can be parsed by tools such as [mysqlbinlog](https://dev.mysql.com/doc/refman/8.0/en/mysqlbinlog.html) of a compatible version. Its role is similar to [MySQL Relay Log](https://dev.mysql.com/doc/refman/8.0/en/replica-logs-relaylog.html) and [MariaDB Relay Log](https://mariadb.com/docs/server/server-management/server-monitoring-logs/binary-log/relay-log). | ||
| >>>>>>> 6f1d2cc612 (update MariaDB documentation links from `kb/` to `docs/` (#21848)) |
There was a problem hiding this comment.
There is a third unresolved merge conflict in this file. Please resolve it. The version below the ======= seems to be the correct one with updated links.
| <<<<<<< HEAD | |
| The relay log refers to the binlog files that DM-worker pulls from the upstream MySQL or MariaDB, and stores in the local disk. The format of the relay log is the standard binlog file, which can be parsed by tools such as [mysqlbinlog](https://dev.mysql.com/doc/refman/8.0/en/mysqlbinlog.html) of a compatible version. Its role is similar to [MySQL Relay Log](https://dev.mysql.com/doc/refman/5.7/en/replica-logs-relaylog.html) and [MariaDB Relay Log](https://mariadb.com/kb/en/library/relay-log/). | |
| ======= | |
| The relay log refers to the binlog files that DM-worker pulls from the upstream MySQL or MariaDB, and stores in the local disk. The format of the relay log is the standard binlog file, which can be parsed by tools such as [mysqlbinlog](https://dev.mysql.com/doc/refman/8.0/en/mysqlbinlog.html) of a compatible version. Its role is similar to [MySQL Relay Log](https://dev.mysql.com/doc/refman/8.0/en/replica-logs-relaylog.html) and [MariaDB Relay Log](https://mariadb.com/docs/server/server-management/server-monitoring-logs/binary-log/relay-log). | |
| >>>>>>> 6f1d2cc612 (update MariaDB documentation links from `kb/` to `docs/` (#21848)) | |
| The relay log refers to the binlog files that DM-worker pulls from the upstream MySQL or MariaDB, and stores in the local disk. The format of the relay log is the standard binlog file, which can be parsed by tools such as [mysqlbinlog](https://dev.mysql.com/doc/refman/8.0/en/mysqlbinlog.html) of a compatible version. Its role is similar to [MySQL Relay Log](https://dev.mysql.com/doc/refman/8.0/en/replica-logs-relaylog.html) and [MariaDB Relay Log](https://mariadb.com/docs/server/server-management/server-monitoring-logs/binary-log/relay-log). |
dm/dm-glossary.md
Outdated
| <<<<<<< HEAD | ||
| Block & allow table list is the feature that filters or only migrates all operations of some databases or some tables. Refer to [block & allow table lists](/dm/dm-block-allow-table-lists.md) for details. This feature is similar to [MySQL Replication Filtering](https://dev.mysql.com/doc/refman/5.6/en/replication-rules.html) and [MariaDB Replication Filters](https://mariadb.com/kb/en/replication-filters/). | ||
| ======= | ||
| Block & allow table list is the feature that filters or only migrates all operations of some databases or some tables. Refer to [block & allow table lists](/dm/dm-block-allow-table-lists.md) for details. This feature is similar to [MySQL Replication Filtering](https://dev.mysql.com/doc/refman/8.0/en/replication-rules.html) and [MariaDB Replication Filters](https://mariadb.com/docs/server/ha-and-performance/standard-replication/replication-filters). | ||
| >>>>>>> 6f1d2cc612 (update MariaDB documentation links from `kb/` to `docs/` (#21848)) |
There was a problem hiding this comment.
This file contains unresolved merge conflict markers (<<<<<<<, =======, >>>>>>>). Please resolve the conflict to ensure the document renders correctly. The version below the ======= seems to be the correct one with updated links.
| <<<<<<< HEAD | |
| Block & allow table list is the feature that filters or only migrates all operations of some databases or some tables. Refer to [block & allow table lists](/dm/dm-block-allow-table-lists.md) for details. This feature is similar to [MySQL Replication Filtering](https://dev.mysql.com/doc/refman/5.6/en/replication-rules.html) and [MariaDB Replication Filters](https://mariadb.com/kb/en/replication-filters/). | |
| ======= | |
| Block & allow table list is the feature that filters or only migrates all operations of some databases or some tables. Refer to [block & allow table lists](/dm/dm-block-allow-table-lists.md) for details. This feature is similar to [MySQL Replication Filtering](https://dev.mysql.com/doc/refman/8.0/en/replication-rules.html) and [MariaDB Replication Filters](https://mariadb.com/docs/server/ha-and-performance/standard-replication/replication-filters). | |
| >>>>>>> 6f1d2cc612 (update MariaDB documentation links from `kb/` to `docs/` (#21848)) | |
| Block & allow table list is the feature that filters or only migrates all operations of some databases or some tables. Refer to [block & allow table lists](/dm/dm-block-allow-table-lists.md) for details. This feature is similar to [MySQL Replication Filtering](https://dev.mysql.com/doc/refman/8.0/en/replication-rules.html) and [MariaDB Replication Filters](https://mariadb.com/docs/server/ha-and-performance/standard-replication/replication-filters). |
migrate-from-mariadb.md
Outdated
| ignore-checking-items: ["replication_privilege"] | ||
| ``` | ||
|
|
||
| Before you use DM to migrate data from upstream to downstream, a precheck helps detect errors in the upstream database configurations and ensures that the migration goes smoothly. For more information, see [Migration Task Precheck](/dm/dm-precheck.md) |
There was a problem hiding this comment.
The markdown link is missing a closing parenthesis, which breaks the link.
| Before you use DM to migrate data from upstream to downstream, a precheck helps detect errors in the upstream database configurations and ensures that the migration goes smoothly. For more information, see [Migration Task Precheck](/dm/dm-precheck.md) | |
| Before you use DM to migrate data from upstream to downstream, a precheck helps detect errors in the upstream database configurations and ensures that the migration goes smoothly. For more information, see [Migration Task Precheck](/dm/dm-precheck.md). |
migrate-from-mariadb.md
Outdated
| Choose the right migration strategy: | ||
|
|
||
| - The first strategy is to [dump data with Dumpling and restore data with TiDB Lightning](#dump-data-with-dumpling-and-restore-data-with-tidb-lightning). This works for all versions of MariaDB. The drawback of this strategy is that it needs more downtime. | ||
| - The second strategy is to [Replicate data with DM](#replicate-data-with-dm) from MariaDB to TiDB with DM. DM does not support all versions of MariaDB. Supported versions are listed on the [DM Compatibility Catalog](/dm/dm-compatibility-catalog.md#compatibility-catalog-of-tidb-data-migration). |
There was a problem hiding this comment.
"Replicate" should be in lowercase to be consistent with the other list item and general heading capitalization style.
| - The second strategy is to [Replicate data with DM](#replicate-data-with-dm) from MariaDB to TiDB with DM. DM does not support all versions of MariaDB. Supported versions are listed on the [DM Compatibility Catalog](/dm/dm-compatibility-catalog.md#compatibility-catalog-of-tidb-data-migration). | |
| - The second strategy is to [replicate data with DM](#replicate-data-with-dm) from MariaDB to TiDB with DM. DM does not support all versions of MariaDB. Supported versions are listed on the [DM Compatibility Catalog](/dm/dm-compatibility-catalog.md#compatibility-catalog-of-tidb-data-migration). |
migrate-from-mariadb.md
Outdated
|
|
||
| > **Note:** | ||
| > | ||
| > It is strongly recommended to first do this on a test or development instance of your application before doing it in production. This is both to check for possible compatibility issues as to get insight into how much time the migration will take. |
There was a problem hiding this comment.
The phrase "as to get insight" is a bit awkward. Consider rephrasing for clarity.
| > It is strongly recommended to first do this on a test or development instance of your application before doing it in production. This is both to check for possible compatibility issues as to get insight into how much time the migration will take. | |
| > It is strongly recommended to first do this on a test or development instance of your application before doing it in production. This is both to check for possible compatibility issues and to get insight into how much time the migration will take. |
migrate-from-mariadb.md
Outdated
|
|
||
| MariaDB supports some data types that TiDB does not support, such as `UUID`, `INET4`, and `INET6`. | ||
|
|
||
| To check for these datatypes, execute the following statement: |
There was a problem hiding this comment.
"datatypes" should be "data types".
| To check for these datatypes, execute the following statement: | |
| To check for these data types, execute the following statement: |
migrate-from-mariadb.md
Outdated
|
|
||
| ## Export users and grants | ||
|
|
||
| You can use [`pt-show-grants`](https://docs.percona.com/percona-toolkit/pt-show-grants.html). It is part of the Percona Toolkit to export users and grants from MariaDB and load these into TiDB. |
There was a problem hiding this comment.
The sentence structure is a bit awkward. Consider rephrasing for better readability.
| You can use [`pt-show-grants`](https://docs.percona.com/percona-toolkit/pt-show-grants.html). It is part of the Percona Toolkit to export users and grants from MariaDB and load these into TiDB. | |
| You can use `pt-show-grants`, which is part of the Percona Toolkit, to export users and grants from MariaDB and load these into TiDB. |
migrate-from-mariadb.md
Outdated
|
|
||
| While it is possible to use generic tools such as `sysbench` for testing, it is highly recommended to test some specific features of your application. For example, run a copy of your application against a TiDB cluster with a temporary copy of your data. | ||
|
|
||
| Such a test makes sure your application compatibility and performance with TiDB is verified. You need to monitor the log files of your application and TiDB to see if there are any warnings that might need to be addressed. Make sure that the database driver that your application is using (for example MySQL Connector/J for Java based applications) is tested. You might want to use an application such as JMeter to put some load on your application if needed. |
There was a problem hiding this comment.
The phrase "makes sure ... is verified" is in passive voice and a bit wordy. The style guide recommends avoiding passive voice. Consider rephrasing to active voice for conciseness. 1
| Such a test makes sure your application compatibility and performance with TiDB is verified. You need to monitor the log files of your application and TiDB to see if there are any warnings that might need to be addressed. Make sure that the database driver that your application is using (for example MySQL Connector/J for Java based applications) is tested. You might want to use an application such as JMeter to put some load on your application if needed. | |
| Such a test verifies your application's compatibility and performance with TiDB. You need to monitor the log files of your application and TiDB to see if there are any warnings that might need to be addressed. Make sure that the database driver that your application is using (for example MySQL Connector/J for Java based applications) is tested. You might want to use an application such as JMeter to put some load on your application if needed. |
Style Guide References
Footnotes
-
The style guide recommends avoiding passive voice. For example, 'The cluster is started by TiUP' should be rewritten as 'TiUP starts the cluster'. ↩
migrate-from-mariadb.md
Outdated
|
|
||
| ## Validate data | ||
|
|
||
| You can use [sync-diff-inspector](/sync-diff-inspector/sync-diff-inspector-overview.md) to validate if the data in MariaDB and TiDB are identical. |
There was a problem hiding this comment.
"validate if" is slightly ungrammatical. "validate that" or "validate whether" would be better.
| You can use [sync-diff-inspector](/sync-diff-inspector/sync-diff-inspector-overview.md) to validate if the data in MariaDB and TiDB are identical. | |
| You can use [sync-diff-inspector](/sync-diff-inspector/sync-diff-inspector-overview.md) to validate that the data in MariaDB and TiDB are identical. |
ti-chi-bot
bot
added
size/S
|
/unhold |
ti-chi-bot
bot
removed
the
do-not-merge/hold
|
/approve |
|
[APPROVALNOTIFIER] This PR is APPROVED This pull-request has been approved by: Oreoxmt 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 |
This is an automated cherry-pick of #21848
First-time contributors' checklist
What is changed, added or deleted? (Required)
The MariaDB Knowledge Base has been migrated to a new documentation platform (
mariadb.com/docs/). Many links using the oldkb/path structure are now broken (returning 404 errors) or being redirected, which impacts user experience and documentation reliability.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.
What is the related PR or file link(s)?
kb/todocs/docs-cn#20968Do your changes match any of the following descriptions?