From 61029be11003926d2db42a5cc9b3ffc024a5db1b Mon Sep 17 00:00:00 2001 From: Karl Cardenas Date: Sun, 14 Apr 2024 14:58:27 -0700 Subject: [PATCH] chore: broken URL --- Makefile | 19 ++++++++++++++----- .../edge/edgeforge-workflow/palette-canvos.md | 3 +-- .../edge/site-deployment/deploy-cluster.md | 4 ++-- .../devx/services/service-listings/mysql.md | 14 +++++--------- .../devx/services/service-listings/vault.md | 2 +- .../use-non-fips-addon-packs.md | 8 ++++---- 6 files changed, 27 insertions(+), 23 deletions(-) diff --git a/Makefile b/Makefile index fb63d49435..6e933a1f09 100644 --- a/Makefile +++ b/Makefile @@ -159,7 +159,7 @@ pdf-local: ## Generate PDF from local docs verify-url-links: @echo "Checking for broken external URLs in markdown files..." rm link_report.csv || echo "No report exists. Proceeding to scan step" - @npx linkinator "docs/**/*.md" --markdown --recurse --timeout 60000 --retry --retry-errors-count 3 \ + @npx linkinator "docs/**/*.md" --markdown --recurse --timeout 60000 --retry --retry-errors-jitter --retry-errors-count 3 \ --skip "^https:\/\/docs\.spectrocloud\.com.*$$" \ --skip "^https:\/\/docs\.spectrocloud\.com\/.*\/supplemental\-packs$$" \ --skip "^http:\/\/docs\.spectrocloud\.com.*$$" \ @@ -167,6 +167,9 @@ verify-url-links: --skip "^\/.*\.md$$" \ --skip "!\[.*\]\(.*\)$$" \ --skip "\.(jpg|jpeg|png|gif|webp)$$" \ + --skip "https:\/\/linux\.die\.net\/man\/.*$$" \ + --skip "https:\/\/mysql\.com\/.*\.*$$" \ + --skip "https:\/\/dev\.mysql\.com\/doc/\.*$$" \ --format csv > temp_report.csv && sleep 2 @grep -E 'https?://' temp_report.csv > filtered_report.csv @grep -E ',[[:space:]]*([4-9][0-9]{2}|[0-9]{4,}),' filtered_report.csv > link_report.csv && rm temp_report.csv filtered_report.csv @@ -175,10 +178,16 @@ verify-url-links-ci: ## Check for broken URLs in production in a GitHub Actions @echo "Checking for broken external URLs in CI environment..." rm link_report.json || echo "No report exists. Proceeding to scan step" @npx linkinator "docs/**/*.md" --markdown --recurse --timeout 60000 --retry --retry-errors-count 3 \ - --skip '^https:\/\/docs\.spectrocloud\.com.*' \ - --skip '^https:\/\/docs\.spectrocloud\.com\/.*\/supplemental\-packs' \ - --skip '^http:\/\/docs\.spectrocloud\.com.*' \ - --skip '^https:\/\/software-private\.spectrocloud\.com.*' \ + --skip "^https:\/\/docs\.spectrocloud\.com.*$$" \ + --skip "^https:\/\/docs\.spectrocloud\.com\/.*\/supplemental\-packs$$" \ + --skip "^http:\/\/docs\.spectrocloud\.com.*$$" \ + --skip "^https:\/\/software-private\.spectrocloud\.com.*$$" \ + --skip "^\/.*\.md$$" \ + --skip "!\[.*\]\(.*\)$$" \ + --skip "\.(jpg|jpeg|png|gif|webp)$$" \ + --skip "https:\/\/linux\.die\.net\/man\/.*$$" \ + --skip "https:\/\/mysql\.com\/.*\.*$$" \ + --skip "https:\/\/dev\.mysql\.com\/doc/\.*$$" \ --format json > temp_report.json @# Use jq to filter out links that do not start with http or https and keep only broken links @jq '[.links[] | select(.url | test("^https?://")) | select(.status >= 400)]' temp_report.json > filtered_report.json diff --git a/docs/docs-content/clusters/edge/edgeforge-workflow/palette-canvos.md b/docs/docs-content/clusters/edge/edgeforge-workflow/palette-canvos.md index 9e7b830352..29e5760d62 100644 --- a/docs/docs-content/clusters/edge/edgeforge-workflow/palette-canvos.md +++ b/docs/docs-content/clusters/edge/edgeforge-workflow/palette-canvos.md @@ -434,8 +434,7 @@ To complete this advanced guide, you will need the following items:
- 8 GB memory - 50 GB storage -- [Git](https://cli.github.com/manual/installation). You can ensure git installation by issuing the `git --version` - command. +- [Git](https://git-scm.com/downloads). You can ensure git installation by issuing the `git --version` command. - [Docker Engine](https://docs.docker.com/engine/install/) version 18.09.x or later. You can use the `docker --version` command to view the existing Docker version. You should have root-level or `sudo` privileges on your Linux machine to diff --git a/docs/docs-content/clusters/edge/site-deployment/deploy-cluster.md b/docs/docs-content/clusters/edge/site-deployment/deploy-cluster.md index 3830b62b04..e09b7f00a5 100644 --- a/docs/docs-content/clusters/edge/site-deployment/deploy-cluster.md +++ b/docs/docs-content/clusters/edge/site-deployment/deploy-cluster.md @@ -76,7 +76,7 @@ To complete this tutorial, you will need the following: - 8 GB memory - 50 GB storage -- [Git](https://cli.github.com/manual/installation). Ensure git installation by issuing the `git --version` command. +- [Git](https://git-scm.com/downloads). Ensure git installation by issuing the `git --version` command. - [Docker Engine](https://docs.docker.com/engine/install/) version 18.09.x or later. You can use the `docker --version` command to view the existing Docker version. You should have root-level or `sudo` privileges on your Linux machine to @@ -487,7 +487,7 @@ is an explanation of the options and sub-command used below: - The `sh -c "source /edge/vmware/clone_vm_template/setenv.sh && bash /edge/vmware/clone_vm_template/delete-packer-cache.sh"` shell sub-command deletes any pre-existing **packer_cache**. A known - [issue]((https://github.com/hashicorp/packer-plugin-vsphere/issues/55) with the Packer vSphere plugin causes checksum + [issue](https://github.com/hashicorp/packer-plugin-vsphere/issues/55) with the Packer vSphere plugin causes checksum logic to ignore previous builds, and reuse previously created ISO found in the **packer_cache** folder. The delete script removes any existing packer cache to prevent re-using a previously created ISO. diff --git a/docs/docs-content/devx/services/service-listings/mysql.md b/docs/docs-content/devx/services/service-listings/mysql.md index 59705f2ab4..514e503f84 100644 --- a/docs/docs-content/devx/services/service-listings/mysql.md +++ b/docs/docs-content/devx/services/service-listings/mysql.md @@ -10,10 +10,9 @@ logoUrl: "https://registry.dev.spectrocloud.com/v1/mysql-operator/blobs/sha256:2 tags: ["devx", "app mode", "pde", "databases"] --- -[MySQL](https://www.mysql.com/) is an open-source relational database management system commonly used in web -applications and other software that requires a database. It is known for its reliability, ease of use, and flexibility. -MySQL is covered under the GNU license and uses structured query language (SQL) to manage data with the following -properties: +[MySQL](https://mysql.com/) is an open-source relational database management system commonly used in web applications +and other software that requires a database. It is known for its reliability, ease of use, and flexibility. MySQL is +covered under the GNU license and uses structured query language (SQL) to manage data with the following properties: - Creates a database for storing and manipulating data and defining the relationship of each table. @@ -120,17 +119,14 @@ kubectl get secret app-tarfful-mysql-2-user \ #### Output ```shell hideClipboard -,U31nQ@T2tN4uM +**************** ``` ## Next Steps You can add MySQL to your application profile and start integrating MySQL with your applications. To learn more about -integrating MySQL with your applications, check out the [MySQL](https://redis.io/docs/manual/) documentation from -Oracle. +integrating MySQL with your applications, check out the [MySQL](https://dev.mysql.com/doc/) documentation from Oracle. ## Resources - [MySQL Documentation](https://dev.mysql.com/doc/) - -- [MySQL Tutorial](https://dev.mysql.com/doc/refman/8.0/en/tutorial.html) diff --git a/docs/docs-content/devx/services/service-listings/vault.md b/docs/docs-content/devx/services/service-listings/vault.md index 28c62861b6..e5183d1c4c 100644 --- a/docs/docs-content/devx/services/service-listings/vault.md +++ b/docs/docs-content/devx/services/service-listings/vault.md @@ -201,4 +201,4 @@ integrating Vault with your applications, check out the - [HashiCorp Vault Tutorial](https://developer.hashicorp.com/vault/tutorials) -- [Bank-Vaults Vault Operator Helm Chart](https://github.com/banzaicloud/bank-vaults/tree/main/charts/vault-operator) +- [Bank-Vaults Vault Operator Helm Chart](https://github.com/bank-vaults/vault-helm-chart) diff --git a/docs/docs-content/vertex/system-management/enable-non-fips-settings/use-non-fips-addon-packs.md b/docs/docs-content/vertex/system-management/enable-non-fips-settings/use-non-fips-addon-packs.md index 0b5202fbea..a994af01a7 100644 --- a/docs/docs-content/vertex/system-management/enable-non-fips-settings/use-non-fips-addon-packs.md +++ b/docs/docs-content/vertex/system-management/enable-non-fips-settings/use-non-fips-addon-packs.md @@ -23,10 +23,10 @@ registries. To utilize the entire suite of packs we recommend adding both regist [Add a Registry](../add-registry.md) for guidance. Our support team will provide the required credentials to access the registries. -| **Registry** | **Type** | **Endpoint URL** | **FIPS** | **Base Path** | -| ------------------------------------ | -------- | ---------------------------------------------------- | -------- | ------------- | -| **OCI Pack Registry** | AWS ECR | https://415789037893.dkr.ecr.us-east-1.amazonaws.com | No | production | -| **Spectro Cloud Community Registry** | AWS ECR | https://415789037893.dkr.ecr.us-east-1.amazonaws.com | No | community | +| **Registry** | **Type** | **Endpoint URL** | **FIPS** | **Base Path** | +| ------------------------------------ | -------- | ------------------------------------------------------ | -------- | ------------- | +| **OCI Pack Registry** | AWS ECR | `https://415789037893.dkr.ecr.us-east-1.amazonaws.com` | No | production | +| **Spectro Cloud Community Registry** | AWS ECR | `https://415789037893.dkr.ecr.us-east-1.amazonaws.com` | No | community | :::info