Uploaded image for project: 'Red Hat Developer Hub Bugs'
  1. Red Hat Developer Hub Bugs
  2. RHDHBUGS-2005

List and fix 39 broken links in RHDH 1.7 live docs

XMLWordPrintable

    • 13
    • False
    • Hide

      None

      Show
      None
    • False
    • 8
    • RHDH Documentation 3279, RHDH Documentation 3280
    • Critical

      Description of problem:

      Cross-title links are not (and can not) checked before the release date.

      One of the post-release task is to check the content for broken links and fix them.

      Prerequisites (if any, like setup, operators/versions):

      Steps to Reproduce

      Check for broken links in the published docs, with a tool such as linkchecker (htmltest does only work on files, not on live URLs, therefore we cannot use it)

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

      Actual results:

       

      {{cat broken-links.txt }}
      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', 'htt
      {{ps://%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-r
      hdh-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-e
      {{ksp')" }}
      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-r
      {{hdh-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', 'htt
      {{ps://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-rada
      {{r-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')" }}
      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-fea
      {{ture', '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-fea
      ture', '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/doc
      {{umentation/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/')" }}
      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/docu
      {{mentation/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/documenta
      {{tion/red_hat_developer_hub/1.7/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-single/customizing/index', 'https://access.redhat.com/documentation/en-us/red_hat_developer_hub/1.4/html-single/configuring_plugin
      {{s_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_develope
      {{r_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_develope
      {{r_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-t
      {{ech-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-authenticati
      {{on-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_tit
      {{le-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-r
      {{hdh-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-r
      {{hdh-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-r
      hdh-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-ins
      {{tallation-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_tit
      {{le-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_develop
      {{er_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-st
      {{arted.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_develop
      {{er_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/documenta
      {{tion/red_hat_developer_hub/1.2/html-single/installing_red_hat_developer_hub_on_openshift_container_platform/index/.xml#assembly-install-rhdh-ocp')" }}

      Expected results:

       

      No broken links: after running linkchecker, the broken-links.txt file is empty.

      Reproducibility (Always/Intermittent/Only Once):

      Ideally, also produce a daily report for broken links.

      Build Details:

      Additional info (Such as Logs, Screenshots, etc):

              ffloreth@redhat.com Fabrice Flore-Thébault
              ffloreth@redhat.com Fabrice Flore-Thébault
              RHIDP - Documentation
              Votes:
              0 Vote for this issue
              Watchers:
              1 Start watching this issue

                Created:
                Updated:
                Resolved: