This is an automated email from the ASF dual-hosted git repository.
wusheng pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/skywalking-banyandb.git
The following commit(s) were added to refs/heads/main by this push:
new 4e92c429 fix: some links are broken in the doc (#350)
4e92c429 is described below
commit 4e92c42997ee64e449bb86fd8478420eff20772b
Author: Rick <1450685+linuxsu...@users.noreply.github.com>
AuthorDate: Sun Nov 5 15:20:05 2023 +0800
fix: some links are broken in the doc (#350)
---
.dlc.json | 25 +++++++++++++++++++
.github/workflows/dead-link-checker.yaml | 41 ++++++++++++++++++++++++++++++++
docs/concept/persistence-storage.md | 2 +-
docs/crud/group.md | 4 ++--
docs/crud/index_rule.md | 4 ++--
docs/crud/index_rule_binding.md | 4 ++--
docs/crud/property.md | 4 ++--
7 files changed, 75 insertions(+), 9 deletions(-)
diff --git a/.dlc.json b/.dlc.json
new file mode 100644
index 00000000..4869ba03
--- /dev/null
+++ b/.dlc.json
@@ -0,0 +1,25 @@
+{
+ "ignorePatterns": [
+ {
+ "pattern": "^http://localhost";
+ },
+ {
+ "pattern":
"^https://dist.apache.org/repos/dist/dev/skywalking/banyandb/\\$VERSION";
+ },
+ {
+ "pattern": "^https://twitter.com*";
+ },
+ {
+ "pattern": "^#"
+ }
+ ],
+ "timeout": "10s",
+ "retryOn429": true,
+ "retryCount": 10,
+ "fallbackRetryDelay": "1000s",
+ "aliveStatusCodes": [
+ 200,
+ 401,
+ 403
+ ]
+}
diff --git a/.github/workflows/dead-link-checker.yaml
b/.github/workflows/dead-link-checker.yaml
new file mode 100644
index 00000000..8103bc34
--- /dev/null
+++ b/.github/workflows/dead-link-checker.yaml
@@ -0,0 +1,41 @@
+# 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.
+
+name: Dead Link Checker
+
+on:
+ pull_request:
+ paths:
+ - 'docs/**'
+ schedule:
+ - cron: '0 18 * * *' # TimeZone: UTC 0
+
+concurrency:
+ group: dlc-${{ github.event.pull_request.number || github.ref }}
+ cancel-in-progress: true
+
+jobs:
+ CheckDeadLinks:
+ if: (github.event_name == 'schedule' && github.repository ==
'apache/skywalking-banyandb') || (github.event_name != 'schedule')
+ runs-on: ubuntu-latest
+ timeout-minutes: 30
+ steps:
+ - uses: actions/checkout@v3
+ - run: sudo npm install -g markdown-link-check@3.10.0
+ - run: |
+ for file in $(find . -name "*.md"); do
+ markdown-link-check -c .dlc.json -q "$file"
+ done
diff --git a/docs/concept/persistence-storage.md
b/docs/concept/persistence-storage.md
index 190fa42d..48199985 100644
--- a/docs/concept/persistence-storage.md
+++ b/docs/concept/persistence-storage.md
@@ -20,7 +20,7 @@ Persistence storage offers a range of IO modes to cater to
various throughput re
## Io_uring
Io_uring is a new feature in Linux 5.1, which is fully asynchronous and offers
high throughput. In the scene of massive storage, io_uring can bring
significant benefits. The following is the diagram about how io_uring works.
-
+
If the user sets io_uring for use, the read and write requests will first be
placed in the submission queue buffer when calling the operation API. When the
threshold is reached, batch submissions will be made to SQ. After the kernel
threads complete execution, the requests will be placed in the CQ, and the user
can obtain the request results.
## Synchronous IO
diff --git a/docs/crud/group.md b/docs/crud/group.md
index 237fc170..7833670c 100644
--- a/docs/crud/group.md
+++ b/docs/crud/group.md
@@ -4,7 +4,7 @@ CRUD operations create, read, update and delete groups.
The group represents a collection of a class of resources. Each resource has a
name unique to a group.
-[`bydbctl`](../../clients.md#command-line) is the command line tool in
examples.
+[`bydbctl`](../clients.md#command-line) is the command line tool in examples.
## Create operation
@@ -93,4 +93,4 @@ $ bydbctl group list
```
## API Reference
-[GroupService v1](../../api-reference.md#groupservice)
+[GroupService v1](../api-reference.md#groupservice)
diff --git a/docs/crud/index_rule.md b/docs/crud/index_rule.md
index 5e8c2945..d6ce08e8 100644
--- a/docs/crud/index_rule.md
+++ b/docs/crud/index_rule.md
@@ -5,7 +5,7 @@ CRUD operations create, read, update and delete index rules.
IndexRule defines how to generate indices based on tags and the index type.
IndexRule should bind to a subject(stream or measure) through an
IndexRuleBinding to generate proper indices.
-[`bydbctl`](../../clients.md#command-line) is the command line tool in
examples.
+[`bydbctl`](../clients.md#command-line) is the command line tool in examples.
## Create operation
@@ -110,4 +110,4 @@ $ bydbctl indexRule list -g sw_stream
## API Reference
-[indexRuleService v1](../../api-reference.md#IndexRuleRegistryService)
+[indexRuleService v1](../api-reference.md#IndexRuleRegistryService)
diff --git a/docs/crud/index_rule_binding.md b/docs/crud/index_rule_binding.md
index eae09d5c..3d01b009 100644
--- a/docs/crud/index_rule_binding.md
+++ b/docs/crud/index_rule_binding.md
@@ -5,7 +5,7 @@ CRUD operations create, read, update and delete index rule
bindings.
An index rule binding is a bridge to connect several index rules to a subject.
This binding is valid between `begin_at_nanoseconds` and
`expire_at_nanoseconds`, that provides flexible strategies to control how to
generate time series indices.
-[`bydbctl`](../../clients.md#command-line) is the command line tool in
examples.
+[`bydbctl`](../clients.md#command-line) is the command line tool in examples.
## Create operation
@@ -137,4 +137,4 @@ $ bydbctl indexRuleBinding list -g sw_stream
## API Reference
-[indexRuleBindingService
v1](../../api-reference.md#IndexRuleBindingRegistryService)
\ No newline at end of file
+[indexRuleBindingService
v1](../api-reference.md#IndexRuleBindingRegistryService)
\ No newline at end of file
diff --git a/docs/crud/property.md b/docs/crud/property.md
index 78ebf8a5..526df709 100644
--- a/docs/crud/property.md
+++ b/docs/crud/property.md
@@ -4,7 +4,7 @@ CRUD operations create/update, read and delete property.
Property stores the user defined data.
-[`bydbctl`](../../clients.md#command-line) is the command line tool in
examples.
+[`bydbctl`](../clients.md#command-line) is the command line tool in examples.
## Apply (Create/Update) operation
@@ -169,4 +169,4 @@ $ bydbctl property keepalive --lease_id 1
## API Reference
-[MeasureService v1](../../api-reference.md#PropertyService)
+[MeasureService v1](../api-reference.md#PropertyService)
