RHDHBUGS-2005 - Fixed broken link by replacing docs.redhat.com occurences by attributes

Signed-off-by: Fabrice Flore-Thébault <[email protected]>

Author: themr0c

artifacts/attributes.adoc

@@ -44,9 +44,12 @@
 :logging-brand-name: Red Hat OpenShift Logging
 :logging-short: OpenShift Logging
 // minimum and current latest supported versions
+:ansible-automation-platform-version: 2.4
 :ocp-version-min: 4.14
 :ocp-version: 4.18
 :kubernetes-version: 1.24
+:ocp-docs-link: link:https://docs.redhat.com/en/documentation/openshift_container_platform/{ocp-version}
+:ansible-automation-platform-docs-link: link:https://docs.redhat.com/en/documentation/red_hat_ansible_automation_platform/{ansible-automation-platform-version}
 // First mention of OpenShift CLI or `oc` in a module
 :openshift-cli: pass:quotes[OpenShift CLI (`oc`)]
 :rhsso-brand-name: Red Hat Single-Sign On

modules/configuring/proc-provisioning-your-custom-configuration.adoc

@@ -10,7 +10,7 @@ Your changes on this configuration might get reverted on {product-short} restart
 ====
 
 .Prerequisites
-* By using the link:https://docs.redhat.com/en/documentation/openshift_container_platform/{ocp-version}/html-single/cli_tools/index#cli-about-cli_cli-developer-commands[{openshift-cli}], you have access, with developer permissions, to the {ocp-short} cluster aimed at containing your {product-short} instance.
+* By using the {ocp-docs-link}/html-single/cli_tools/index#cli-about-cli_cli-developer-commands[{openshift-cli}], you have access, with developer permissions, to the {ocp-short} cluster aimed at containing your {product-short} instance.
 
 .Procedure
 . Author your custom `_<my_product_secrets>_.txt` file to provision your secrets as environment variables values in an {ocp-short} secret, rather than in clear text in your configuration files.
@@ -66,7 +66,7 @@ backend:
 $ oc create namespace {my-product-namespace}
 ----
 +
-Alternatively, link:https://docs.redhat.com/en/documentation/openshift_container_platform/{ocp-version}/html-single/building_applications/index#creating-a-project-using-the-web-console_projects[create the project by using the web console].
+Alternatively, {ocp-docs-link}/html-single/building_applications/index#creating-a-project-using-the-web-console_projects[create the project by using the web console].
 
 .. Provision your `{my-app-config-file}` file to the `{my-app-config-config-map}` config map in the _<{my-product-namespace}>_ project.
 +
@@ -75,7 +75,7 @@ Alternatively, link:https://docs.redhat.com/en/documentation/openshift_container
 $ oc create configmap {my-app-config-config-map} --from-file={my-app-config-file} --namespace={my-product-namespace}
 ----
 +
-Alternatively, link:https://docs.redhat.com/en/documentation/openshift_container_platform/{ocp-version}/html-single/nodes/index#nnodes-pods-configmap-create-from-console_configmaps[create the config map by using the web console].
+Alternatively, {ocp-docs-link}/html-single/nodes/index#nnodes-pods-configmap-create-from-console_configmaps[create the config map by using the web console].
 
 .. Provision your `_<my_product_secrets>_.txt` file to the `_<my_product_secrets>_` secret in the _<{my-product-namespace}>_ project.
 +
@@ -85,7 +85,7 @@ $ oc create secret generic `_<my_product_secrets>_` --from-file=`_<my_product_se
 ----
 +
 Alternatively,
-link:https://docs.redhat.com/en/documentation/openshift_container_platform/{ocp-version}/html-single/nodes/index#nodes-pods-secrets-creating-web-console-secrets_nodes-pods-secrets[create the secret by using the web console].
+{ocp-docs-link}/html-single/nodes/index#nodes-pods-secrets-creating-web-console-secrets_nodes-pods-secrets[create the secret by using the web console].
 
 [NOTE]
 ====

modules/configuring/proc-using-the-helm-chart-to-run-rhdh-with-your-custom-configuration.adoc

@@ -5,7 +5,7 @@ You can use the {product} Helm chart to add a custom application configuration f
 
 .Prerequisites
 
-* By using the {ocp-short} web console, you have access with developer permissions, to link:https://docs.redhat.com/en/documentation/openshift_container_platform/{ocp-version}/html-single/building_applications/index#working-with-projects[an {ocp-short} project] named _<{my-product-namespace}>_, aimed at containing your {product-short} instance.
+* By using the {ocp-short} web console, you have access with developer permissions, to {ocp-docs-link}/html-single/building_applications/index#working-with-projects[an {ocp-short} project] named _<{my-product-namespace}>_, aimed at containing your {product-short} instance.
 * xref:provisioning-your-custom-configuration[You have uploaded your custom configuration files and secrets in your `_<{my-product-namespace}>_` project].
 
 .Procedure

modules/configuring/proc-using-the-operator-to-run-rhdh-with-your-custom-configuration.adoc

@@ -7,7 +7,7 @@ To use the {product-short} Operator to run {product} with your custom configurat
 * Injects environment variables provisioned in your custom secrets.
 
 .Prerequisites
-* By using the link:https://docs.redhat.com/en/documentation/openshift_container_platform/{ocp-version}/html-single/cli_tools/index#cli-about-cli_cli-developer-commands[{openshift-cli}], you have access, with developer permissions, to the {ocp-short} cluster aimed at containing your {product-short} instance.
+* By using the {ocp-docs-link}/html-single/cli_tools/index#cli-about-cli_cli-developer-commands[{openshift-cli}], you have access, with developer permissions, to the {ocp-short} cluster aimed at containing your {product-short} instance.
 * {installing-on-ocp-book-link}[Your {ocp-short} administrator has installed the {product} Operator in {ocp-short}].
 * xref:provisioning-your-custom-configuration[You have provisioned your custom config maps and secrets in your `_<{my-product-namespace}>_` project].
 

modules/dynamic-plugins/con-ansible-plugin-admin.adoc

@@ -4,5 +4,5 @@ Ansible plug-ins for {product} deliver an Ansible-specific portal experience wit
 push-button content creation, integrated development tools, and other opinionated resources.
 
 To install and configure the Ansible plugins, see
-link:https://docs.redhat.com/en/documentation/red_hat_ansible_automation_platform/2.5/html/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/installing_ansible_plug-ins_for_red_hat_developer_hub/index[_Installing Ansible plug-ins for Red Hat Developer Hub_].
 

modules/dynamic-plugins/con-ansible-plugin-user.adoc

@@ -15,5 +15,5 @@ Additional detail on how Red Hat provides support for bundled community dynamic
 ====
 
 To use the Ansible plugins, see
-link:https://docs.redhat.com/en/documentation/red_hat_ansible_automation_platform/2.4/html/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/using_ansible_plug-ins_for_red_hat_developer_hub/index[_Using Ansible plug-ins for Red Hat Developer Hub_].
 

modules/dynamic-plugins/con-ansible-plugin.adoc

@@ -17,10 +17,10 @@ Additional detail on how Red Hat provides support for bundled community dynamic
 == For administrators
 
 To install and configure the Ansible plugins, see
-link:https://docs.redhat.com/en/documentation/red_hat_ansible_automation_platform/2.4/html/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/installing_ansible_plug-ins_for_red_hat_developer_hub/index[_Installing Ansible plug-ins for Red Hat Developer Hub_].
 
 == For users
 
 To use the Ansible plugins, see
-link:https://docs.redhat.com/en/documentation/red_hat_ansible_automation_platform/2.4/html/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/using_ansible_plug-ins_for_red_hat_developer_hub/index[_Using Ansible plug-ins for Red Hat Developer Hub_].
 

modules/dynamic-plugins/ref-rh-compatible-plugins.adoc

@@ -7,15 +7,15 @@ The following Technology Preview plugins are not preinstalled and must be instal
 |*Name* |*Plugin*|*Version* |*Installation Details*
 
 |Ansible Automation Platform Frontend|`https://access.redhat.com/downloads/content/480/ver=2.4/rhel---9/2.4/x86_64/product-software[@ansible/plugin-backstage-rhaap]` |1.0.0
-| https://docs.redhat.com/en/documentation/red_hat_ansible_automation_platform/2.4/html/installing_ansible_plug-ins_for_red_hat_developer_hub[Learn more]
+| {ansible-automation-platform-docs-link}/html/installing_ansible_plug-ins_for_red_hat_developer_hub[Learn more]
 
 |Ansible Automation Platform
 | `https://access.redhat.com/downloads/content/480/ver=2.4/rhel---9/2.4/x86_64/product-software[@ansible/plugin-backstage-rhaap-backend]` |1.0.0
-| https://docs.redhat.com/en/documentation/red_hat_ansible_automation_platform/2.4/html/installing_ansible_plug-ins_for_red_hat_developer_hub[Learn more]
+| {ansible-automation-platform-docs-link}/html/installing_ansible_plug-ins_for_red_hat_developer_hub[Learn more]
 
 |Ansible Automation Platform Scaffolder Backend
 |`https://access.redhat.com/downloads/content/480/ver=2.4/rhel---9/2.4/x86_64/product-software[@ansible/plugin-scaffolder-backend-module-backstage-rhaap]` |1.0.0
-| https://docs.redhat.com/en/documentation/red_hat_ansible_automation_platform/2.4/html/installing_ansible_plug-ins_for_red_hat_developer_hub[Learn more]
+| {ansible-automation-platform-docs-link}/html/installing_ansible_plug-ins_for_red_hat_developer_hub[Learn more]
 
 // temporarily removed until we have a good installation story from the Orchestrator team
 //|Orchestrator Frontend|`https://www.npmjs.com/package/@red-hat-developer-hub/backstage-plugin-orchestrator[@red-hat-developer-hub/backstage-plugin-orchestrator]` | N/A for RHDH 1.4 | https://github.com/redhat-developer/rhdh-plugins/tree/main/workspaces/orchestrator/[Learn more]

modules/installation/proc-install-operator.adoc

@@ -14,7 +14,7 @@ Containers are available for the following CPU architectures:
 .Prerequisites
 
 * You are logged in as an administrator on the {ocp-short} web console.
-* You have configured the appropriate roles and permissions within your project to create or access an application. For more information, see the link:https://docs.redhat.com/en/documentation/openshift_container_platform/{ocp-version}/html-single/building_applications/index#building-applications-overview[{ocp-brand-name} documentation on Building applications].
+* You have configured the appropriate roles and permissions within your project to create or access an application. For more information, see the {ocp-docs-link}/html-single/building_applications/index#building-applications-overview[{ocp-brand-name} documentation on Building applications].
 * You have installed {ocp-brand-name} 4.17 or later.
 
 .Procedure
@@ -57,9 +57,9 @@ The *All namespaces on the cluster (default)* option is selected by default. The
 ====
 For enhanced security, better control over the Operator lifecycle, and preventing potential privilege escalation, install the {product} Operator in a dedicated default `rhdh-operator` namespace. You can restrict other users' access to the Operator resources through role bindings or cluster role bindings.
 
-You can also install the Operator in another namespace by creating the necessary resources, such as an Operator group. For more information, see link:https://docs.redhat.com/en/documentation/openshift_container_platform/{ocp-version}/html-single/operators/index#olm-installing-global-namespaces_olm-adding-operators-to-a-cluster[Installing global Operators in custom namespaces].
+You can also install the Operator in another namespace by creating the necessary resources, such as an Operator group. For more information, see {ocp-docs-link}/html-single/operators/index#olm-installing-global-namespaces_olm-adding-operators-to-a-cluster[Installing global Operators in custom namespaces].
 
-However, if the {product} Operator shares a namespace with other Operators, then it shares the same update policy as well, preventing the customization of the update policy. For example, if one Operator is set to manual updates, the {product} Operator update policy is also set to manual. For more information, see link:https://docs.redhat.com/en/documentation/openshift_container_platform/{ocp-version}/html-single/operators/index#olm-colocation-namespaces_olm-colocation[Colocation of Operators in a namespace].
+However, if the {product} Operator shares a namespace with other Operators, then it shares the same update policy as well, preventing the customization of the update policy. For example, if one Operator is set to manual updates, the {product} Operator update policy is also set to manual. For more information, see {ocp-docs-link}/html-single/operators/index#olm-colocation-namespaces_olm-colocation[Colocation of Operators in a namespace].
 ====
 +
 . Select the *Update approval* method for the Operator.
@@ -87,4 +87,4 @@ If you selected an *Automatic* approval strategy, the upgrade status should reso
 .Additional resources
 
 * xref:proc-install-rhdh-ocp-operator_{context}[Deploying {product} on {ocp-short} with the Operator]
-* link:https://docs.redhat.com/en/documentation/openshift_container_platform/{ocp-version}/html-single/operators/index#olm-installing-from-operatorhub-using-web-console_olm-adding-operators-to-a-cluster[Installing from OperatorHub by using the web console]
+* {ocp-docs-link}/html-single/operators/index#olm-installing-from-operatorhub-using-web-console_olm-adding-operators-to-a-cluster[Installing from OperatorHub by using the web console]

modules/installation/proc-install-rhdh-ocp-helm-cli.adoc

@@ -9,8 +9,8 @@ You can use the Helm CLI to install {product} on {ocp-brand-name}.
 .Prerequisites
 * You have installed the {openshift-cli} on your workstation.
 * You are logged in to your {ocp-short} account.
-* A user with the {ocp-short} admin role has configured the appropriate roles and permissions within your project to create an application. For more information about {ocp-short} roles, see link:https://docs.redhat.com/en/documentation/openshift_container_platform/{ocp-version}/html-single/authentication_and_authorization/index#authorization-overview_using-rbac[Using RBAC to define and apply permissions].
-* You have created a project in {ocp-short}. For more information about creating a project in {ocp-short}, see link:https://docs.redhat.com/en/documentation/openshift_container_platform/{ocp-version}/html-single/building_applications/index#working-with-projects[{ocp-brand-name} documentation].
+* A user with the {ocp-short} admin role has configured the appropriate roles and permissions within your project to create an application. For more information about {ocp-short} roles, see {ocp-docs-link}/html-single/authentication_and_authorization/index#authorization-overview_using-rbac[Using RBAC to define and apply permissions].
+* You have created a project in {ocp-short}. For more information about creating a project in {ocp-short}, see {ocp-docs-link}/html-single/building_applications/index#working-with-projects[{ocp-brand-name} documentation].
 * You have installed the Helm CLI tool.
 
 .Procedure
@@ -50,4 +50,4 @@ echo "https://redhat-developer-hub-$NAMESPACE.$CLUSTER_ROUTER_BASE"
 * Open the running {product-short} instance URL in your browser to use {product-short}.
 
 .Additional resources
-* link:https://docs.redhat.com/en/documentation/openshift_dedicated/4/html-single/building_applications/index#installing-helm[Installing Helm]
+* link:https://docs.redhat.com/en/documentation/openshift_dedicated/4/html-single/building_applications/index#installing-helm[Installing Helm]