RHIDP-9751 - fixed broken links (#1570)

Co-authored-by: Nick Boldt <nboldt@redhat.com>

Author: themr0c

.htmltest.yml

@@ -3,17 +3,21 @@
 # Defines htmltest configuration
 # See: https://github.com/wjdp/htmltest
 #
-DirectoryPath: titles-generated/main
+DirectoryPath: titles-generated
 CheckDoctype: false
-ExternalTimeout: 30
+ExternalTimeout: 60
 OutputDir: .cache/htmltest
 IgnoreDirectoryMissingTrailingSlash: true
 IgnoreSSLVerify: true
 IgnoreURLs: # List URLS that are not published, false positives, websites refusing crawlers
   # Unauthorized (403)
-  - https://docs.redhat.com/en/documentation/red_hat_developer_hub
+  - "^./pr-.*/index.html$"
+  - "^index.html$"
   - https://developers.redhat.com
   - https://docs.github.com/
+  - https://docs.redhat.com/en/documentation/red_hat_developer_hub/1.9
   - https://entra.microsoft.com
+  - https://npm.registry.redhat.com
+  - https://npmjs.com/package/
   - https://openai.com/api/
   - https://platform.openai.com/docs/overview

.linkcheckerrc

@@ -5,9 +5,12 @@
 checkextern=True
 ignore=
   brand.css
-  lang.css
   http://creativecommons.org/licenses/by-sa/3.0/
-  https://access.redhat.com/downloads/content/480/
+  https://access.redhat.com/downloads/
+  https://docs.redhat.com/en/documentation/red_hat_developer_hub/1.9
+  https://npmjs.com/package/
+  https://www.youtube.com/@redhat
+  lang.css
 
 [output]
 fileoutput=html,csv

artifacts/attributes.adoc

@@ -41,6 +41,8 @@
 :my-product-namespace: my-rhdh-project
 :my-product-secrets: my-rhdh-secrets
 :my-product-url: https://__<my_developer_hub_domain>__
+:plugin-type-name-uppercase: Custom
+:plugin-type-name: custom
 
 // Red Hat Platforms (in alphabetical order)
 :logging-brand-name: Red Hat OpenShift Logging
@@ -60,6 +62,9 @@
 :rhacs-very-short: ACS
 :rhads-brand-name: Red Hat Advanced Developer Suite - secure supply chain
 :rhads-very-short: RHADS - ssc
+:rhcr: Red Hat Container Registry
+:rhcr-long: {rhcr} (registry.redhat.io)
+:rhec: Red Hat Ecosystem Catalog
 :rhbk-brand-name: Red Hat Build of Keycloak
 :rhbk: RHBK
 :rhdeveloper-name: Red Hat Developer
@@ -91,6 +96,8 @@
 :gcp-short: Google Cloud
 :gke-brand-name: Google Kubernetes Engine
 :gke-short: GKE
+:openshift-ai-connector-name-short: OpenShift AI Connector for {product-very-short}
+:openshift-ai-connector-name: OpenShift AI Connector for {product}
 
 // First mention of OpenShift CLI or `oc` in a module
 :openshift-cli: pass:quotes[OpenShift CLI (`oc`)]
@@ -138,7 +145,7 @@
 :installing-on-gke-book-title: Installing {product} on {gke-brand-name}
 :installing-on-ocp-book-link: {product-docs-link}/html-single/installing_red_hat_developer_hub_on_openshift_container_platform/index
 :installing-on-ocp-book-title: Installing {product} on {ocp-short}
-:installing-on-osd-on-gcp-book-link: {product-docs-link}/html-single/installing_red_hat_developer_hub_on_openshift_dedicated_on_google_cloud_platform/index
+:installing-on-osd-on-gcp-book-link: {product-docs-link}/html-single/installing_red_hat_developer_hub_on_openshift_dedicated_on_google_cloud/index
 :installing-on-osd-on-gcp-book-title: Installing {product} on {gcp-brand-name} on {gcp-brand-name}
 :installing-rhdh-orch-on-ocp-book-link: {product-docs-link}/html-single/installing_rhdh_with_orchestrator_plugin_on_{ocp-short}_using_operator_in_an_air-gapped_environment/index
 :installing-rhdh-orch-on-ocp-book-title: Installing RHDH with the Orchestrator Plugin on {ocp-short} using the {product} Operator
@@ -147,19 +154,25 @@
 :introduction-to-plugins-book-link: {product-docs-link}/html-single/introduction_to_plugins/index
 :introduction-to-plugins-book-title: Introduction to plugins
 :learning-path-data-json-link: link:https://raw.githubusercontent.com/redhat-developer/rhdh/release-{product-version}/packages/app/public/learning-paths/data.json
+:model-context-protocol-link: {product-docs-link}/html-single/interacting_with_model_context_protocol_tools_for_red_hat_developer_hub/index
+:model-context-protocol-title: Interacting with Model Context Protocol tools for {product}
 :monitoring-and-logging-book-link: {product-docs-link}/html-single/monitoring_and_logging/index
 :monitoring-and-logging-book-title: Monitoring and logging
 :observability-category-link: {product-docs-link}/#Observability
 :ocp-docs-link: link:https://docs.redhat.com/en/documentation/openshift_container_platform/{ocp-version}
 :odf-docs-link: link:https://docs.redhat.com/en/documentation/red_hat_openshift_data_foundation/{ocp-version}
+:openshift-ai-connector-for-rhdh-link: {product-docs-link}/html-single/accelerate_ai_development_with_openshift_ai_connector_for_red_hat_developer_hub/index
 :orchestrator-book-link: {product-docs-link}/html-single/orchestrator_in_red_hat_developer_hub/index
 :orchestrator-book-title: Orchestrator in {product}
 :osd-docs-link: link:https://docs.redhat.com/en/documentation/openshift_dedicated/{osd-version}
 :release-notes-book-link: {product-docs-link}/html-single/red_hat_developer_hub_release_notes/index
 :release-notes-book-title: {product} release notes
 :release-notes-category-link: {product-docs-link}/#Release Notes
 :rhbk-docs-link: link:https://docs.redhat.com/en/documentation/red_hat_build_of_keycloak/{keycloak-version}
+:rhoai-docs-link: link:https://docs.redhat.com/en/documentation/red_hat_openshift_ai_self-managed/2.25/html-single
 :rhoserverless-link: link:https://docs.redhat.com/en/documentation/red_hat_openshift_serverless/{rhoserverless-version}
+:scorecard-plugin-book-link: {product-docs-link}/html-single/understand_and_visualize_red_hat_developer_hub_project_health_using_scorecards/index
+:scorecard-plugin-book-title: Understand and visualize {product} project health using Scorecards
 :techdocs-book-link: {product-docs-link}/html-single/techdocs_for_red_hat_developer_hub/index
 :techdocs-book-title: TechDocs for {product}
 :telemetry-data-collection-book-link: {product-docs-link}/html-single/telemetry_data_collection_and_analysis/index
@@ -169,19 +182,3 @@
 :upgrading-book-title: Upgrading {product}
 :using-dynamic-plugins-book-link: {product-docs-link}/html-single/installing_and_viewing_plugins_in_red_hat_developer_hub/index
 :using-dynamic-plugins-book-title: Using dynamic plugins
-:plugin-type-name: custom
-:plugin-type-name-uppercase: Custom
-
-
-:scorecard-plugin-book-link: {product-docs-link}/html-single/understand_and_visualize_red_hat_developer_hub_project_health_using_scorecards/index
-:scorecard-plugin-book-title: Understand and visualize {product} project health using Scorecards
-
-:model-context-protocol-link: {product-docs-link}/html-single/interacting_with_model_context_protocol_tools_for_red_hat_developer_hub/index
-:model-context-protocol-title: Interacting with Model Context Protocol tools for {product}
-
-:openshift-ai-connector-for-rhdh-link: {product-docs-link}/html-single/accelerate_ai_development_with_openshift_ai_connector_for_red_hat_developer_hub/index
-
-:openshift-ai-connector-name: OpenShift AI Connector for {product}
-:openshift-ai-connector-name-short: OpenShift AI Connector for {product-very-short}
-
-:rhoai-docs-link: link:https://docs.redhat.com/en/documentation/red_hat_openshift_ai_self-managed/2.25/html-single

artifacts/snip-rhdh-install-operator-next-steps.adoc

@@ -2,8 +2,8 @@
 
 .Next steps
 * Use the Operator to create a {product} instance on a supported platform. For more information, see the following documentation for the platform that you want to use:
-** link:https://docs.redhat.com/en/documentation/red_hat_developer_hub/1.4/html/installing_red_hat_developer_hub_on_openshift_container_platform/assembly-install-rhdh-ocp-operator[Installing {product} on {ocp-short} with the Operator]
-** link:https://docs.redhat.com/en/documentation/red_hat_developer_hub/1.4/html/installing_red_hat_developer_hub_on_amazon_elastic_kubernetes_service/proc-rhdh-deploy-eks-operator_title-install-rhdh-eks[Installing {product-short} on {eks-short} with the Operator]
-** link:https://docs.redhat.com/en/documentation/red_hat_developer_hub/1.4/html/installing_red_hat_developer_hub_on_microsoft_azure_kubernetes_service/proc-rhdh-deploy-aks-operator_title-install-rhdh-aks[Installing {product-short} on {aks-short} with the Operator]
-** link:https://docs.redhat.com/en/documentation/red_hat_developer_hub/1.4/html/installing_red_hat_developer_hub_on_openshift_dedicated_on_google_cloud_platform/proc-install-rhdh-osd-gcp-operator_title-install-rhdh-osd-gcp[Installing {product-short} on {gcp-short} with the Operator]
-** link:https://docs.redhat.com/en/documentation/red_hat_developer_hub/1.4/html/installing_red_hat_developer_hub_on_google_kubernetes_engine/proc-rhdh-deploy-gke-operator.adoc_title-install-rhdh-gke#proc-deploy-rhdh-instance-gke.adoc_title-install-rhdh-gke[Deploying {product-short} on {gke-short} with the Operator]
+** {installing-on-ocp-book-link}#proc-install-rhdh-ocp-operator_assembly-install-rhdh-ocp-operator[Installing {product} on {ocp-short} with the Operator]
+** {installing-on-eks-book-link}#assembly-installing-rhdh-on-eks-by-using-the-operator[{installing-on-eks-book-title} with the Operator]
+** {installing-on-aks-book-link}#assembly-installing-rhdh-on-aks-by-using-the-operator[{installing-on-aks-book-title} with the Operator]
+** {installing-on-osd-on-gcp-book-link}#proc-install-rhdh-osd-gcp-operator_title-install-rhdh-osd-gcp[{installing-on-osd-on-gcp-book-title} with the Operator]
+** {installing-on-gke-book-link}#assembly-installing-rhdh-on-gke-by-using-the-operator[{installing-on-gke-book-title} with the Operator]

assemblies/assembly-installing-rhdh-on-platform-by-using-the-operator.adoc

@@ -3,12 +3,12 @@
 [id="assembly-installing-rhdh-on-{platform-id}-by-using-the-operator"]
 = Installing {product-short} on {platform-long} by using the Operator
 
-To benefit from over-the-air updates and catalogs provided by Operator-based applications distributed with the Operator Lifecycle Manager (OLM) framework, consider installing {product} by using the {product} Operator distributed in the {company-name} Ecosystem.
+To benefit from over-the-air updates and catalogs provided by Operator-based applications distributed with the Operator Lifecycle Manager (OLM) framework, consider installing {product} by using the {product} Operator distributed in the {rhcr}.
 
 On {platform}, the most notable differences over an OpenShift-based installation are:
 
-* The OLM framework and the {company-name} Ecosystem are not built-in.
-* The {company-name} Ecosystem pull-secret is not managed globally.
+* The OLM framework and the {rhcr} are not built-in.
+* The {rhcr} pull-secret is not managed globally.
 * To expose the application, Ingresses replace OpenShift Routes.
 
 For clarity, the content is broken down in sections highlighting these platform-specific additional steps.

build/scripts/build-ccutil.sh

@@ -70,3 +70,6 @@ else
       echo "<li><a href=./${BRANCH}/index.html>${BRANCH}</a></li>" >> titles-generated/index.html
   fi
 fi
+
+# Test the links with htmltest
+podman run --rm --tty --volume "$(pwd)":/test:Z docker.io/wjdp/htmltest:latest -c .htmltest.yml

modules/authentication/snip-enabling-user-authentication-with-microsoft-azure-common-first-steps.adoc

@@ -22,7 +22,7 @@ The server for retrieving organization data, including user and group data, to i
 
 .Procedure
 :my-product-app-name-in-azure: <Authenticating with {product-short}>
-. Register your {product-short} app in {azure-short}, link:https://learn.microsoft.com/en-us/entra/identity-platform/scenario-web-app-sign-user-app-registration?tabs=aspnetcore#register-an-app-by-using-the-azure-portal[by using the {azure-short} portal].
+. Register your {product-short} app in {azure-short}, link:https://learn.microsoft.com/en-us/entra/identity-platform/scenario-web-app-sign-user-app-configuration?tabs=aspnetcore#register-an-app-by-using-the-azure-portal[by using the {azure-short} portal].
 
 .. Sign in to the link:https://entra.microsoft.com/[Microsoft Entra admin center].
 

modules/configuring-external-databases/con-default-base-urls.adoc

@@ -9,9 +9,9 @@ The Operator follows these rules to set the base URLs for your application:
 
 * If the cluster is not OpenShift, the Operator makes no changes.
 * If you explicitly set the `spec.application.route.enabled` field in your Custom Resource (CR) to `false`, no changes are made.
-* If you define `spec.application.route.host` in the {product-custom-resource-type} CR, the base URLs are set to `https://<spec.application.route.host>`.
-* If you specify the `spec.application.route.subdomain` in the {product-custom-resource-type} CR, the base URLs are set to `https://<spec.application.route.subdomain>.<cluster_ingress_domain>`.
-* If no custom host or subdomain is provided, the Operator sets the base URLs to `https://backstage-{cr_name}-<namespace>.<cluster_ingress_domain>`, which is the default domain for the created _Route_ resource.
+* If you define `spec.application.route.host` in the {product-custom-resource-type} CR, the base URLs are set to `pass:c,a,q[https://<spec.application.route.host>]`.
+* If you specify the `spec.application.route.subdomain` in the {product-custom-resource-type} CR, the base URLs are set to `pass:c,a,q[https://<spec.application.route.subdomain>.<cluster_ingress_domain>]`.
+* If no custom host or subdomain is provided, the Operator sets the base URLs to `pass:c,a,q[https://backstage-<cr_name>-<namespace>.<cluster_ingress_domain>]`, which is the default domain for the created _Route_ resource.
 
 The Operator updates the following base URLs in the default `app-config` ConfigMap:
 

modules/configuring/snip-provisioning-your-custom-configuration-appconfig-step-with-optional-steps-disabled.adoc

@@ -51,4 +51,4 @@ Enter your repository discovery configuration.
 `permissions`:: Enable Role-based access control.
 Enter your policy administrator name.
 
-.. Additionally, link:{authentication-book-url}[provision users and enable authentication with your external identity provider].
+.. Additionally, {authentication-book-link}[provision users and enable authentication with your external identity provider].

modules/dynamic-plugins/proc-configuring-events-module-for-github.adoc

@@ -54,7 +54,7 @@ Secure your workflow by adding a webhook secret token to link:https://docs.githu
 ** *For Github Discovery Events*: push, repository
 ** *For Github Organizational Data Events*: organization, team and membership
 ** *Content Type*: application/json
-** *Payload URL*: https://<your_instance_name>/api/events/http/github
+** *Payload URL*: pass:c,a,q[`{my-product-url}/api/events/http/github`]
 +
 [NOTE]
 ====