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

[FLINK-34732][cdc][ci] Add document dead link check for Flink CDC Documentation #3168

Merged
merged 3 commits into from
Mar 25, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
35 changes: 35 additions & 0 deletions .dlc.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,35 @@
{
"ignorePatterns": [
{
"pattern": "^http://localhost"
},
{
"pattern": "^#"
},
{
"pattern": "^{"
},
{
"pattern": "^https://repo1.maven.org/maven2/org/apache/flink.*SNAPSHOT.*"
},
{
"pattern": "^https://mvnrepository.com"
},
{
"pattern": "^https://img.shields.io"
},
{
"pattern": "^https://twitter.com*"
}
],
"timeout": "30s",
"retryOn429": true,
"retryCount": 10,
"fallbackRetryDelay": "1000s",
"aliveStatusCodes": [
0,
200,
401,
403
]
}
18 changes: 17 additions & 1 deletion .github/workflows/build_docs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,12 @@
name: "Build documentation"

on:
pull_request:
branches:
- master
- release-*
paths:
- 'docs/**'
push:
paths:
- 'docs/**'
Expand All @@ -30,9 +36,19 @@ concurrency:
cancel-in-progress: true

jobs:
build-documentation:

markdown-link-check:
if: github.repository == 'apache/flink-cdc'
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@master
- uses: gaurav-nelson/github-action-markdown-link-check@1.0.15
with:
config-file: '.dlc.json'

build-documentation:
if: github.event_name != 'pull_request' && github.repository == 'apache/flink-cdc'
runs-on: ubuntu-latest
strategy:
max-parallel: 1
matrix:
Expand Down
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
<p align="center">
<a href="[https://github.com/apache/flink-cdc](https://nightlies.apache.org/flink/flink-cdc-docs-stable/)"><img src="docs/static/fig/flinkcdc-logo.png" alt="Flink CDC" style="width: 375px;"></a>
<a href="https://nightlies.apache.org/flink/flink-cdc-docs-stable/"><img src="docs/static/fig/flinkcdc-logo.png" alt="Flink CDC" style="width: 375px;"></a>
</p>
<p align="center">
<a href="https://github.com/apache/flink-cdc/" target="_blank">
Expand Down
2 changes: 1 addition & 1 deletion docs/content.zh/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -165,7 +165,7 @@ under the License.
<p style="text-align: left; color: #BF74F1; font-size: x-large; padding: 0">Try Flink CDC</p>
<p style="text-align: left;">
Flink CDC provides a series of quick start demos without any dependencies or java code. A Linux or MacOS computer with Docker installed is enough.
Please check out our <a href="docs/get-started/introduction">Quick Start</a> for more information.
Please check out our <a href="{{< ref "docs/get-started/introduction" >}}">Quick Start</a> for more information.
</p>
</div>
<div style="flex: 1;"></div>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -32,9 +32,9 @@ describes how to setup the db2 CDC connector to run SQL queries against Db2 data

## Supported Databases

| Connector | Database | Driver |
|-----------------------|----------------------------------------------------|----------------------|
| [Db2-cdc](../db2-cdc) | <li> [Db2](https://www.ibm.com/products/db2): 11.5 | Db2 Driver: 11.5.0.0 |
| Connector | Database | Driver |
|-----------|----------------------------------------------------|----------------------|
| Db2-cdc | <li> [Db2](https://www.ibm.com/products/db2): 11.5 | Db2 Driver: 11.5.0.0 |
PatrickRen marked this conversation as resolved.
Show resolved Hide resolved

Dependencies
------------
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -30,9 +30,9 @@ MySQL CDC 连接器允许从 MySQL 数据库读取快照数据和增量数据。

## 支持的数据库

| Connector | Database | Driver |
|----------------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------|
| mysql-cdc | <li> [MySQL](https://dev.mysql.com/doc): 5.6, 5.7, 8.0.x <li> [RDS MySQL](https://www.aliyun.com/product/rds/mysql): 5.6, 5.7, 8.0.x <li> [PolarDB MySQL](https://www.aliyun.com/product/polardb): 5.6, 5.7, 8.0.x <li> [Aurora MySQL](https://aws.amazon.com/cn/rds/aurora): 5.6, 5.7, 8.0.x <li> [MariaDB](https://mariadb.org): 10.x <li> [PolarDB X](https://github.com/ApsaraDB/galaxysql): 2.0.1 | JDBC Driver: 8.0.27 |
| Connector | Database | Driver |
|-----------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------|
| mysql-cdc | <li> [MySQL](https://dev.mysql.com/doc): 5.6, 5.7, 8.0.x <li> [RDS MySQL](https://www.aliyun.com/product/rds/mysql): 5.6, 5.7, 8.0.x <li> [PolarDB MySQL](https://www.aliyun.com/product/polardb): 5.6, 5.7, 8.0.x <li> [Aurora MySQL](https://aws.amazon.com/cn/rds/aurora): 5.6, 5.7, 8.0.x <li> [MariaDB](https://mariadb.org): 10.x <li> [PolarDB X](https://github.com/ApsaraDB/galaxysql): 2.0.1 | JDBC Driver: 8.0.27 |
PatrickRen marked this conversation as resolved.
Show resolved Hide resolved

依赖
------------
Expand Down Expand Up @@ -740,7 +740,7 @@ $ ./bin/flink run \
<table class="colwidths-auto docutils">
<thead>
<tr>
<th class="text-left" style="width:30%;">MySQL type<a href="https://dev.mysql.com/doc/man/8.0/en/data-types.html"></a></th>
<th class="text-left" style="width:30%;">MySQL type<a href="https://dev.mysql.com/doc/refman/8.0/en/data-types.html"></a></th>
<th class="text-left" style="width:10%;">Flink SQL type<a href="{% link dev/table/types.md %}"></a></th>
<th class="text-left" style="width:60%;">NOTE</th>
</tr>
Expand Down