RHDHBUGS-2005 - Fixed broken links

.htmltest.yml

@@ -10,4 +10,10 @@ OutputDir: .cache/htmltest
 IgnoreDirectoryMissingTrailingSlash: true
 IgnoreSSLVerify: true
 IgnoreURLs: # List URLS that are not published, false positives, websites refusing crawlers
+  # Unauthorized (403)
+  - https://developers.redhat.com
+  - https://developers.redhat.com/articles/2025/03/17/10-tips-better-backstage-software-templates#
   - https://docs.github.com/
+  - https://entra.microsoft.com
+  - https://openai.com/api/
+  - https://platform.openai.com/docs/overview

artifacts/rhdh-plugins-reference/argocd/argocd-plugin-admin.adoc

@@ -32,7 +32,7 @@ annotations:
   ...
   # The label that Argo CD uses to fetch all the applications. The format to be used is label.key=label.value. For example, rht-gitops.com/janus-argocd=quarkus-app.
 
-  argocd/app-selector: '${ARGOCD_LABEL_SELECTOR}' 
+  argocd/app-selector: '${ARGOCD_LABEL_SELECTOR}'
 ----
 
 * (Optional) Add the following annotation to the entity’s `catalog-info.yaml` file to switch between Argo CD instances as shown in the following example:
@@ -44,7 +44,7 @@ annotations:
    ...
     # The Argo CD instance name used in `app-config.yaml`.
 
-    argocd/instance-name: '${ARGOCD_INSTANCE}' 
+    argocd/instance-name: '${ARGOCD_INSTANCE}'
 ----
 
 +
@@ -76,7 +76,7 @@ The optional Argo CD Rollouts feature enhances Kubernetes by providing advanced
 
 .Prerequisites
 
-* The Backstage Kubernetes plugin (`@backstage/plugin-kubernetes`) is installed and configured. 
+* The Backstage Kubernetes plugin (`@backstage/plugin-kubernetes`) is installed and configured.
 
 ** To install and configure Kubernetes plugin in Backstage, see link:https://backstage.io/docs/features/kubernetes/installation/[Installaltion] and link:https://backstage.io/docs/features/kubernetes/configuration/[Configuration] guide.
 
@@ -208,7 +208,7 @@ If using the label selector annotation (backstage.io/kubernetes-label-selector),
 
 . Open {Product} interface and navigate to the entity you configured.
 
-. Select the *CD* tab and then select the *GitOps application*. The side panel opens. 
+. Select the *CD* tab and then select the *GitOps application*. The side panel opens.
 
 . In the *Resources* table of the side panel, verify that the following resources are displayed:
 
@@ -226,6 +226,5 @@ If using the label selector annotation (backstage.io/kubernetes-label-selector),
 [role="_additional-resources"]
 .Additional resources
 
-* The package path, scope, and name of the {company-name} ArgoCD plugin has changed since 1.2. For more information, see link:{release-notes-book-url}#removed-functionality-rhidp-4293[Breaking Changes] in the _{release-notes-book-title}_.
 
-* For more information on installing dynamic plugins, see link:{installing-and-viewing-plugins-book-url}[{installing-and-viewing-plugins-book-title}].
+* link:{installing-and-viewing-plugins-book-link}[{installing-and-viewing-plugins-book-title}].

artifacts/rhdh-plugins-reference/argocd/argocd-plugin-readme.adoc

@@ -12,7 +12,7 @@ You can use the Argo CD plugin to visualize the Continuous Delivery (CD) workflo
 
 . Select the *Catalog* tab and choose the component that you want to use.
 
-. Select the *CD* tab to view insights into deployments managed by Argo CD. 
+. Select the *CD* tab to view insights into deployments managed by Argo CD.
 
 +
 image::rhdh-plugins-reference/argocd.png[CD tab Argo CD]
@@ -33,4 +33,4 @@ image::rhdh-plugins-reference/deployment_summary.png[Deployment summary]
 [role="_additional-resources"]
 .Additional resources
 
-* For more information on installing dynamic plugins, see link:{installing-and-viewing-plugins-book-url}[{installing-and-viewing-plugins-book-title}].
+* For more information on installing dynamic plugins, see link:{installing-and-viewing-plugins-book-link}[{installing-and-viewing-plugins-book-title}].

artifacts/rhdh-plugins-reference/argocd/argocd-plugin-user.adoc

@@ -10,7 +10,7 @@ You can use the Argo CD plugin to visualize the Continuous Delivery (CD) workflo
 
 . Select the *Catalog* tab and choose the component that you want to use.
 
-. Select the *CD* tab to view insights into deployments managed by Argo CD. 
+. Select the *CD* tab to view insights into deployments managed by Argo CD.
 
 +
 image::rhdh-plugins-reference/argocd.png[CD tab Argo CD]
@@ -31,4 +31,4 @@ image::rhdh-plugins-reference/deployment_summary.png[Deployment summary]
 [role="_additional-resources"]
 .Additional resources
 
-* For more information on installing dynamic plugins, see link:{installing-and-viewing-plugins-book-url}[{installing-and-viewing-plugins-book-title}].
+* link:{installing-and-viewing-plugins-book-link}[{installing-and-viewing-plugins-book-title}].

assemblies/assembly-configuring-techdocs.adoc

@@ -17,7 +17,7 @@
 [role="_additional-resources"]
 .Additional resources
 
-* For more information, see link:{configuring-dynamic-plugins-book-url}[{configuring-dynamic-plugins-book-title}].
+* {configuring-dynamic-plugins-book-link}[{configuring-dynamic-plugins-book-title}].
 
 //configuring storage
 include::modules/customizing-techdocs/con-techdocs-configure-storage.adoc[leveloffset=+1]

assemblies/assembly-configuring-templates.adoc

@@ -20,7 +20,7 @@
 
 [role="_additional-resources"]
 .Additional resources
-* link:{authentication-book-url}#assembly-auth-provider-github[Enabling the GitHub authentication provider]
+* {authentication-book-link}#assembly-auth-provider-github[Enabling the GitHub authentication provider]
 * link:https://backstage.io/docs/features/software-templates/writing-templates[Backstage documentation - Writing Templates]
 * link:https://backstage.io/docs/features/software-templates/builtin-actions[Backstage documentation - Builtin actions]
 * link:https://backstage.io/docs/features/software-templates/writing-custom-actions[Backstage documentation - Writing Custom Actions]

assemblies/assembly-customizing-the-tech-radar-page.adoc

@@ -1,7 +1,7 @@
 [id='proc-customizing-the-tech-radar-page_{context}']
 = Customizing the Tech Radar page in {product}
 
-In {product}, the Tech Radar page is provided by the `tech-radar` dynamic plugin, which is disabled by default. For information about enabling dynamic plugins in {product} see link:{configuring-dynamic-plugins-book-url}[{configuring-dynamic-plugins-book-title}].
+In {product}, the Tech Radar page is provided by the `tech-radar` dynamic plugin, which is disabled by default. For information about enabling dynamic plugins in {product} see {configuring-dynamic-plugins-book-link}[{configuring-dynamic-plugins-book-title}].
 
 In {product}, you can configure Learning Paths by passing the data into the `{my-app-config-file}` file as a proxy. The base Tech Radar URL must include the `/developer-hub/tech-radar` proxy.
 

assemblies/assembly-disabling-telemetry-data-collection.adoc

@@ -4,8 +4,8 @@
 
 To disable telemetry data collection, you must disable the `analytics-provider-segment` plugin either using the Helm Chart or the {product} Operator configuration.
 
-As an administrator, you can disable the telemetry data collection feature based on your needs. For example, in an air-gapped environment, you can disable this feature to avoid needless outbound requests affecting the responsiveness of the {product-very-short} application. For more details, see the link:{telemetry-data-collection-book-url}#proc-disabling-telemetry-using-operator_title-telemetry[Disabling telemetry data collection in {product-very-short}] section.
+As an administrator, you can disable the telemetry data collection feature based on your needs. For example, in an air-gapped environment, you can disable this feature to avoid needless outbound requests affecting the responsiveness of the {product-very-short} application.
 
 include::modules/analytics/proc-disabling-telemetry-using-operator.adoc[leveloffset=+1]
 
-include::modules/analytics/proc-disabling-telemetry-using-helm.adoc[leveloffset=+1]
+include::modules/analytics/proc-disabling-telemetry-using-helm.adoc[leveloffset=+1]

assemblies/assembly-install-rhdh-airgapped-environment-k8s-helm.adoc

@@ -9,9 +9,9 @@
 
 [role="_additional-resources"]
 .Additional resources
-* link:https://docs.redhat.com/en/documentation/red_hat_developer_hub/1.5/html/installing_red_hat_developer_hub_on_microsoft_azure_kubernetes_service/proc-rhdh-deploy-aks-helm_title-install-rhdh-aks[Deploying {product-short} on {aks-short} with the Helm chart].
-* link:https://docs.redhat.com/en/documentation/red_hat_developer_hub/1.5/html/installing_red_hat_developer_hub_on_amazon_elastic_kubernetes_service/proc-rhdh-deploy-eks-helm_title-install-rhdh-eksp[Installing {product-short} on {eks-short} with the Helm chart],
-* link:https://docs.redhat.com/en/documentation/red_hat_developer_hub/1.5/html/installing_red_hat_developer_hub_on_google_kubernetes_engine/proc-rhdh-deploy-gke-helm_title-install-rhdh-gke[Installing {product-short} on {gke-short} with the Helm chart].
+* {installing-on-aks-book-link}#proc-rhdh-deploy-aks-helm_title-install-rhdh-aks[Deploying {product-short} on {aks-short} with the Helm chart].
+* {installing-on-eks-book-link}#proc-rhdh-deploy-eks-helm_title-install-rhdh-eks[Installing {product-short} on {eks-short} with the Helm chart],
+* {installing-on-gke-book-link}#proc-rhdh-deploy-gke-helm_title-install-rhdh-gke[Installing {product-short} on {gke-short} with the Helm chart].
 
 include::modules/installation/proc-install-rhdh-airgapped-full-k8s-helm.adoc[leveloffset=+1]
 

assemblies/assembly-techdocs-addons-installing.adoc

@@ -14,5 +14,5 @@
 include::modules/techdocs/proc-techdocs-addon-install-third-party.adoc[]
 
 .Additional resources
-* link:https://docs.redhat.com/en/documentation/red_hat_developer_hub/1.4/html/installing_and_viewing_plugins_in_red_hat_developer_hub/rhdh-installing-rhdh-plugins_title-plugins-rhdh-about[Installing dynamic plugins in Red Hat Developer Hub]
-* link:https://docs.redhat.com/en/documentation/red_hat_developer_hub/1.4/html/installing_and_viewing_plugins_in_red_hat_developer_hub/assembly-third-party-plugins[Third-party plugins in Red Hat Developer Hub]
+* {configuring-dynamic-plugins-book-link}[{configuring-dynamic-plugins-book-title}]
+* {installing-and-viewing-plugins-book-link}[{installing-and-viewing-plugins-book-title}]

assemblies/dynamic-plugins/assembly-rhdh-installing-dynamic-plugins.adoc

@@ -15,9 +15,9 @@ include::../modules/dynamic-plugins/ref-rh-supported-plugins.adoc[leveloffset=+3
 
 [NOTE]
 ====
-* For more information about configuring KeyCloak, see link:{configuring-dynamic-plugins-book-url}[{configuring-dynamic-plugins-book-title}].
+* For more information about configuring KeyCloak, see {configuring-dynamic-plugins-book-link}[{configuring-dynamic-plugins-book-title}].
 
-* For more information about configuring TechDocs, see link:{customizing-book-url}#configuring-techdocs[Configuring TechDocs].
+* For more information about configuring TechDocs, see {customizing-book-link}#configuring-techdocs[Configuring TechDocs].
 ====
 
 // Technology preview support statement
@@ -29,7 +29,7 @@ include::../modules/dynamic-plugins/ref-rh-tech-preview-plugins.adoc[leveloffset
 
 //[NOTE]
 //====
-//* A new Technology Preview plugin for Red Hat Ansible Automation Platform (RHAAP) is available, which replaces this older one. See link:{configuring-dynamic-plugins-book-url}#rhdh-compatible-plugins[Other installable plugins] in _{configuring-dynamic-plugins-book-title}_ for further details. See xref:rhdh-compatible-plugins[Dynamic plugins support matrix].
+//* A new Technology Preview plugin for Red Hat Ansible Automation Platform (RHAAP) is available, which replaces this older one. See {configuring-dynamic-plugins-book-link}#rhdh-compatible-plugins[Other installable plugins] in _{configuring-dynamic-plugins-book-title}_ for further details. See xref:rhdh-compatible-plugins[Dynamic plugins support matrix].
 //====
 
 // Community plugins

modules/about/con_understanding-internal-developer-platforms.adoc

@@ -62,9 +62,9 @@ Support growing teams and applications while maintaining access to the same tool
 [role="_additional-resources"]
 .Additional resources
 
-* link:https://docs.redhat.com/documentation/red_hat_developer_hub/{product-version}/html/customizing_red_hat_developer_hub/configuring-templates[Configuring templates]
-* link:https://docs.redhat.com/documentation/red_hat_developer_hub/{product-version}/html/techdocs_for_red_hat_developer_hub/index[TechDocs for {product}]
-* link:https://docs.redhat.com/documentation/red_hat_developer_hub/{product-version}/html-single/customizing_red_hat_developer_hub/index#proc-customize-rhdh-learning-paths_configuring-templates[Customizing the Learning Paths in {product}]
-* link:https://docs.redhat.com/documentation/red_hat_developer_hub/{product-version}/html/introduction_to_plugins/index[Introduction to plugins]
+* {customizing-book-link}#configuring-templates[Configuring templates]
+* {techdocs-book-link}[{techdocs-book-title}]
+* {customizing-book-link}#proc-customize-rhdh-learning-paths_configuring-templates[Customizing the Learning Paths in {product}]
+* {introduction-to-plugins-book-link}[{introduction-to-plugins-book-title}]
 * xref:integrations-in-rhdh_{context}[Integrations in {product}]
-* link:https://docs.redhat.com/documentation/red_hat_developer_hub/{product-version}/html/authorization_in_red_hat_developer_hub/index[Authorization in {product}]
+* {authentication-book-link}[{authentication-book-title}]

modules/authentication/con-understanding-authentication-and-user-provisioning.adoc

@@ -1,8 +1,9 @@
+:_mod-docs-content-type: CONCEPT
 = Understanding authentication and user provisioning
 
 This module provides an overview of how authentication and user provisioning function within {product}.
 Learn about the process from creating user and group entities in the software catalog to user sign-in, and how authentication and catalog plugins enable each step.
-Understanding this process is essential for successfully link:{configuring-book-url}[configuring your {product-short} instance], link:{authorization-book-url}[securing access through authorization], and enabling features that rely on synchronized user and group data.
+Understanding this process is essential for successfully {configuring-book-link}[configuring your {product-short} instance], {authorization-book-link}[securing access through authorization], and enabling features that rely on synchronized user and group data.
 
 To fully enable catalog features, provision user and group data from the Identity Provider to the {product-short} software catalog.
 Catalog provider plugins handle this task asynchronously.

modules/authentication/proc-authenticationg-with-the-guest-user-on-a-helm-based-installation.adoc

@@ -5,11 +5,11 @@
 On a Helm-based installation, you can configure {product-short} to log in as a Guest user and access {product-short} features.
 
 .Prerequisites
-* You link:{configuring-book-url}[added a custom {product-short} application configuration], and have sufficient permissions to modify it.
-* You link:{configuring-book-url}#using-the-helm-chart-to-run-rhdh-with-your-custom-configuration[use the {product} Helm chart to run  {product-short}].
+* You {configuring-book-link}[added a custom {product-short} application configuration], and have sufficient permissions to modify it.
+* You {configuring-book-link}#using-the-helm-chart-to-run-rhdh-with-your-custom-configuration[use the {product} Helm chart to run  {product-short}].
 
 .Procedure
-* To enable the guest user in your {product-short} custom configuration, link:{configuring-book-url}#using-the-helm-chart-to-run-rhdh-with-your-custom-configuration[configure your {product} Helm Chart] with following content:
+* To enable the guest user in your {product-short} custom configuration, {configuring-book-link}#using-the-helm-chart-to-run-rhdh-with-your-custom-configuration[configure your {product} Helm Chart] with following content:
 +
 .{product} Helm Chart configuration fragment
 [source,yaml]

modules/authentication/proc-authenticationg-with-the-guest-user-on-an-operator-based-installation.adoc

@@ -5,11 +5,11 @@
 After an Operator-based installation, you can configure {product-short} to log in as a Guest user and access {product-short} features.
 
 .Prerequisites
-* You link:[installed {product-short} by using the Operator].
-* You link:{configuring-book-url}[added a custom {product-short} application configuration], and have sufficient permissions to modify it.
+* You {configuring-book-link}[added a custom {product-short} application configuration], and have sufficient permissions to modify it.
+* You {configuring-book-link}#using-the-operator-to-run-rhdh-with-your-custom-configurationn[use the {product} Operator to run  {product-short}].
 
 .Procedure
-* To enable the guest user in your {product-short} custom configuration, link:{configuring-book-url}#provisioning-your-custom-configuration[edit your {product-short} application configuration] with following content:
+* To enable the guest user in your {product-short} custom configuration, {configuring-book-link}#provisioning-your-custom-configuration[edit your {product-short} application configuration] with following content:
 +
 .`{my-app-config-file}` fragment
 [source,yaml]

modules/authentication/proc-creating-a-custom-transformer-to-provision-users-from-rhbk-to-the-software-catalog.adoc

@@ -1,3 +1,4 @@
+:_mod-docs-content-type: PROCEDURE
 [id="creating-a-custom-transformer-to-provision-users-from-rhbk-to-the-software-catalog"]
 = Creating a custom transformer to provision users from {rhbk-brand-name} ({rhbk}) to the software catalog
 

modules/authentication/proc-enabling-user-authentication-with-github.adoc

@@ -1,10 +1,11 @@
+:_mod-docs-content-type: PROCEDURE
 [id="enabling-user-authentication-with-github"]
 = Enabling user authentication with GitHub
 
 To authenticate users with GitHub, configure the GitHub authentication provider in {product} and provision the users and groups from GitHub to the {product-short} software catalog.
 
 .Prerequisites
-* You link:{configuring-book-url}[added a custom {product-short} application configuration], and have sufficient permissions to modify it.
+* You {configuring-book-link}[added a custom {product-short} application configuration], and have sufficient permissions to modify it.
 
 * You have sufficient permissions in GitHub to create and manage a link:https://docs.github.com/en/apps/overview[GitHub App].
 Alternatively, you can ask your GitHub administrator to prepare the required GitHub App.
@@ -42,7 +43,7 @@ Select `Only on this account`.
 * **Client ID**
 * **Client secret**
 
-. To add your GitHub credentials to {product-short}, add the following key/value pairs to link:{configuring-dynamic-plugins-book-url}#provisioning-your-custom-configuration[your {product-short} secrets].
+. To add your GitHub credentials to {product-short}, add the following key/value pairs to {configuring-book-link}#provisioning-your-custom-configuration[your {product-short} secrets].
 You can use these secrets in the {product-short} configuration files by using their respective environment variable name.
 
 `AUTHENTICATION_GITHUB_CLIENT_ID`::
@@ -209,5 +210,5 @@ WARNING: Use `dangerouslyAllowSignInWithoutUserInCatalog` to explore {product-sh
 
 .Additional resources
 
-* link:{integrating-with-github-book-url}[{integrating-with-github-book-title}].
+* {integrating-with-github-book-link}[{integrating-with-github-book-title}].