Skip to content

Commit

Permalink
chore: fix broken URLs (#2631)
Browse files Browse the repository at this point in the history
* chore: fix broken URLs

* chore: broken URL
  • Loading branch information
karl-cardenas-coding committed Apr 14, 2024
1 parent 13ff47b commit 5938740
Show file tree
Hide file tree
Showing 11 changed files with 58 additions and 35 deletions.
19 changes: 14 additions & 5 deletions Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -155,14 +155,17 @@ 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.*$$" \
--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 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
Expand All @@ -171,10 +174,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
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ Ensure the following Google Cloud Platform (GCP) API services are enabled in you

- [Cloud Resource Manager API](https://cloud.google.com/resource-manager/reference/rest)
- [Compute Engine API](https://cloud.google.com/compute/docs/reference/rest/v1)
- [Kubernetes Engine API](https://cloud.google.com/kubernetes-engine/docs/reference/rest/v1)
- [Kubernetes Engine API](https://cloud.google.com/kubernetes-engine/docs/reference/rest)

:::tip

Expand Down
14 changes: 5 additions & 9 deletions docs/docs-content/devx/services/service-listings/mysql.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Expand Down Expand Up @@ -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)
4 changes: 2 additions & 2 deletions docs/docs-content/devx/services/service-listings/vault.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ Vault also tracks who has accessed which secrets and when, making it easier to m
govern access to secrets, automate application delivery, and consume secrets programmatically.

Vault is deployed behind the scenes through the use of the
[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/bank-vaults).

<br />

Expand Down Expand Up @@ -200,4 +200,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)
4 changes: 2 additions & 2 deletions docs/docs-content/integrations/citrix-ipam.md
Original file line number Diff line number Diff line change
Expand Up @@ -46,6 +46,6 @@ Integration deploys the following components:

## References

- [Citrix IPAM Controller](https://developer-docs.citrix.com/projects/citrix-k8s-ingress-controller/en/latest/crds/vip)
- [Citrix IPAM Controller](https://docs.netscaler.com/en-us/netscaler-k8s-ingress-controller/configure/ipam-for-ingress.html)

- [Citrix Ingress controller](https://developer-docs.citrix.com/projects/citrix-k8s-ingress-controller/en/latest/network/type_loadbalancer/#expose-services-of-type-loadbalancer-using-an-ip-address-from-the-citrix-ipam-controller)
- [Citrix Ingress controller](https://docs.netscaler.com/en-us/netscaler-k8s-ingress-controller/#expose-services-of-type-loadbalancer-using-an-ip-address-from-the-citrix-ipam-controller)
2 changes: 1 addition & 1 deletion docs/docs-content/integrations/cloudanix.md
Original file line number Diff line number Diff line change
Expand Up @@ -130,4 +130,4 @@ data "spectrocloud_pack_simple" "cloudanix" {

## References

- [Cloudanix Documentation](https://docs.cloudanix.com/introduction)
- [Cloudanix Documentation](https://www.cloudanix.com/docs/introduction)
2 changes: 1 addition & 1 deletion docs/docs-content/integrations/falco.md
Original file line number Diff line number Diff line change
Expand Up @@ -39,4 +39,4 @@ use Falco to monitor the run-time security of your Kubernetes applications and i

## References

- [Falco Helm Chart GitHub](https://github.com/falcosecurity/charts/tree/master/falco)
- [Falco Helm Chart GitHub](https://github.com/falcosecurity/charts/tree/master/charts/falco)
28 changes: 24 additions & 4 deletions docs/docs-content/integrations/longhorn.md
Original file line number Diff line number Diff line change
Expand Up @@ -50,8 +50,18 @@ Longhorn provides these features:
- Backup to secondary storage (NFSv4 or S3-compatible object storage) built on change block detection.
- Recurring snapshot and backup.

For more information, check out Longhorn guide on
[How to Create Volumes](https://longhorn.io/docs/1.4.0/volumes-and-nodes/create-volumes/).
- [Access the Longhorn UI](https://longhorn.io/docs/latest/deploy/accessing-the-ui/#accessing-the-longhorn-ui)

- [Longhorn Networking](https://longhorn.io/docs/1.4.4/references/networking/)

- [Node Maintenance and Kubernetes Upgrade Guide](https://longhorn.io/docs/1.4.4/volumes-and-nodes/maintenance/)

- [Storage Tags](https://longhorn.io/docs/1.4.4/volumes-and-nodes/storage-tags/)

- [Important Notes](https://longhorn.io/docs/1.4.4/deploy/important-notes/)

We also recommend you check out the [Examples](https://longhorn.io/docs/1.4.4/references/examples/) section of the
Longhorn documentation. The examples section contains several use cases of how to configure Longhorn.

</TabItem>

Expand Down Expand Up @@ -84,8 +94,18 @@ Longhorn provides these features:
- Backup to secondary storage (NFSv4 or S3-compatible object storage) built on change block detection.
- Recurring snapshot and backup.

For more information, check out Longhorn guide on
[How to Create Volumes](https://longhorn.io/docs/1.4.0/volumes-and-nodes/create-volumes/).
- [Access the Longhorn UI](https://longhorn.io/docs/latest/deploy/accessing-the-ui/#accessing-the-longhorn-ui)

- [Longhorn Networking](https://longhorn.io/docs/1.4.4/references/networking/)

- [Node Maintenance and Kubernetes Upgrade Guide](https://longhorn.io/docs/1.4.4/volumes-and-nodes/maintenance/)

- [Storage Tags](https://longhorn.io/docs/1.4.4/volumes-and-nodes/storage-tags/)

- [Important Notes](https://longhorn.io/docs/1.4.4/deploy/important-notes/)

We also recommend you check out the [Examples](https://longhorn.io/docs/1.4.4/references/examples/) section of the
Longhorn documentation. The examples section contains several use cases of how to configure Longhorn.

</TabItem>
</Tabs>
Expand Down
6 changes: 2 additions & 4 deletions docs/docs-content/integrations/portworx.md
Original file line number Diff line number Diff line change
Expand Up @@ -72,7 +72,7 @@ The default installation of Portworx will deploy the following components in the
- [Lighthouse](https://legacy-docs.portworx.com/enterprise/lighthouse-new)

- [Stork](https://github.com/libopenstorage/stork) and
[Stork on Portworx](https://docs.portworx.com/portworx-install-with-kubernetes/storage-operations/stork/)
[Stork on Portworx](https://docs.portworx.com/portworx-enterprise/platform/openshift/ocp-gcp/operations/storage-operations/stork.html)

- Storage class making use of portworx-volume provisioner.

Expand Down Expand Up @@ -527,8 +527,6 @@ manifests:
- [Portworx Install with Kubernetes](https://docs.portworx.com/portworx-install-with-kubernetes/)
- [Lighthouse](https://legacy-docs.portworx.com/enterprise/lighthouse-new.html)
- [Installation Prerequisites](https://docs.portworx.com/install-portworx/prerequisites/)
- [Install Portworx on AWS ASG using the DaemonSet](https://docs.portworx.com/install-portworx/cloud/aws/aws-asg/daemonset/)
- [Install Portworx on AWS ASG](https://docs.portworx.com/portworx-enterprise/install-portworx/kubernetes/aws/aws-asg)
8 changes: 4 additions & 4 deletions docs/docs-content/integrations/portworx_operator.md
Original file line number Diff line number Diff line change
Expand Up @@ -533,7 +533,7 @@ vsphereSecret:

To activate the Pure Flash Array integration, you will need to create a Kubernetes secret named `px-pure-secret` on your
cluster containing your
[Flash Array license JSON](https://docs.portworx.com/portworx-enterprise/cloud-references/auto-disk-provisioning/pure-flash-array.html#deploy-portworx).
[Flash Array license JSON](https://docs.portworx.com/portworx-enterprise/install-portworx/kubernetes/install-flasharray.html#create-a-json-configuration-file).
The secret must be created in the namespace that contains the `StorageCluster` resource. The namespace is `portworx` by
default.

Expand Down Expand Up @@ -1142,7 +1142,7 @@ vsphereSecret:

To activate the Pure Flash Array integration, you will need to create a Kubernetes secret named `px-pure-secret` on your
cluster containing your
[Flash Array license JSON](https://docs.portworx.com/portworx-enterprise/cloud-references/auto-disk-provisioning/pure-flash-array.html#deploy-portworx).
[Flash Array license JSON](https://docs.portworx.com/portworx-enterprise/install-portworx/kubernetes/install-flasharray.html#create-a-json-configuration-file).
The secret must be created in the namespace that contains the `StorageCluster` resource. The namespace is `kube-system`
by default.

Expand Down Expand Up @@ -1733,7 +1733,7 @@ vsphereSecret:

To activate the Pure Flash Array integration, you will need to create a Kubernetes secret named `px-pure-secret` on your
cluster containing your
[Flash Array license JSON](https://docs.portworx.com/portworx-enterprise/cloud-references/auto-disk-provisioning/pure-flash-array.html#deploy-portworx).
[Flash Array license JSON](https://docs.portworx.com/portworx-enterprise/install-portworx/kubernetes/install-flasharray.html#create-a-json-configuration-file).
The secret must be created in the namespace that contains the `StorageCluster` resource. The namespace is `kube-system`
by default.

Expand Down Expand Up @@ -1916,4 +1916,4 @@ data "spectrocloud_pack_simple" "portworx-operator" {

- [Portworx Central](https://docs.portworx.com/portworx-central-on-prem/install/px-central.html)

- [Flash Array License JSON](https://docs.portworx.com/portworx-enterprise/cloud-references/auto-disk-provisioning/pure-flash-array.html#deploy-portworx)
- [Flash Array License JSON](https://docs.portworx.com/portworx-enterprise/install-portworx/kubernetes/install-flasharray.html#create-a-json-configuration-file)
4 changes: 2 additions & 2 deletions docs/docs-content/integrations/prometheus-operator.md
Original file line number Diff line number Diff line change
Expand Up @@ -906,7 +906,7 @@ The Prometheus Operator pack installs the following dependencies:
## Parameters

The Prometheus operator supports all the parameters exposed by the kube-prometheus-stack Helm Chart. Refer to the
[kube-prometheus-stack](https://github.com/prometheus-community/helm-charts/tree/main/charts/kube-prometheus-stackn)
[kube-prometheus-stack](https://github.com/prometheus-community/helm-charts/tree/main/charts/kube-prometheus-stack)
documentation for details.

The Prometheus Operator pack has one parameter you must initialize `grafana.adminPassword`:
Expand Down Expand Up @@ -1055,7 +1055,7 @@ The Prometheus Operator pack installs the following dependencies:
## Parameters

The Prometheus operator supports all the parameters exposed by the kube-prometheus-stack Helm Chart. Refer to the
[kube-prometheus-stack](https://github.com/prometheus-community/helm-charts/tree/main/charts/kube-prometheus-stackn)
[kube-prometheus-stack](https://github.com/prometheus-community/helm-charts/tree/main/charts/kube-prometheus-stack)
documentation for details.

The Prometheus Operator pack has one parameter you must initialize `grafana.adminPassword`:
Expand Down

0 comments on commit 5938740

Please sign in to comment.