Skip to content

Commit 8aff966

Browse files
committed
RHDHBUGS-2005 - Fixed broken link by replacing docs.redhat.com occurences by attributes - rhbk
Signed-off-by: Fabrice Flore-Thébault <[email protected]>
1 parent 3ea4dbd commit 8aff966

File tree

2 files changed

+34
-33
lines changed

2 files changed

+34
-33
lines changed

artifacts/attributes.adoc

Lines changed: 30 additions & 29 deletions
Original file line numberDiff line numberDiff line change
@@ -49,9 +49,6 @@
4949
:ocp-version: 4.18
5050
:osd-version: 4
5151
:kubernetes-version: 1.24
52-
:ansible-automation-platform-docs-link: link:https://docs.redhat.com/en/documentation/red_hat_ansible_automation_platform/{ansible-automation-platform-version}
53-
:ocp-docs-link: link:https://docs.redhat.com/en/documentation/openshift_container_platform/{ocp-version}
54-
:osd-docs-link: link:https://docs.redhat.com/en/documentation/openshift_dedicated/{osd-version}
5552
// First mention of OpenShift CLI or `oc` in a module
5653
:openshift-cli: pass:quotes[OpenShift CLI (`oc`)]
5754
:rhsso-brand-name: Red Hat Single-Sign On
@@ -102,63 +99,67 @@
10299
:rcs-short: RCS
103100
:rhoai-brand-name: Red Hat OpenShift AI
104101
// Links in alpabetical oprder
105-
:about-book-title: About {product}
106102
:about-book-link: {product-docs-link}/html-single/about_red_hat_developer_hub/index
107-
:adoption-insights-title: Adoption Insights in {product}
103+
:about-book-title: About {product}
108104
:adoption-insights-link: {product-docs-link}/html-single/adoption_insights_in_red_hat_developer_hub/index
109-
:audit-log-book-title: Audit logs in {product}
105+
:adoption-insights-title: Adoption Insights in {product}
106+
:ansible-automation-platform-docs-link: link:https://docs.redhat.com/en/documentation/red_hat_ansible_automation_platform/{ansible-automation-platform-version}
110107
:audit-log-book-link: {product-docs-link}/html-single/audit_logs_in_red_hat_developer_hub/index
111-
:authentication-book-title: Authentication in {product}
108+
:audit-log-book-title: Audit logs in {product}
112109
:authentication-book-link: {product-docs-link}/html-single/authentication_in_red_hat_developer_hub/index
113-
:authorization-book-title: Authorization in {product}
110+
:authentication-book-title: Authentication in {product}
114111
:authorization-book-link: {product-docs-link}/html-single/authorization_in_red_hat_developer_hub/index
112+
:authorization-book-title: Authorization in {product}
115113
:configure-category-link: {product-docs-link}/#Configure
116-
:configuring-book-title: Configuring {product}
117114
:configuring-book-link: {product-docs-link}/html-single/configuring_red_hat_developer_hub/index
118-
:configuring-dynamic-plugins-book-title: Configuring dynamic plugins
115+
:configuring-book-title: Configuring {product}
119116
:configuring-dynamic-plugins-book-link: {product-docs-link}/html-single/configuring_dynamic_plugins/index
117+
:configuring-dynamic-plugins-book-title: Configuring dynamic plugins
120118
:control-access-category-link: {product-docs-link}/#Control access
121-
:customizing-book-title: Customizing {product}
122119
:customizing-book-link: {product-docs-link}/html-single/customizing_red_hat_developer_hub/index
120+
:customizing-book-title: Customizing {product}
123121
:discover-category-link: {product-docs-link}/#Discover
124-
:dynamic-plugins-reference-book-title: Dynamic plugins reference
125122
:dynamic-plugins-reference-book-link: {product-docs-link}/html-single/dynamic_plugins_reference/index
123+
:dynamic-plugins-reference-book-title: Dynamic plugins reference
126124
:extend-category-link: {product-docs-link}/#Extend
127-
:getting-started-on-ocp-for-the-platform-engineer-book-title: Getting started with {product} on {ocp-brand-name} for the platform engineer
128125
:getting-started-on-ocp-for-the-platform-engineer-book-link: {product-docs-link}/html-single/getting_started_with_red_hat_developer_hub_on_red_hat_openshift_container_platform_for_the_platform_engineer/index
126+
:getting-started-on-ocp-for-the-platform-engineer-book-title: Getting started with {product} on {ocp-brand-name} for the platform engineer
129127
:install-category-link: {product-docs-link}/#Install
130-
:installing-and-viewing-plugins-book-title: Installing and viewing plugins in {product}
131128
:installing-and-viewing-plugins-book-link: {product-docs-link}/html-single/installing_and_viewing_plugins_in_red_hat_developer_hub/index
132-
:installing-in-air-gap-book-title: Installing {product} in an air-gapped environment
129+
:installing-and-viewing-plugins-book-title: Installing and viewing plugins in {product}
133130
:installing-in-air-gap-book-link: {product-docs-link}/html-single/installing_red_hat_developer_hub_in_an_air-gapped_environment/index
134-
:installing-on-aks-book-title: Installing {product} on {aks-brand-name}
131+
:installing-in-air-gap-book-title: Installing {product} in an air-gapped environment
135132
:installing-on-aks-book-link: {product-docs-link}/html-single/installing_red_hat_developer_hub_on_microsoft_azure_kubernetes_service/index
136-
:installing-on-eks-book-title: Installing {product} on {eks-brand-name}
133+
:installing-on-aks-book-title: Installing {product} on {aks-brand-name}
137134
:installing-on-eks-book-link: {product-docs-link}/html-single/installing_red_hat_developer_hub_on_amazon_elastic_kubernetes_service/index
138-
:installing-on-gke-book-title: Installing {product} on {gke-brand-name}
135+
:installing-on-eks-book-title: Installing {product} on {eks-brand-name}
139136
:installing-on-gke-book-link: {product-docs-link}/html-single/installing_red_hat_developer_hub_on_google_kubernetes_engine/index
140-
:installing-on-ocp-book-title: Installing {product} on {ocp-short}
137+
:installing-on-gke-book-title: Installing {product} on {gke-brand-name}
141138
:installing-on-ocp-book-link: {product-docs-link}/html-single/installing_red_hat_developer_hub_on_openshift_container_platform/index
142-
:installing-on-osd-on-gcp-book-title: Installing {product} on {gcp-brand-name} on {gcp-brand-name}
139+
:installing-on-ocp-book-title: Installing {product} on {ocp-short}
143140
:installing-on-osd-on-gcp-book-link: {product-docs-link}/html-single/installing_red_hat_developer_hub_on_openshift_dedicated_on_google_cloud_platform/index
144-
:installing-rhdh-orch-on-ocp-book-title: Installing RHDH with the Orchestrator Plugin on {ocp-short} using the {product} Operator
141+
:installing-on-osd-on-gcp-book-title: Installing {product} on {gcp-brand-name} on {gcp-brand-name}
145142
:installing-rhdh-orch-on-ocp-book-link: {product-docs-link}/html-single/installing_rhdh_with_orchestrator_plugin_on_{ocp-short}_using_operator_in_an_air-gapped_environment/index
146-
:integrating-with-github-book-title: Integrating {product} with GitHub
143+
:installing-rhdh-orch-on-ocp-book-title: Installing RHDH with the Orchestrator Plugin on {ocp-short} using the {product} Operator
147144
:integrating-with-github-book-link: {product-docs-link}/html-single/integrating_red_hat_developer_hub_with_github/index
148-
:introduction-to-plugins-book-title: Introduction to plugins
145+
:integrating-with-github-book-title: Integrating {product} with GitHub
149146
:introduction-to-plugins-book-link: {product-docs-link}/html-single/introduction_to_plugins/index
150-
:monitoring-and-logging-book-title: Monitoring and logging
147+
:introduction-to-plugins-book-title: Introduction to plugins
151148
:monitoring-and-logging-book-link: {product-docs-link}/html-single/monitoring_and_logging/index
149+
:monitoring-and-logging-book-title: Monitoring and logging
152150
:observability-category-link: {product-docs-link}/#Observability
153-
:release-notes-book-title: {product} release notes
151+
:ocp-docs-link: link:https://docs.redhat.com/en/documentation/openshift_container_platform/{ocp-version}
152+
:osd-docs-link: link:https://docs.redhat.com/en/documentation/openshift_dedicated/{osd-version}
154153
:release-notes-book-link: {product-docs-link}/html-single/red_hat_developer_hub_release_notes/index
154+
:release-notes-book-title: {product} release notes
155155
:release-notes-category-link: {product-docs-link}/#Release Notes
156-
:techdocs-book-title: TechDocs for {product}
156+
:rhbk-docs-link: link:https://docs.redhat.com/en/documentation/red_hat_build_of_keycloak/{keycloak-version}
157157
:techdocs-book-link: {product-docs-link}/html-single/techdocs_for_red_hat_developer_hub/index
158-
:telemetry-data-collection-book-title: Telemetry data collection
158+
:techdocs-book-title: TechDocs for {product}
159159
:telemetry-data-collection-book-link: {product-docs-link}/html-single/telemetry_data_collection_and_analysis/index
160+
:telemetry-data-collection-book-title: Telemetry data collection
160161
:upgrade-category-link: {product-docs-link}/#Upgrade
161-
:upgrading-book-title: Upgrading {product}
162162
:upgrading-book-link: {product-docs-link}/html-single/upgrading_red_hat_developer_hub/index
163-
:using-dynamic-plugins-book-title: Using dynamic plugins
163+
:upgrading-book-title: Upgrading {product}
164164
:using-dynamic-plugins-book-link: {product-docs-link}/html-single/installing_and_viewing_plugins_in_red_hat_developer_hub/index
165+
:using-dynamic-plugins-book-title: Using dynamic plugins

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

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -9,21 +9,21 @@ To authenticate users with {rhbk-brand-name} ({rhbk}), enable and configure the
99
Alternatively, your {rhbk} administrator can prepare in {rhbk} the required realm and client for you.
1010

1111
.Procedure
12-
. To allow {product-short} to authenticate with {rhbk}, complete the steps in {rhbk}, to link:https://docs.redhat.com/en/documentation/red_hat_build_of_keycloak/26.0/html/getting_started_guide/getting-started-zip-#getting-started-zip-create-a-realm[create a realm and a user] and link:https://docs.redhat.com/en/documentation/red_hat_build_of_keycloak/26.0/html/getting_started_guide/getting-started-zip-#getting-started-zip-secure-the-first-application[secure the first application]:
12+
. To allow {product-short} to authenticate with {rhbk}, complete the steps in {rhbk}, to {rhbk-docs-link}/html/getting_started_guide/getting-started-zip-#getting-started-zip-create-a-realm[create a realm and a user] and {rhbk-docs-link}/html/getting_started_guide/getting-started-zip-#getting-started-zip-secure-the-first-application[secure the first application]:
1313

14-
.. Use an existing realm, or link:https://docs.redhat.com/en/documentation/red_hat_build_of_keycloak/26.0/html/getting_started_guide/getting-started-zip-#getting-started-zip-create-a-realm[create a realm], with a distinctive **Name** such as __<my_realm>__.
14+
.. Use an existing realm, or {rhbk-docs-link}/html/getting_started_guide/getting-started-zip-#getting-started-zip-create-a-realm[create a realm], with a distinctive **Name** such as __<my_realm>__.
1515
Save the value for the next step:
1616
* **{rhbk} realm base URL**, such as: __<your_rhbk_URL>__/realms/__<your_realm>__.
1717

18-
.. To register your {product-short} in {rhbk}, in the created realm, link:https://docs.redhat.com/en/documentation/red_hat_build_of_keycloak/26.0/html-single/getting_started_guide/index#getting-started-zip-secure-the-first-application[secure the first application], with:
18+
.. To register your {product-short} in {rhbk}, in the created realm, {rhbk-docs-link}/html-single/getting_started_guide/index#getting-started-zip-secure-the-first-application[secure the first application], with:
1919
... **Client ID**: A distinctive client ID, such as __<{product-very-short}>__.
2020
... **Valid redirect URIs**: Set to the OIDC handler URL: `https://__<RHDH_URL>__/api/auth/oidc/handler/frame`.
2121
... Navigate to the **Credentials** tab and copy the **Client secret**.
2222
... Save the values for the next step:
2323
* **Client ID**
2424
* **Client Secret**
2525

26-
.. 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_build_of_keycloak/26.0/html-single/getting_started_guide/index#getting-started-zip-create-a-user[create a user]. Save the user credential information for the verification steps.
26+
.. To prepare for the verification steps, in the same realm, get the credential information for an existing user or {rhbk-docs-link}/html-single/getting_started_guide/index#getting-started-zip-create-a-user[create a user]. Save the user credential information for the verification steps.
2727

2828
. To add your {rhsso} credentials to {product-short}, add the following key/value pairs to {configuring-dynamic-plugins-book-link}#provisioning-your-custom-configuration[your {product-short} secrets].
2929
You can use these secrets in the {product-short} configuration files by using their respective environment variable name.

0 commit comments

Comments
 (0)