Merge branch 'main' into RHIDP-1764-main

hmanwani-rh · web-flow · commit 664193df903b · 2024-10-16T17:08:39.000+05:30
diff --git a/artifacts/attributes.adoc b/artifacts/attributes.adoc
@@ -31,6 +31,8 @@
 :ocp-version: 4.15
 // 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
+:rhsso: RHSSO
 
 // Partner Platforms
 :aws-brand-name: Amazon Web Services
@@ -84,20 +86,20 @@
 :authorization-book-url: https://docs.redhat.com/documentation/en-us/red_hat_developer_hub/{product-version}/html-single/authorization/index
 :authorization-book-title: Authorization
 
-:installing-on-ocp-book-url: https://docs.redhat.com/en/documentation/red_hat_developer_hub/{product-version}/html/installing_red_hat_developer_hub_on_openshift_container_platform/index
+:installing-on-ocp-book-url: https://docs.redhat.com/en/documentation/red_hat_developer_hub/{product-version}/html-single/installing_red_hat_developer_hub_on_openshift_container_platform/index
 :installing-on-ocp-book-title: Installing {product} on {ocp-short}
 
-:installing-on-eks-book-url: https://docs.redhat.com/en/documentation/red_hat_developer_hub/{product-version}/html/installing_red_hat_developer_hub_on_amazon_elastic_kubernetes_service/index
+:installing-on-eks-book-url: https://docs.redhat.com/en/documentation/red_hat_developer_hub/{product-version}/html-single/installing_red_hat_developer_hub_on_amazon_elastic_kubernetes_service/index
 :installing-on-eks-book-title: Installing {product} on {eks-brand-name}
 
-:installing-on-aks-book-url: https://docs.redhat.com/en/documentation/red_hat_developer_hub/{product-version}/html/installing_red_hat_developer_hub_on_microsoft_azure_kubernetes_service/index
+:installing-on-aks-book-url: https://docs.redhat.com/en/documentation/red_hat_developer_hub/{product-version}/html-single/installing_red_hat_developer_hub_on_microsoft_azure_kubernetes_service/index
 :installing-on-aks-book-title: Installing {product} on {aks-brand-name}
 
-:installing-in-air-gap-book-url: https://docs.redhat.com/en/documentation/red_hat_developer_hub/{product-version}/html/installing_red_hat_developer_hub_in_an_air-gapped_environment/index
+:installing-in-air-gap-book-url: https://docs.redhat.com/en/documentation/red_hat_developer_hub/{product-version}/html-single/installing_red_hat_developer_hub_in_an_air-gapped_environment/index
 :installing-in-air-gap-book-title: Installing {product} in an air-gapped environment
 
-:upgrading-book-url: https://docs.redhat.com/en/documentation/red_hat_developer_hub/{product-version}/html/upgrading_red_hat_developer_hub/index
+:upgrading-book-url: https://docs.redhat.com/en/documentation/red_hat_developer_hub/{product-version}/html-single/upgrading_red_hat_developer_hub/index
 :upgrading-book-title: Upgrading {product}
 
-:plugins-configure-book-url: https://docs.redhat.com/en/documentation/red_hat_developer_hub/{product-version}/html/configuring_dynamic_plugins/index
-:plugins-configure-book-title: Configuring dynamic plugins
+:plugins-configure-book-url: https://docs.redhat.com/en/documentation/red_hat_developer_hub/{product-version}/html-single/configuring_dynamic_plugins/index
+:plugins-configure-book-title: Configuring dynamic plugins
diff --git a/modules/admin/proc-using-azure-auth-provider.adoc b/modules/admin/proc-using-azure-auth-provider.adoc
@@ -7,7 +7,7 @@ The `core-plugin-api` package in {product-short} comes integrated with Microsoft
 .Prerequisites
 * You have deployed {product-short} on AKS.
 
-For more information, see xref:{installing-on-aks-book-url}#assembly-install-rhdh-aks[Installing Red Hat Developer Hub on Azure Kubernetes Service (AKS)].
+For more information, see xref:{installing-on-aks-book-url}#assembly-install-rhdh-aks[Installing {product} on {aks-name} ({aks-short})].
 
 * You have created registered your application in Azure portal. For more information, see https://learn.microsoft.com/en-us/entra/identity-platform/quickstart-register-app[Register an application with the Microsoft identity platform].
 
diff --git a/modules/authentication/proc-creating-a-custom-transformer-to-provision-users-from-rhsso-to-the-software-catalog.adoc b/modules/authentication/proc-creating-a-custom-transformer-to-provision-users-from-rhsso-to-the-software-catalog.adoc
@@ -1,10 +1,10 @@
 [id="creating-a-custom-transformer-to-provision-users-from-rhsso-to-the-software-catalog"]
-= Creating a custom transformer to provision users from Red Hat Single-Sign On (RHSSO) to the software catalog
+= Creating a custom transformer to provision users from {rhsso-brand-name} ({rhsso}) to the software catalog
 
-To customize how RHSSO users and groups are mapped to {product} entities, you can create a backend module that uses the `keycloakTransformerExtensionPoint` to provide custom user and group transformers for the Keycloak backend.
+To customize how {rhsso} users and groups are mapped to {product} entities, you can create a backend module that uses the `keycloakTransformerExtensionPoint` to provide custom user and group transformers for the Keycloak backend.
 
 .Prerequisites
-* You have xref:provisioning-users-from-rhsso-to-the-software-catalog[enabled provisioning users from Red Hat Single-Sign On (RHSSO) to the software catalog].
+* You have xref:provisioning-users-from-rhsso-to-the-software-catalog[enabled provisioning users from {rhsso-brand-name} ({rhsso}) to the software catalog].
 
 .Procedure
 . Create a new backend module with the `yarn new` command.
@@ -85,8 +85,8 @@ Check the console logs to verify that the synchronization is completed.
 
 * After the first import is complete, navigate to the *Catalog* page and select **User** to view the list of users.
 
-* When you select a user, you see the information imported from RHSSO.
+* When you select a user, you see the information imported from {rhsso}.
 
-* You can select a group, view the list, and access or review the information imported from RHSSO.
+* You can select a group, view the list, and access or review the information imported from {rhsso}.
 
-* You can log in with an RHSSO account.
+* You can log in with an {rhsso} account.
diff --git a/modules/authentication/proc-enabling-authentication-with-rhsso.adoc b/modules/authentication/proc-enabling-authentication-with-rhsso.adoc
@@ -1,21 +1,21 @@
 [id="enabling-authentication-with-rhsso"]
-= Enabling authentication with Red Hat Single-Sign On (RHSSO)
+= Enabling authentication with {rhsso-brand-name} ({rhsso})
 
-To authenticate users with Red Hat Single Sign-On (RHSSO), enable the OpenID Connect (OIDC) authentication provider in {product}.
+To authenticate users with Red Hat Single Sign-On ({rhsso}), enable the OpenID Connect (OIDC) authentication provider in {product}.
 
 
 .Prerequisites
 * You link:https://docs.redhat.com/en/documentation/red_hat_developer_hub/{product-version}/html/administration_guide_for_red_hat_developer_hub/assembly-add-custom-app-file-openshift_admin-rhdh[added a custom {product-short} application configuration], and have sufficient permissions to modify it.
-* You have sufficient permissions in RHSSO to create and manage a realm.
+* You have sufficient permissions in {rhsso} to create and manage a realm.
 
 .Procedure
-. To allow {product-short} to authenticate with RHSSO, complete the steps in RHSSO, to link:https://docs.redhat.com/en/documentation/red_hat_single_sign-on/7.6/html-single/getting_started_guide/index#realms-apps_[create a realm and a user] and link:https://docs.redhat.com/en/documentation/red_hat_single_sign-on/7.6/html-single/getting_started_guide/index#registering-app_[register the {product-short} application]:
+. To allow {product-short} to authenticate with {rhsso}, complete the steps in {rhsso}, to link:https://docs.redhat.com/en/documentation/red_hat_single_sign-on/7.6/html-single/getting_started_guide/index#realms-apps_[create a realm and a user] and link:https://docs.redhat.com/en/documentation/red_hat_single_sign-on/7.6/html-single/getting_started_guide/index#registering-app_[register the {product-short} application]:
 
 .. Use an existing realm, or link:https://docs.redhat.com/en/documentation/red_hat_single_sign-on/7.6/html-single/getting_started_guide/index#create-realm_[create a realm], with a distinctive **Name** such as __<my_realm>__.
 Save the value for the next step:
-* **RHSSO realm base URL**, such as: __<your_rhsso_URL>__/auth/realms/__<your_realm>__.
+* **{rhsso} realm base URL**, such as: __<your_rhsso_URL>__/auth/realms/__<your_realm>__.
 
-.. To register your {product-short} in RHSSO, in the created realm, link:https://docs.redhat.com/en/documentation/red_hat_single_sign-on/7.6/html-single/getting_started_guide/index#registering-app_[create a Client ID], with:
+.. To register your {product-short} in {rhsso}, in the created realm, link:https://docs.redhat.com/en/documentation/red_hat_single_sign-on/7.6/html-single/getting_started_guide/index#registering-app_[create a Client ID], with:
 ... **Client ID**: A distinctive client ID, such as __<{product-very-short}>__.
 ... **Valid redirect URIs**: Set to the OIDC handler URL: `https://__<RHDH_URL>__/api/auth/oidc/handler/frame`.
 ... Navigate to the **Credentials** tab and copy the **Client secret**.
@@ -25,16 +25,16 @@ Save the value for the next step:
 
 .. To prepare for the verification steps, in the same realm, get the credential information for an existing user or link:https://docs.redhat.com/en/documentation/red_hat_single_sign-on/7.6/html-single/getting_started_guide/index#create-user_[create a user]. Save the user credential information for the verification steps.
 
-. To add your RHSSO credentials to your {product-short} secrets, edit your {product-short} secrets, such as `secrets-rhdh`, and add the following key/value pairs:
+. To add your {rhsso} credentials to your {product-short} secrets, edit your {product-short} secrets, such as `secrets-rhdh`, and add the following key/value pairs:
 +
 `AUTH_OIDC_CLIENT_ID`:: Enter the saved **Client ID**.
 `AUTH_OIDC_CLIENT_SECRET`:: Enter the saved **Client Secret**.
-`AUTH_OIDC_METADATA_URL`:: Enter the saved **RHSSO realm base URL**.
+`AUTH_OIDC_METADATA_URL`:: Enter the saved **{rhsso} realm base URL**.
 
-. To set up the RHSSO authentication provider in your {product-short} custom configuration, edit your custom {product-short} ConfigMap such as `app-config-rhdh`, and add the following lines to the `app-config-rhdh.yaml` content:
+. To set up the {rhsso} authentication provider in your {product-short} custom configuration, edit your custom {product-short} ConfigMap such as `app-config-rhdh`, and add the following lines to the `app-config-rhdh.yaml` content:
 +
 --
-.`app-config-rhdh.yaml` fragment with mandatory fields to enable authentication with RHSSO
+.`app-config-rhdh.yaml` fragment with mandatory fields to enable authentication with {rhsso}
 [source,yaml]
 ----
 auth:
@@ -85,7 +85,7 @@ dangerouslyAllowSignInWithoutUserInCatalog: true
 
 `callbackUrl`::
 --
-RHSSO callback URL.
+{rhsso} callback URL.
 
 .`app-config-rhdh.yaml` fragment with optional `callbackURL` field
 [source,yaml]
@@ -130,7 +130,7 @@ auth:
 
 `scope`::
 --
-RHSSO scope.
+{rhsso} scope.
 
 .`app-config-rhdh.yaml` fragment with optional `scope` field
 [source,yaml]
diff --git a/modules/authentication/proc-provisioning-users-from-rhsso-to-the-software-catalog.adoc b/modules/authentication/proc-provisioning-users-from-rhsso-to-the-software-catalog.adoc
@@ -1,12 +1,12 @@
 [id="provisioning-users-from-rhsso-to-the-software-catalog"]
-= Provisioning users from Red Hat Single-Sign On (RHSSO) to the software catalog
+= Provisioning users from {rhsso-brand-name} ({rhsso}) to the software catalog
 
 .Prerequisites
-* You xref:enabling-authentication-with-rhsso[enabled authentication with RHSSO].
+* You xref:enabling-authentication-with-rhsso[enabled authentication with {rhsso}].
 
 .Procedure
 
-* To enable RHSSO member discovery, edit your custom {product-short} ConfigMap, such as `app-config-rhdh`, and add the following lines to the `app-config-rhdh.yaml` content:
+* To enable {rhsso} member discovery, edit your custom {product-short} ConfigMap, such as `app-config-rhdh`, and add the following lines to the `app-config-rhdh.yaml` content:
 +
 --
 [id=keycloakOrgProviderId]
@@ -27,13 +27,13 @@ catalog:
  Allow authentication only for users present in the {product-short} software catalog.
 
 `baseUrl`::
-Your RHSSO server URL, defined when xref:enabling-authentication-with-rhsso[enabling authentication with RHSSO].
+Your {rhsso} server URL, defined when xref:enabling-authentication-with-rhsso[enabling authentication with {rhsso}].
 
 `clientId`::
-Your {product-short} application client ID in RHSSO, defined when xref:enabling-authentication-with-rhsso[enabling authentication with RHSSO].
+Your {product-short} application client ID in {rhsso}, defined when xref:enabling-authentication-with-rhsso[enabling authentication with {rhsso}].
 
 `clientSecret`::
-Your {product-short} application client secret in RHSSO, defined when xref:enabling-authentication-with-rhsso[enabling authentication with RHSSO].
+Your {product-short} application client secret in {rhsso}, defined when xref:enabling-authentication-with-rhsso[enabling authentication with {rhsso}].
 
 Optional: Consider adding the following optional fields:
 
@@ -150,4 +150,4 @@ catalog:
 {"class":"KeycloakOrgEntityProvider","level":"info","message":"Committed 3 Keycloak users and 2 Keycloak groups in 0.0 seconds.","plugin":"catalog","service":"backstage","taskId":"KeycloakOrgEntityProvider:default:refresh","taskInstanceId":"bf0467ff-8ac4-4702-911c-380270e44dea","timestamp":"2024-09-25 13:58:04"}
 ----
 
-. Log in with an RHSSO account.
+. Log in with an {rhsso} account.
diff --git a/modules/authorization/proc-rbac-send-request-rbac-rest-api.adoc b/modules/authorization/proc-rbac-send-request-rbac-rest-api.adoc
@@ -7,7 +7,7 @@ The RBAC REST API enables you to interact with the permission policies and roles
 
 * {product} is installed and running.
 
-For more information about installing {product}, see link:{installing-on-ocp-book-url}#assembly-install-rhdh-ocp-helm[Installing {product} on {ocp-short} with the Helm chart].
+For more information about installing {product}, see link:{installing-on-ocp-book-url}#assembly-install-rhdh-ocp-helm[{installing-on-ocp-book-title} with the Helm chart].
 
 * You have access to the {product-short}.
 
diff --git a/modules/getting-started/proc-customize-rhdh-homepage.adoc b/modules/getting-started/proc-customize-rhdh-homepage.adoc
@@ -48,7 +48,7 @@ When using a dedicated service, you can do the following:
 .Prerequisites
 
 * You have installed the {product} using Helm Chart.
-For more information, see xref:{installing-on-ocp-book-url}#assembly-install-rhdh-ocp-helm[Installing {product} on {ocp-short} with the Helm chart].
+For more information, see xref:{installing-on-ocp-book-url}#assembly-install-rhdh-ocp-helm[{installing-on-ocp-book-title} with the Helm chart].
 
 .Procedure
 
diff --git a/modules/upgrade/proc-upgrade-rhdh-operator.adoc b/modules/upgrade/proc-upgrade-rhdh-operator.adoc
@@ -37,5 +37,5 @@ If there is no upgrade available, the *Upgrade status* field value is *Up to dat
 [role="_additional-resources"]
 .Additional resources
 
-* link:{installing-on-ocp-book-url}#proc-install-operator_assembly-install-rhdh-ocp-operator[Installing {product} on {ocp-short} with the Operator].
+* link:{installing-on-ocp-book-url}#proc-install-operator_assembly-install-rhdh-ocp-operator[{installing-on-ocp-book-title} with the Operator].
 * link:https://docs.openshift.com/container-platform/{ocp-version}/operators/admin/olm-adding-operators-to-cluster.html#olm-installing-from-operatorhub-using-web-console_olm-adding-operators-to-a-cluster[Installing from OperatorHub using the web console]
