This is an automated email from the ASF dual-hosted git repository.
benjobs pushed a commit to branch dev
in repository https://gitbox.apache.org/repos/asf/incubator-streampark.git
The following commit(s) were added to refs/heads/dev by this push:
new 54c35b55e [CI] Fix dead links error (#3751)
54c35b55e is described below
commit 54c35b55eabb78fd0b93774126c8c50716114acc
Author: xiangzihao <[email protected]>
AuthorDate: Wed Jun 12 22:25:22 2024 +0800
[CI] Fix dead links error (#3751)
* fix dead links error
* improve docs check ci
---
.github/workflows/docs.yml | 68 +++++++++++++++++++++++++++++++++++++++++++++
.github/workflows/maven.yml | 12 --------
README.md | 6 ++--
docker/README.md | 2 +-
4 files changed, 72 insertions(+), 16 deletions(-)
diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml
new file mode 100644
index 000000000..8b0956e93
--- /dev/null
+++ b/.github/workflows/docs.yml
@@ -0,0 +1,68 @@
+#
+# Licensed to the Apache Software Foundation (ASF) under one or more
+# contributor license agreements. See the NOTICE file distributed with
+# this work for additional information regarding copyright ownership.
+# The ASF licenses this file to You under the Apache License, Version 2.0
+# (the "License"); you may not use this file except in compliance with
+# the License. You may obtain a copy of the License at
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+
+
+on:
+ push:
+ branches:
+ - dev
+ - release-*
+ - dev-*
+ paths:
+ - '**.md'
+ pull_request:
+ paths:
+ - '**.md'
+
+
+name: Docs
+
+
+concurrency:
+ group: doc-${{ github.event.pull_request.number || github.ref }}
+ cancel-in-progress: true
+
+
+jobs:
+ dead-link:
+ if: github.repository == 'apache/incubator-streampark'
+ name: Dead links
+ runs-on: ubuntu-latest
+ timeout-minutes: 20
+ steps:
+ - uses: actions/checkout@v3
+ - run: sudo npm install -g [email protected]
+ - run: |
+ for file in $(find . -name "*.md"); do
+ markdown-link-check -c .dlc.json -q "$file"
+ done
+ result:
+ name: Docs
+ runs-on: ubuntu-latest
+ timeout-minutes: 30
+ needs:
+ - dead-link
+ if: always()
+ steps:
+ - name: Status
+ run: |
+ if [[ ${{ contains(needs.*.result, 'failure') }} == 'true' || ${{
contains(needs.*.result, 'cancelled') }} == 'true' ]]; then
+ echo "Docs check Failed!"
+ exit 1
+ else
+ echo "Docs check Success!"
+ fi
diff --git a/.github/workflows/maven.yml b/.github/workflows/maven.yml
index 52e097758..30be37e82 100644
--- a/.github/workflows/maven.yml
+++ b/.github/workflows/maven.yml
@@ -61,18 +61,6 @@ jobs:
submodules: true
- name: Check codestyle
run: ./mvnw -B -q -nsu checkstyle:check spotless:check
- dead-link:
- if: github.repository == 'apache/incubator-streampark'
- name: Dead links
- runs-on: ubuntu-latest
- timeout-minutes: 20
- steps:
- - uses: actions/checkout@v3
- - run: sudo npm install -g [email protected]
- - run: |
- for file in $(find . -name "*.md"); do
- markdown-link-check -c .dlc.json -q "$file"
- done
build:
name: "maven-compile (java-${{ matrix.java }})"
runs-on: ubuntu-latest
diff --git a/README.md b/README.md
index cec8ad7d8..683b9c874 100644
--- a/README.md
+++ b/README.md
@@ -32,7 +32,7 @@
[](https://twitter.com/ASFStreamPark)
**[Website](https://streampark.apache.org)** |
-**[Official
Documentation](https://streampark.apache.org/docs/intro)** |
+**[Official
Documentation](https://streampark.apache.org/docs/get-started/intro)** |
**[FAQ](https://github.com/apache/incubator-streampark/issues/507)**
@@ -61,7 +61,7 @@
- [Start with Docker](docker/README.md)
- [Start with Kubernetes](helm/README.md)
-Click [Official
Documentation](https://streampark.apache.org/docs/user-guide/quick-start) for
more information
+Click [Official
Documentation](https://streampark.apache.org/docs/framework/quick-start) for
more information
## 🔨 How to Build
@@ -71,7 +71,7 @@ cd incubator-streampark
./build.sh
```
-🗄 Details:how to
[Development](https://streampark.apache.org/docs/user-guide/development)
+🗄 Details:how to
[Development](https://streampark.apache.org/docs/development/development)
## 🧑💻 Downloads
diff --git a/docker/README.md b/docker/README.md
index 09f16bcb6..9b2b114e7 100644
--- a/docker/README.md
+++ b/docker/README.md
@@ -20,4 +20,4 @@ docker-compose up -d
http://localhost:10000
-#### [more
detail](https://streampark.apache.org/docs/user-guide/docker-deployment)
+#### [more
detail](https://streampark.apache.org/docs/get-started/docker-deployment)
