RHDHBUGS-2005 - Fixed broken links

[themr0c]

RHDHBUGS-2005 - Fixed 39 broken links found by linkchecker

$  linkchecker --check-extern --output failures --file-output failures/broken-links.txt https://docs.redhat.com/en/documentation/red_hat_developer_hub/1.7

• Also fixed the erroneous usage of docs.redhat.com directly without using attributes.
• Changed the attributes to make them compatible with the Dita migration tool.
• Generalized the use of attributes.
• Fixed links pointing to obsolete product versions (of RHDH, OCP, ODF etc...
• Fixed links pointing to obsolete paths and generating redirections.
• Partially updated links in Additional resource for AEM migration.

To test locally, install htmltest and linkchecker and run

 ./build/scripts/build-ccutil.sh && (htmltest ; linkchecker -f .linkcheckerrc titles-generated/main/)

This is the broken link list:

Format: number of occurences "('page containing the broken link', 'broken link')"

• 1 "('https://docs.redhat.com/en/documentation/red_hat_developer_hub/1.7/html/telemetry_data_collection_and_analysis/disabling-telemetry-data-collection_title-telemetry#proc-disabling-telemetry-using-operator_title-telemetry', 'https://docs.redhat.com/en/documentation/red_hat_developer_hub/1.7/html-single/telemetry_data_collection/index#proc-disabling-telemetry-using-operator_title-telemetry')"
• 2 "('https://docs.redhat.com/en/documentation/red_hat_developer_hub/1.7/html/telemetry_data_collection_and_analysis/customizing-segment-source_title-telemetry', 'https://docs.redhat.com/en/documentation/red_hat_developer_hub/1.7/html-single/telemetry_data_collection/index')"
• 1 "('https://docs.redhat.com/en/documentation/red_hat_developer_hub/1.7/html/installing_red_hat_developer_hub_on_openshift_container_platform/pr01', 'https://rhdh.example.com')"
• 1 "('https://docs.redhat.com/en/documentation/red_hat_developer_hub/1.7/html/installing_red_hat_developer_hub_on_microsoft_azure_kubernetes_service/proc-rhdh-deploy-aks-operator_title-install-rhdh-aks', 'https://%3Capp_address%3E')"
• 1 "('https://docs.redhat.com/en/documentation/red_hat_developer_hub/1.7/html/installing_red_hat_developer_hub_on_google_kubernetes_engine/proc-rhdh-deploy-gke-operator.adoc_title-install-rhdh-gke', 'https://%3Crhdh_domain_name%3E')"
• 1 "('https://docs.redhat.com/en/documentation/red_hat_developer_hub/1.7/html/installing_red_hat_developer_hub_in_an_air-gapped_environment/assembly-install-rhdh-airgapped-environment-k8s-helm_title-install-rhdh-air-grapped', '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')"
• 1 "('https://docs.redhat.com/en/documentation/red_hat_developer_hub/1.7/html/installing_red_hat_developer_hub_in_an_air-gapped_environment/assembly-install-rhdh-airgapped-environment-ocp-helm_title-install-rhdh-air-grapped', 'file://.user')"
• 1 "('https://docs.redhat.com/en/documentation/red_hat_developer_hub/1.7/html/configuring_red_hat_developer_hub/enabling-the-rhdh-plugin-assets-cache_running-behind-a-proxy', 'https://www.redis.io/docs/latest/')"
• 1 "('https://docs.redhat.com/en/documentation/red_hat_developer_hub/1.7/html/installing_red_hat_developer_hub_on_microsoft_azure_kubernetes_service/proc-rhdh-deploy-aks-operator_title-install-rhdh-aks', 'https://108.141.70.228')"
• 1 "('https://docs.redhat.com/en/documentation/red_hat_developer_hub/1.7/html/customizing_red_hat_developer_hub/proc-customizing-the-tech-radar-page_customizing-the-quickstarts#proc-customizing-rhdh-tech-radar-page-by-using-a-customization-service_customizing-the-quickstarts', 'https://raw.githubusercontent.com/redhat-developer/rhdh/release-1.7/packages/app/public/tech-radar/data-default.json')" -- NOTE: The tech-radar default JSON is definitively absent from https://github.com/redhat-developer/rhdh/tree/release-1.7/packages/app/public, where did it move?
• 1 "('https://docs.redhat.com/en/documentation/red_hat_developer_hub/1.7/html/integrating_red_hat_developer_hub_with_github/bulk-importing-github-repositories#enabling-and-giving-access-to-the-bulk-import-feature', 'https://docs.redhat.com/en/documentation/red_hat_developer_hub/1.7/html/integrating_red_hat_developer_hub_with_github/%7Blinkgettingstartedguide%7D#assembly-audit-log')"
• 1 "('https://docs.redhat.com/en/documentation/red_hat_developer_hub/1.7/html/integrating_red_hat_developer_hub_with_github/bulk-importing-github-repositories#enabling-and-giving-access-to-the-bulk-import-feature', 'https://docs.redhat.com/en/documentation/red_hat_developer_hub/1.7/html/integrating_red_hat_developer_hub_with_github/%7Blinkgettingstartedguide%7D#enabling-github-discovery-in-red-hat-developer-hub')"
• 1 "('https://docs.redhat.com/en/documentation/red_hat_developer_hub/1.7/html/authorization_in_red_hat_developer_hub/configuring-guest-access-with-rbac-ui_title-authorization', 'https://docs.redhat.com/en/documentation/red_hat_developer_hub/1.7/html/authorization_in_red_hat_developer_hub/%7Bplugins-configure-book-url%7D')"
• 1 "('https://docs.redhat.com/en/documentation/red_hat_developer_hub/1.7/html/interacting_with_red_hat_developer_lightspeed_for_red_hat_developer_hub/developer-lightspeed', 'https://openai.com/api/')" -- NOTE: False positive: this URL works.
• 1 "('https://docs.redhat.com/en/documentation/red_hat_developer_hub/1.7/html/configuring_dynamic_plugins/install-topology-plugin_title-plugins-rhdh-configure#installation-4', 'https://api.foo.redhat.com:6443')"
• 1 "('https://docs.redhat.com/en/documentation/red_hat_developer_hub/1.7/html/configuring_dynamic_plugins/install-topology-plugin_title-plugins-rhdh-configure#installation-4', 'https://docs.redhat.com/en/documentation/red_hat_developer_hub/1.7/html/configuring_dynamic_plugins/%7Bcustomizing-book-url#configuring-templates%7D')"
• 1 "('https://docs.redhat.com/en/documentation/red_hat_developer_hub/1.7/html/telemetry_data_collection_and_analysis/disabling-telemetry-data-collection_title-telemetry', 'https://docs.redhat.com/en/documentation/red_hat_developer_hub/1.7/html-single/telemetry_data_collection/index#proc-disabling-telemetry-using-operator_title-telemetry')"
• Fix links pointing to obsolete product versions (of RHDH, OCP, ODF etc...
• Fix links pointing to obsolete paths and generating redirections.
• Generalize the use of attributes.

These broken links are in older versions and not handled by this PR:

• 1 "('https://docs.redhat.com/en/documentation/red_hat_developer_hub/1.4/html-single/customizing/index', 'https://access.redhat.com/documentation/en-us/red_hat_developer_hub/1.4/html-single/configuring_plugins_in_red_hat_developer_hub/index')"
• 1 "('https://docs.redhat.com/en/documentation/red_hat_developer_hub/1.4/html-single/dynamic_plugins_reference/index#red-hat-supported-plugins', 'https://access.redhat.com/documentation/en-us/red_hat_developer_hub/1.4/html-single/configuring_plugins_in_red_hat_developer_hub/index#rhdh-tech-preview-plugins')"
• 1 "('https://docs.redhat.com/en/documentation/red_hat_developer_hub/1.4/html-single/dynamic_plugins_reference/index#red-hat-supported-plugins', 'https://access.redhat.com/documentation/en-us/red_hat_developer_hub/1.4/html-single/configuring_plugins_in_red_hat_developer_hub/index#rhdh-compatible-plugins')"
• 1 "('https://docs.redhat.com/en/documentation/red_hat_developer_hub/1.5/html/customizing_red_hat_developer_hub/proc-customizing-the-tech-radar-page_configuring-a-floating-action-button#proc-customizing-the-tech-radar-page-by-using-a-json-file_configuring-a-floating-action-button', 'https://raw.githubusercontent.com/redhat-developer/rhdh/release-1.5/packages/app/public/tech-radar/data-default.json')"
• 1 "('https://docs.redhat.com/en/documentation/red_hat_developer_hub/1.5/html/authorization_in_red_hat_developer_hub/configuring-guest-access-with-rbac-ui_title-authorization#setting-up-the-guest-authentication-provider_title-authorization', 'https://docs.redhat.com/en/documentation/red_hat_developer_hub/1.5/html/authorization_in_red_hat_developer_hub/%7Bplugins-configure-book-url%7D')"
• 1 "('https://docs.redhat.com/en/documentation/red_hat_developer_hub/1.5/html/configuring_dynamic_plugins/bulk-importing-github-repositories', 'https://docs.redhat.com/en/documentation/red_hat_developer_hub/1.5/html/configuring_dynamic_plugins/%7Blinkgettingstartedguide%7D#enabling-github-discovery-in-red-hat-developer-hub')"
• 1 "('https://docs.redhat.com/en/documentation/red_hat_developer_hub/1.5/html/configuring_dynamic_plugins/bulk-importing-github-repositories', 'https://docs.redhat.com/en/documentation/red_hat_developer_hub/1.5/html/configuring_dynamic_plugins/%7Blinkgettingstartedguide%7D#assembly-audit-log')"
• 1 "('https://docs.redhat.com/en/documentation/red_hat_developer_hub/1.5/html/configuring_dynamic_plugins/con-kubernetes-custom-actions_assembly-managing-labels-annotations-topology', 'https://docs.redhat.com/en/documentation/red_hat_developer_hub/1.5/html/configuring_dynamic_plugins/%7Bcustomizing-book-url#configuring-templates%7D')"
• 1 "('https://docs.redhat.com/en/documentation/red_hat_developer_hub/1.5/html/telemetry_data_collection_and_analysis/disabling-telemetry-data-collection_title-telemetry#proc-disabling-telemetry-using-helm_title-telemetry', 'https://docs.redhat.com/en/documentation/red_hat_developer_hub/1.5/html-single/telemetry_data_collection/index#proc-disabling-telemetry-using-operator_title-telemetry')"
• 1 "('https://docs.redhat.com/en/documentation/red_hat_developer_hub/1.5/html/telemetry_data_collection_and_analysis/customizing-segment-source_title-telemetry', 'https://docs.redhat.com/en/documentation/red_hat_developer_hub/1.5/html-single/telemetry_data_collection/index')"
• 1 "('https://docs.redhat.com/en/documentation/red_hat_developer_hub/1.4/html/installing_red_hat_developer_hub_in_an_air-gapped_environment/proc-install-rhdh-airgapped-environment-ocp-operator_title-install-rhdh-air-grapped', 'https://docs.redhat.com/en/documentation/openshift_container_platform/4.17/html-single/disconnected_installation_mirroring/index#prerequisites_installing-mirroring-installation-images')"
• 1 "('https://docs.redhat.com/en/documentation/red_hat_developer_hub/1.4/html/installing_red_hat_developer_hub_in_an_air-gapped_environment/proc-install-rhdh-airgapped-environment-ocp-operator_title-install-rhdh-air-grapped', 'https://docs.redhat.com/en/documentation/openshift_container_platform/4.17/html-single/disconnected_installation_mirroring/index#installing-mirroring-creating-registry')"
• 1 "('https://docs.redhat.com/en/documentation/red_hat_developer_hub/1.4/html/installing_red_hat_developer_hub_in_an_air-gapped_environment/proc-install-rhdh-airgapped-environment-ocp-operator_title-install-rhdh-air-grapped', 'https://docs.redhat.com/en/documentation/openshift_container_platform/4.17/html-single/disconnected_installation_mirroring/index#installation-about-mirror-registry_installing-mirroring-installation-images')"
• 1 "('https://docs.redhat.com/en/documentation/red_hat_developer_hub/1.4/html/telemetry_data_collection_and_analysis/disabling-telemetry-data-collection_title-telemetry#proc-disabling-telemetry-using-helm_title-telemetry', 'https://docs.redhat.com/en/documentation/red_hat_developer_hub/1.4/html-single/telemetry_data_collection/index#proc-disabling-telemetry-using-operator_title-telemetry')"
• 1 "('https://docs.redhat.com/en/documentation/red_hat_developer_hub/1.4/html/telemetry_data_collection_and_analysis/customizing-segment-source_title-telemetry', 'https://docs.redhat.com/en/documentation/red_hat_developer_hub/1.4/html-single/telemetry_data_collection/index')"
• 1 "('https://docs.redhat.com/en/documentation/red_hat_developer_hub/1.4/html/configuring_dynamic_plugins/bulk-importing-github-repositories', 'https://docs.redhat.com/en/documentation/red_hat_developer_hub/1.4/html/configuring_dynamic_plugins/%7Blinkgettingstartedguide%7D#enabling-github-discovery-in-red-hat-developer-hub')"
• 1 "('https://docs.redhat.com/en/documentation/red_hat_developer_hub/1.4/html/configuring_dynamic_plugins/bulk-importing-github-repositories', 'https://docs.redhat.com/en/documentation/red_hat_developer_hub/1.4/html/configuring_dynamic_plugins/%7Blinkgettingstartedguide%7D#assembly-audit-log')"
• 1 "('https://docs.redhat.com/en/documentation/red_hat_developer_hub/1.2/html/administration_guide_for_red_hat_developer_hub/assembly-rhdh-telemetry', 'https://docs.redhat.com/en/documentation/red_hat_developer_hub/1.2/html/administration_guide_for_red_hat_developer_hub/%7BLinkInstallationGuide%7D#assembly-install-rhdh-ocp-operator')"
• 1 "('https://docs.redhat.com/en/documentation/red_hat_developer_hub/1.2/html/authentication/assembly-auth-provider-github', 'https://github.com/janus-idp/backstage-showcase/blob/main/showcase-docs/getting-started.md')"
• 1 "('https://docs.redhat.com/en/documentation/red_hat_developer_hub/1.2/html/administration_guide_for_red_hat_developer_hub/assembly-rhdh-telemetry', 'https://docs.redhat.com/en/documentation/red_hat_developer_hub/1.2/html/administration_guide_for_red_hat_developer_hub/%7BLinkInstallationGuide%7D#assembly-install-rhdh-ocp-helm')"
• 1 "('https://docs.redhat.com/en/documentation/red_hat_developer_hub/1.2/html/authentication/assembly-auth-provider-oidc#proc-configuring-keycloak-with-oidc_title-authentication', 'https://%3Crhdh_url%3E/api/auth/oidc/handler/frame')"
• 1 "('https://docs.redhat.com/en/documentation/red_hat_developer_hub/1.2/html/getting_started_with_red_hat_developer_hub/ref-rhdh-supported-configs_rhdh-getting-started', 'https://docs.redhat.com/en/documentation/red_hat_developer_hub/1.2/html-single/installing_red_hat_developer_hub_on_openshift_container_platform/index/.xml#assembly-install-rhdh-ocp')"

Version(s): 1.7

Issue: https://issues.redhat.com/browse/RHDHBUGS-2005

Preview:

[rhdh-bot]

Updated preview: https://redhat-developer.github.io/red-hat-developers-documentation-rhdh/pr-1348/ @ 09/08/25 14:44:01

[themr0c]

/cherry-pick release-1.8

[openshift-cherrypick-robot]

@themr0c: cannot checkout release-1.8: error checking out "release-1.8": exit status 1 error: pathspec 'release-1.8' did not match any file(s) known to git

In response to this:

/cherry-pick release-1.8

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes-sigs/prow repository.

[themr0c]

I will address eventual fixes in followup pull requests.

[themr0c]

/cherry-pick release-1.7

[openshift-cherrypick-robot]

@themr0c: #1348 failed to apply on top of branch "release-1.7":

Applying: RHDHBUGS-2005 - Removed an useless link (the linked section just follows the link)
Applying: RHDHBUGS-2005 - Sorted link attributes alphabetically
Using index info to reconstruct a base tree...
M	artifacts/attributes.adoc
Falling back to patching base and 3-way merge...
Auto-merging artifacts/attributes.adoc
CONFLICT (content): Merge conflict in artifacts/attributes.adoc
error: Failed to merge in the changes.
hint: Use 'git am --show-current-patch=diff' to see the failed patch
hint: When you have resolved this problem, run "git am --continue".
hint: If you prefer to skip this patch, run "git am --skip" instead.
hint: To restore the original branch and stop patching, run "git am --abort".
hint: Disable this message with "git config advice.mergeConflict false"
Patch failed at 0002 RHDHBUGS-2005 - Sorted link attributes alphabetically

In response to this:

/cherry-pick release-1.7

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes-sigs/prow repository.

[jmagak]

Please include the following suggestions in your future pull requests, @themr0c .
The issue that I saw is that the link, xref are visible in various areas in the preview.

[jmagak]

Suggested change

	* You {configuring-book-link}#using-the-helm-chart-to-run-rhdh-with-your-custom-configuration[use the {product} Helm chart to run {product-short}].
	* You {configuring-book-link}#using-the-helm-chart-to-run-rhdh-with-your-custom-configuration[use the {product} Helm chart to run {product-short}].

[jmagak]

Suggested change

	For more information, see {configuring-book-link}#HighAvailability[_Configuring high availability in Red Hat Developer Hub_].
	For more information, see {configuring-book-link}#HighAvailability[_Configuring high availability in {product}_].

[jmagak]

Suggested change

	{ansible-automation-platform-docs-link}/html-single/using_ansible_plug-ins_for_red_hat_developer_hub/index[_Using Ansible plug-ins for Red Hat Developer Hub_].
	{ansible-automation-platform-docs-link}/html-single/using_ansible_plug-ins_for_red_hat_developer_hub/index[_Using Ansible plug-ins for {product}_].

[jmagak]

Suggested change

	{ansible-automation-platform-docs-link}/html-single/installing_ansible_plug-ins_for_red_hat_developer_hub/index[_Installing Ansible plug-ins for Red Hat Developer Hub_].
	{ansible-automation-platform-docs-link}/html-single/installing_ansible_plug-ins_for_red_hat_developer_hub/index[_Installing Ansible plug-ins for {product}_].

[jmagak]

Suggested change

	{ansible-automation-platform-docs-link}/html-single/using_ansible_plug-ins_for_red_hat_developer_hub/index[_Using Ansible plug-ins for Red Hat Developer Hub_].
	{ansible-automation-platform-docs-link}/html-single/using_ansible_plug-ins_for_red_hat_developer_hub/index[_Using Ansible plug-ins for {product}_].

[jmagak]

Suggested change

	Note that only {product-short} administrators or users with the `bulk.import` permission can use the Bulk Import feature. See {authorization-book-link}#ref-rbac-permission-policies_title-authorization[Permission policies in Red Hat Developer Hub].
	Note that only {product-short} administrators or users with the `bulk.import` permission can use the Bulk Import feature. See {authorization-book-link}#ref-rbac-permission-policies_title-authorization[Permission policies in {product}].

[jmagak]

Suggested change

	Configure the logging environment, including both the CPU and memory limits for each logging component. For more information, see link:{ocp-docs-link}/html-single/logging/index#cluster-logging-memory[{ocp-brand-name} - Configuring your Logging deployment].
	Configure the logging environment, including both the CPU and memory limits for each logging component. For more information, see {ocp-docs-link}/html-single/logging/index#cluster-logging-memory[{ocp-brand-name} - Configuring your Logging deployment].

[jmagak]

Suggested change

	Configure the `spec.collection` stanza in the `ClusterLogging` custom resource (CR) to use a supported modification to the log collector and collect logs from `STDOUT`. For more information, see link:{ocp-docs-link}/html-single/logging/index#cluster-logging-collector[{ocp-brand-name} - Configuring the logging collector].
	Configure the `spec.collection` stanza in the `ClusterLogging` custom resource (CR) to use a supported modification to the log collector and collect logs from `STDOUT`. For more information, see {ocp-docs-link}/html-single/logging/index#cluster-logging-collector[{ocp-brand-name} - Configuring the logging collector].

[jmagak]

Suggested change

	For more information, see xref:{installing-on-aks-book-link}#assembly-install-rhdh-aks[{installing-on-aks-book-title}].
	For more information, see {installing-on-aks-book-link}#assembly-install-rhdh-aks[{installing-on-aks-book-title}].