You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@devlake.apache.org by ab...@apache.org on 2023/12/11 11:26:50 UTC
(incubator-devlake-website) branch main updated: Fix dead links (#688)
This is an automated email from the ASF dual-hosted git repository.
abeizn pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/incubator-devlake-website.git
The following commit(s) were added to refs/heads/main by this push:
new 5db7493981 Fix dead links (#688)
5db7493981 is described below
commit 5db7493981b51869ec3f46628b7fea640381caae
Author: Lynwee <li...@merico.dev>
AuthorDate: Mon Dec 11 19:26:45 2023 +0800
Fix dead links (#688)
* update some 404 links
* update ci link checker, exclude versioned_docs
* fix(ci): update exclude paths
* fix(links): fix some deadlinks in old version docs
---
.github/workflows/link-schedule.yaml | 6 ++++--
blog/2022-06-17-How DevLake is up and running/index.md | 4 ++--
docs/GettingStarted/Upgrade.md | 2 +-
versioned_docs/version-v0.15/Plugins/webhook.md | 2 +-
versioned_docs/version-v0.18/GettingStarted/Upgrade.md | 2 +-
versioned_docs/version-v0.19/GettingStarted/Upgrade.md | 2 +-
versioned_docs/version-v0.20/GettingStarted/Upgrade.md | 2 +-
7 files changed, 11 insertions(+), 9 deletions(-)
diff --git a/.github/workflows/link-schedule.yaml b/.github/workflows/link-schedule.yaml
index 0236e897c2..538726f765 100644
--- a/.github/workflows/link-schedule.yaml
+++ b/.github/workflows/link-schedule.yaml
@@ -49,8 +49,10 @@ jobs:
GITHUB_WORKFLOW_URL="https://github.com/${GITHUB_REPOSITORY}/actions/runs/${GITHUB_RUN_ID}?check_suite_focus=true"
if ! lychee --output ${OUTPUT_FILE} \
- -E -i -n -t 5 --max-concurrency 64 -a 429,401,403 -m 10 -f markdown -s http -s https \
- '**/*.md'
+ -E -i -n -t 5 --max-concurrency 64 -a 429,401,403 -m 10 -f markdown \
+ -s http --exclude-path versioned_docs/version-v0.15 --exclude-path versioned_docs/version-v0.16 --exclude-path versioned_docs/version-v0.17 \
+ -s https --exclude-path versioned_docs/version-v0.15 --exclude-path versioned_docs/version-v0.16 --exclude-path versioned_docs/version-v0.17 \
+ '**/*.md'
then
echo "" >> "${OUTPUT_FILE}" # add a new line
echo "[Full Github Actions output](${GITHUB_WORKFLOW_URL})" >> "${OUTPUT_FILE}"
diff --git a/blog/2022-06-17-How DevLake is up and running/index.md b/blog/2022-06-17-How DevLake is up and running/index.md
index c71aa4e6ab..43bfab139c 100644
--- a/blog/2022-06-17-How DevLake is up and running/index.md
+++ b/blog/2022-06-17-How DevLake is up and running/index.md
@@ -9,7 +9,7 @@ tags: [devlake, apache]
[Apache DevLake](https://github.com/apache/incubator-devlake) is an integration tool with the DevOps data collection functionality, which presents a different stage of data to development teams via Grafana. which also can leverage teams to improve the development process with a data-driven model.
### Apache DevLack Architecture Overview
-- The left side of the following screenshot is an [integrative DevOps data plugin](https://devlake.apache.org/docs/next/Overview/SupportedDataSources/), the existing plugins include Github, GitLab, JIRA, Jenkins, Tapd, Feishu, and the most featured analysis engine in the Simayi platform.
+- The left side of the following screenshot is an [integrative DevOps data plugin](https://devlake.apache.org/docs/Overview/SupportedDataSources/), the existing plugins include Github, GitLab, JIRA, Jenkins, Tapd, Feishu, and the most featured analysis engine in the Simayi platform.
- The main framework in the middle of the following screenshot, completes data collection, expansion, and conversion to the domain layer by running subtasks in the plugins. The user can trigger the tasks by config-UI or all API.
- RMDBS currently supports Mysql and PostgresSQL, more databases will be supported in the future.
- Grafana can generate different types of needed data by using SQL.
@@ -73,7 +73,7 @@ The following is the pipeline running flow chart.

-A pipeline contains a two-dimensional array of tasks, mainly to ensure that a series of tasks are executed in a preset order. Like the following screenshot if the plugin of Stage 3 needs to rely on the other plugin to prepare the data(eg: the operation of refdiff needs to rely on gitextractor and Github, for more information on data sources and plugins, please refer to the [documentation](https://devlake.apache.org/docs/next/Overview/SupportedDataSources/), then when Stage 3 starts to ex [...]
+A pipeline contains a two-dimensional array of tasks, mainly to ensure that a series of tasks are executed in a preset order. Like the following screenshot if the plugin of Stage 3 needs to rely on the other plugin to prepare the data(eg: the operation of refdiff needs to rely on gitextractor and Github, for more information on data sources and plugins, please refer to the [documentation](https://devlake.apache.org/docs/Overview/SupportedDataSources/), then when Stage 3 starts to execute [...]

diff --git a/docs/GettingStarted/Upgrade.md b/docs/GettingStarted/Upgrade.md
index a55604a48c..c54fbd1b84 100644
--- a/docs/GettingStarted/Upgrade.md
+++ b/docs/GettingStarted/Upgrade.md
@@ -10,7 +10,7 @@ description: How to upgrade your Apache DevLake to a newer version
3. Back up your Grafana dashboards before upgrade if you have modified/customized any dashboards. You can re-import these dashboards to Grafana after the upgrade.
-4. Upgrade to v0.18.0+: When upgrading from a previous version of DevLake, you need to find the ENCODE_KEY value in the .env file of devlake container, and assign the value to ENCRYPTION_SECRET according to the upgrade steps, see [helm setup](https://devlake.apache.org/docs/next/GettingStarted/HelmSetup) or [docker compose setup](https://devlake.apache.org/docs/next/GettingStarted/DockerComposeSetup). This will ensure that the encryption process continues to work as expected.
+4. Upgrade to v0.18.0+: When upgrading from a previous version of DevLake, you need to find the ENCODE_KEY value in the .env file of devlake container, and assign the value to ENCRYPTION_SECRET according to the upgrade steps, see [helm setup](https://devlake.apache.org/docs/GettingStarted/HelmSetup) or [docker compose setup](https://devlake.apache.org/docs/GettingStarted/DockerComposeSetup). This will ensure that the encryption process continues to work as expected.
5. Upgrade to v0.18.0+: When upgrading from a previous version of DevLake, You may encounter the below error when upgrading because the built-in grafana has been replaced by the official grafana dependency. So you may need to delete the grafana deployment first, please also take care of Note 3 before deleting.
diff --git a/versioned_docs/version-v0.15/Plugins/webhook.md b/versioned_docs/version-v0.15/Plugins/webhook.md
index a5ade0e4f6..149167a8e5 100644
--- a/versioned_docs/version-v0.15/Plugins/webhook.md
+++ b/versioned_docs/version-v0.15/Plugins/webhook.md
@@ -67,7 +67,7 @@ curl https://sample-url.com/api/plugins/webhook/1/deployments -X 'POST' -d '{
}'
```
-If you have set a [username/password](https://devlake.apache.org/docs/next/GettingStarted/Authentication) for Config UI, you'll need to add them to the curl command to register a `deployment`:
+If you have set a [username/password](https://devlake.apache.org/docs/v0.15/GettingStarted/Authentication) for Config UI, you'll need to add them to the curl command to register a `deployment`:
```
curl https://sample-url.com/api/plugins/webhook/1/deployments -X 'POST' -u 'username:password' -d '{
diff --git a/versioned_docs/version-v0.18/GettingStarted/Upgrade.md b/versioned_docs/version-v0.18/GettingStarted/Upgrade.md
index 1a170fa394..37a9e9548c 100644
--- a/versioned_docs/version-v0.18/GettingStarted/Upgrade.md
+++ b/versioned_docs/version-v0.18/GettingStarted/Upgrade.md
@@ -12,7 +12,7 @@ description: How to upgrade your Apache DevLake to a newer version
3. Back up your Grafana dashboards before upgrade if you have modified/customized any dashboards. You can re-import these dashboards to Grafana after the upgrade.
-4. Upgrade to v0.18.0+: When upgrading from a previous version of DevLake, you need to find the ENCODE_KEY value in the .env file of devlake container, and assign the value to ENCRYPTION_SECRET according to the upgrade steps, see [helm setup](https://devlake.apache.org/docs/next/GettingStarted/HelmSetup) or [docker compose setup](https://devlake.apache.org/docs/next/GettingStarted/DockerComposeSetup). This will ensure that the encryption process continues to work as expected.
+4. Upgrade to v0.18.0+: When upgrading from a previous version of DevLake, you need to find the ENCODE_KEY value in the .env file of devlake container, and assign the value to ENCRYPTION_SECRET according to the upgrade steps, see [helm setup](https://devlake.apache.org/docs/v0.18/GettingStarted/HelmSetup) or [docker compose setup](https://devlake.apache.org/docs/v0.18/GettingStarted/DockerComposeSetup). This will ensure that the encryption process continues to work as expected.
5. Upgrade to v0.18.0+: When upgrading from a previous version of DevLake, You may encounter the below error when upgrading because the built-in grafana has been replaced by the official grafana dependency. So you may need to delete the grafana deployment first, please also take care of Note 3 before deleting.
diff --git a/versioned_docs/version-v0.19/GettingStarted/Upgrade.md b/versioned_docs/version-v0.19/GettingStarted/Upgrade.md
index 1a170fa394..675b1a177c 100644
--- a/versioned_docs/version-v0.19/GettingStarted/Upgrade.md
+++ b/versioned_docs/version-v0.19/GettingStarted/Upgrade.md
@@ -12,7 +12,7 @@ description: How to upgrade your Apache DevLake to a newer version
3. Back up your Grafana dashboards before upgrade if you have modified/customized any dashboards. You can re-import these dashboards to Grafana after the upgrade.
-4. Upgrade to v0.18.0+: When upgrading from a previous version of DevLake, you need to find the ENCODE_KEY value in the .env file of devlake container, and assign the value to ENCRYPTION_SECRET according to the upgrade steps, see [helm setup](https://devlake.apache.org/docs/next/GettingStarted/HelmSetup) or [docker compose setup](https://devlake.apache.org/docs/next/GettingStarted/DockerComposeSetup). This will ensure that the encryption process continues to work as expected.
+4. Upgrade to v0.18.0+: When upgrading from a previous version of DevLake, you need to find the ENCODE_KEY value in the .env file of devlake container, and assign the value to ENCRYPTION_SECRET according to the upgrade steps, see [helm setup](https://devlake.apache.org/docs/v0.19/GettingStarted/HelmSetup) or [docker compose setup](https://devlake.apache.org/docs/v0.19/GettingStarted/DockerComposeSetup). This will ensure that the encryption process continues to work as expected.
5. Upgrade to v0.18.0+: When upgrading from a previous version of DevLake, You may encounter the below error when upgrading because the built-in grafana has been replaced by the official grafana dependency. So you may need to delete the grafana deployment first, please also take care of Note 3 before deleting.
diff --git a/versioned_docs/version-v0.20/GettingStarted/Upgrade.md b/versioned_docs/version-v0.20/GettingStarted/Upgrade.md
index 1a170fa394..15501b4375 100644
--- a/versioned_docs/version-v0.20/GettingStarted/Upgrade.md
+++ b/versioned_docs/version-v0.20/GettingStarted/Upgrade.md
@@ -12,7 +12,7 @@ description: How to upgrade your Apache DevLake to a newer version
3. Back up your Grafana dashboards before upgrade if you have modified/customized any dashboards. You can re-import these dashboards to Grafana after the upgrade.
-4. Upgrade to v0.18.0+: When upgrading from a previous version of DevLake, you need to find the ENCODE_KEY value in the .env file of devlake container, and assign the value to ENCRYPTION_SECRET according to the upgrade steps, see [helm setup](https://devlake.apache.org/docs/next/GettingStarted/HelmSetup) or [docker compose setup](https://devlake.apache.org/docs/next/GettingStarted/DockerComposeSetup). This will ensure that the encryption process continues to work as expected.
+4. Upgrade to v0.18.0+: When upgrading from a previous version of DevLake, you need to find the ENCODE_KEY value in the .env file of devlake container, and assign the value to ENCRYPTION_SECRET according to the upgrade steps, see [helm setup](https://devlake.apache.org/docs/v0.20/GettingStarted/HelmSetup) or [docker compose setup](https://devlake.apache.org/docs/v0.20/GettingStarted/DockerComposeSetup). This will ensure that the encryption process continues to work as expected.
5. Upgrade to v0.18.0+: When upgrading from a previous version of DevLake, You may encounter the below error when upgrading because the built-in grafana has been replaced by the official grafana dependency. So you may need to delete the grafana deployment first, please also take care of Note 3 before deleting.