StarRocks / starrocks

StarRocks, a Linux Foundation project, is a next-generation sub-second MPP OLAP database for full analytics scenarios, including multi-dimensional analytics, real-time analytics, and ad-hoc queries.
https://starrocks.io
Apache License 2.0
8.26k stars 1.67k forks source link

[Documentation] Need to fix broken links in docs #47620

Closed yandongxiao closed 2 days ago

yandongxiao commented 3 days ago

I used a tool to check all markdown files under docs directory, check whether the link is valid. And I found the following broken links:

  1. some url return 404 because the resource does not exist
  2. some url return 404 because it links to a private repo
  3. some links have a blank space
  4. and some check maybe wrong
broken link: ../../assets/test.png in file: starrocks/docs/README.md
broken link: ./data_source/catalog/hive_catalog.md in file: starrocks/docs/README.md
broken link: link URL in file: starrocks/docs/README.md
broken link: https://github.com/StarRocks/docs-site/tree/docusaurus/versioned_sidebars in file: starrocks/docs/docusaurus/README.md
broken link: https://github.com/StarRocks/docs-site/issues/105 in file: starrocks/docs/docusaurus/README.md
broken link: https://signin.aws.amazon.com/signin?redirect_uri=https%3A%2F%2Fus-east-1.console.aws.amazon.com%2Fcloudformation%2Fhome%3Fregion%3Dus-east-1%26state%3DhashArgs%2523%252Fstacks%252Fnew%253FstackName%253Dstarrocks-starrocks%2526templateURL%253Dhttps%253A%252F%252Faws-quickstart.s3.us-east-1.amazonaws.com%252Fquickstart-starrocks-starrocks%252Ftemplates%252Fstarrocks-entrypoint-new-vpc.template.yaml%26isauthcode%3Dtrue&client_id=arn%3Aaws%3Aiam%3A%3A015428540659%3Auser%2Fcloudformation&forceMobileApp=0&code_challenge=yo-6I1O2W0f0VcoqYOVvSwMmhRkC7Vod1M9vWbiMWUM&code_challenge_method=SHA-256 in file: starrocks/docs/en/deployment/starrocks_on_aws.md
broken link: https://signin.aws.amazon.com/signin?redirect_uri=https%3A%2F%2Fus-east-1.console.aws.amazon.com%2Fcloudformation%2Fhome%3Fregion%3Dus-east-1%26state%3DhashArgs%2523%252Fstacks%252Fnew%253FstackName%253Dstarrocks-starrocks%2526templateURL%253Dhttps%253A%252F%252Faws-quickstart.s3.us-east-1.amazonaws.com%252Fquickstart-starrocks-starrocks%252Ftemplates%252Fstarrocks-entrypoint-existing-vpc.template.yaml%26isauthcode%3Dtrue&client_id=arn%3Aaws%3Aiam%3A%3A015428540659%3Auser%2Fcloudformation&forceMobileApp=0&code_challenge=dDa178BxB6UkFfrpADw5CIoZ4yDUNRTG7sNM1EO__eo&code_challenge_method=SHA-256 in file: starrocks/docs/en/deployment/starrocks_on_aws.md
broken link: https://localhost:10001/admin/query_engine/ in file: starrocks/docs/en/integrations/BI_integrations/Querybook.md
broken link: https://github.com/StarRocks/starrocks/tree/main/contrib/starrocks-python-client/starrocks/sqlalchemy in file: starrocks/docs/en/integrations/superset_support.md
broken link: https://www.linkedin.com/company/starrocks in file: starrocks/docs/en/introduction/StarRocks_intro.md
broken link: https://nightlies.apache.org/flink/flink-cdc-docs-stable/docs/connectors/starrocks in file: starrocks/docs/en/loading/Flink-connector-starrocks.md
broken link: https://ververica.github.io/flink-cdc-connectors/release-2.2/content/about.html#supported-flink-versions in file: starrocks/docs/en/loading/Flink_cdc_load.md
broken link: https://github.com/ververica/flink-cdc-connectors/blob/master/docs/content/quickstart/build-real-time-data-lake-tutorial.md in file: starrocks/docs/en/loading/Flink_cdc_load.md
broken link: ../sql-reference/sql-statements/data-manipulation/STREAM LOAD.md in file: starrocks/docs/en/loading/Kafka-connector-starrocks.md
broken link: http://localhost:9000/ in file: starrocks/docs/en/quick_start/hudi.md
broken link: http://localhost:9001/browser/ in file: starrocks/docs/en/quick_start/routine-load.md
broken link: https://goessner.net/articles/JsonPath/ in file: starrocks/docs/en/quick_start/routine-load.md
broken link: http://localhost:9001/browser/starrocks/ in file: starrocks/docs/en/quick_start/shared-data.md
broken link:
broken link:  https://github.com/StarRocks/starrocks/pull/12204 in file: starrocks/docs/en/release_notes/release-2.3.md
broken link: http://www.json.org/?spm=a2c63.p38356.0.0.50756b9fVEfwCd in file: starrocks/docs/en/sql-reference/data-types/semi_structured/JSON.md
broken link: https://dev.mysql.com/doc/connector-j/8.0/en/connector-j-reference-jdbc-url-format.html in file: starrocks/docs/zh/data_source/External_table.md
broken link: ../../assets/test.png in file: starrocks/docs/zh/feedback-and-contribute.md
broken link: 引用文档链接 in file: starrocks/docs/zh/feedback-and-contribute.md
broken link: https://localhost:10001/admin/query_engine/ in file: starrocks/docs/zh/integrations/BI_integrations/Querybook.md
broken link: https://github.com/StarRocks/starrocks/tree/main/contrib/starrocks-python-client/starrocks/sqlalchemy in file: starrocks/docs/zh/integrations/superset_support.md
broken link: https://nightlies.apache.org/flink/flink-cdc-docs-stable/docs/connectors/starrocks in file: starrocks/docs/zh/loading/Flink-connector-starrocks.md
broken link: https://ververica.github.io/flink-cdc-connectors/release-2.2/content/about.html#supported-flink-versions in file: starrocks/docs/zh/loading/Flink_cdc_load.md
broken link: https://ververica.github.io/flink-cdc-connectors/master/content/快速上手/build-real-time-data-lake-tutorial-zh.html in file: starrocks/docs/zh/loading/Flink_cdc_load.md
broken link: https://docs.automq.com/zh/docs/automq-s3kafka/VKpxwOPvciZmjGkHk5hcTz43nde in file: starrocks/docs/zh/loading/automq-routine-load.md
broken link: http://localhost:9001/browser/starrocks/ in file: starrocks/docs/zh/quick_start/shared-data.md
broken link:  https://github.com/StarRocks/starrocks/pull/12204 in file: starrocks/docs/zh/release_notes/release-2.3.md
broken link:  https://docs.starrocks.io/zh/docs/3.2/using_starrocks/Cost_based_optimizer/#%E9%87%87%E9%9B%86-hiveiceberghudi-%E8%A1%A8%E7%9A%84%E7%BB%9F%E8%AE%A1%E4%BF%A1%E6%81%AF in file: starrocks/docs/zh/release_notes/release-3.2.md
broken link: http://www.json.org/?spm=a2c63.p38356.0.0.50756b9fVEfwCd in file: starrocks/docs/zh/sql-reference/data-types/semi_structured/JSON.md
broken link: https://dev.mysql.com/doc/connector-j/8.0/en/connector-j-reference-jdbc-url-format.html in file: starrocks/docs/zh/sql-reference/sql-statements/data-definition/CREATE_RESOURCE.md