fix broken links and add check tools

Author: heywalter

.gitignore

@@ -24,3 +24,8 @@ yarn-error.log*
 .idea/workspace.xml
 .idea/workspace.xml
 .idea/workspace.xml
+
+# Broken links reports
+broken-links-report-*.json
+broken-links-report-*.csv
+quick-broken-links-*.csv

README.md

@@ -49,6 +49,17 @@ We welcome contributions to help improve the documentation! Here is the steps:
    npm run start
    ```
 
+5. (Optional) Check broken links.
+
+   ```bash
+   cd tools
+   # Quick Check
+   npm run check-links:quick
+   
+   # or Detailed Check
+   npm run check-links
+   ```
+
 5. Create a pull request.
 
 ## Project structure

docs/case-practices/best-practice/data-sync.md

@@ -27,7 +27,7 @@ Based on the understanding of the data source, the next step is to configure dat
 
 ## Monitor and Maintain
 
-After starting the task, regularly check the task [monitoring page](../../data-replication/monitor-task.md) for details such as the synchronization rate during the full synchronization phase and changes in the source database data, so you can ensure timely identification and resolution of any issues. If you encounter task anomalies, consult the task logs for detailed [Error Codes and Solutions](../../user-guide/error-code-solution.md) to facilitate troubleshooting.
+After starting the task, regularly check the task [monitoring page](../../data-replication/monitor-task.md) for details such as the synchronization rate during the full synchronization phase and changes in the source database data, so you can ensure timely identification and resolution of any issues. If you encounter task anomalies, consult the task logs for detailed [Error Codes and Solutions](../../faq/error-code-solution.md) to facilitate troubleshooting.
 
 Additionally, during the task execution, you can log into the TapData server and use commands like `top` or `free` to monitor whether the server's compute or memory resources have reached their limits.
 

docs/case-practices/best-practice/handle-schema-changes.md

@@ -41,7 +41,7 @@ For data sources with weak Schema constraints, the Schema information of histori
 
 If a DDL synchronization error causes a data synchronization task to interrupt, you can either undo the relevant DDL operation in the source database or choose to [reload the source database's Schema](../../connectors/manage-connection.md), then reset and restart the task to repair it.
 
-Additionally, consulting the [task log](../../data-replication/monitor-task.md) and [error codes](../../user-guide/error-code-solution.md) can aid in identifying and rectifying the root causes of the task failure. A normal DDL collection and application log example is as follows:
+Additionally, consulting the [task log](../../data-replication/monitor-task.md) and [error codes](../../faq/error-code-solution.md) can aid in identifying and rectifying the root causes of the task failure. A normal DDL collection and application log example is as follows:
 
 ![DDL Log Information](../../images/ddl_apply_logs.png)
 

docs/case-practices/pipeline-tutorial/mysql-to-oracle.md

@@ -64,4 +64,4 @@ Before building the data sync pipeline, we first need to establish a connection
 
 ## See also
 
-For more advanced features like table merging or building wide tables, you can [create data transformation task](../../design-incremental-views/create-views/README.md.md) on TapData. Additionally, you can explore the [Real-Time Data Hub](../../operational-data-hub/set-up-odh.md), simply drag the source table to generate a data pipeline, which will then automatically start the task. This greatly simplifies the task configuration process.
+For more advanced features like table merging or building wide tables, you can [create data transformation task](../../design-incremental-views/create-views/README.md) on TapData. Additionally, you can explore the [Real-Time Data Hub](../../operational-data-hub/set-up-odh.md), simply drag the source table to generate a data pipeline, which will then automatically start the task. This greatly simplifies the task configuration process.

docs/case-practices/pipeline-tutorial/mysql-to-redis.md

@@ -139,4 +139,4 @@ Then in Redis, we query the corresponding data:
 
 On the task list page, you can start/stop, monitor, edit, copy, reset, delete, etc. tasks.
 
-For detailed operations, refer to [Manage Tasks](../../user-guide/data-development/monitor-task.md).
+For detailed operations, refer to [Manage Tasks](../../design-incremental-views/manage-task).

docs/case-practices/pipeline-tutorial/oracle-to-kafka.md

@@ -259,4 +259,4 @@ Processed a total of 1 messages
 
 On the task list page, you can also start/stop, monitor, edit, copy, reset, delete, and perform other operations on the task.
 
-For more information, see [Managing Tasks](../../user-guide/data-development/monitor-task.md).
+For more information, see [Managing Tasks](../../design-incremental-views/manage-task.md).

docs/connectors/mq-and-middleware/rocketmq.md

@@ -11,10 +11,10 @@
 
 ## Considerations
 
-Before configuring a RocketMQ connection, make sure your Tapdata platform or Agent version supports this connector. Otherwise, connection tests may return an error like `"the specified group is blank"`.
+After logging into the TapData platform, click the ![setting_icon](../../images/setting_icon.png) > **Notification Settings** at the top right corner. You can set up custom notification rules to automatically trigger notification processes. The main types are task operation notifications and Agent notifications. The specific notification items include:
 
-- For Tapdata Enterprise/Community users: [upgrade the platform](../../platform-ops/operation.md) to the latest version
-- For Tapdata Cloud users: [upgrade the Agent](../../user-guide/manage-agent.md) to the latest version
+- For Tapdata Enterprise/Community users: upgrade the platform to the latest version
+- For Tapdata Cloud users: upgrade the Agent to the latest version
 
 ## Connect to RocketMQ
 

docs/connectors/warehouses-and-lake/big-query.md

@@ -8,7 +8,7 @@ This article serves as a comprehensive guide, providing step-by-step instruction
 
 ## Precautions
 
-[Agent](../../installation/install-tapdata-agent.md)'s machine can access to Google Cloud Services.
+TapData Platform's machine can access to Google Cloud Services.
 
 
 

docs/data-replication/create-task.md

@@ -19,7 +19,7 @@ As an example of creating a data replication task, the article demonstrates the
 
 <details>
   <summary>Best Practices</summary>
-  To build efficient and reliable data replication tasks, it is recommended to read the <a href="../../../case-practices/best-practice/data-sync">Data Synchronization Best Practices</a> before starting to configure tasks.
+  To build efficient and reliable data replication tasks, it is recommended to read the <a href="../case-practices/best-practice/data-sync">Data Synchronization Best Practices</a> before starting to configure tasks.
 </details>
 
 1. Log in to TapData Platform.