fix broken links, use attributes

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

Author: themr0c

modules/authentication/proc-authenticationg-with-the-guest-user-on-a-helm-based-installation.adoc

@@ -5,10 +5,11 @@
 On a Helm-based installation, you can configure {product-short} to log in as a Guest user and access {product-short} features.
 
 .Prerequisites
-* You link:https://docs.redhat.com/en/documentation/red_hat_developer_hub/{product-version}#Install%20and%20Upgrade[Installed {product-short} by using the Helm Chart].
+* You link:{configuring-book-url}[added a custom {product-short} application configuration], and have sufficient permissions to modify it.
+* You link:{configuring-book-url}#using-the-helm-chart-to-run-rhdh-with-your-custom-configuration[use the {product} Helm chart to run  {product-short}].
 
 .Procedure
-* To enable the guest user in your {product-short} custom configuration, link:https://docs.redhat.com/en/documentation/red_hat_developer_hub/{product-version}/html-single/administration_guide_for_red_hat_developer_hub/index#proc-add-custom-app-file-openshift-helm_admin-rhdh[configure your {product} Helm Chart] with following content:
+* To enable the guest user in your {product-short} custom configuration, link:{configuring-book-url}#using-the-helm-chart-to-run-rhdh-with-your-custom-configuration[configure your {product} Helm Chart] with following content:
 +
 .{product} Helm Chart configuration fragment
 [source,yaml]

modules/authentication/proc-authenticationg-with-the-guest-user-on-an-operator-based-installation.adoc

@@ -9,9 +9,9 @@ After an Operator-based installation, you can configure {product-short} to log i
 * You link:{configuring-book-url}[added a custom {product-short} application configuration], and have sufficient permissions to modify it.
 
 .Procedure
-* To enable the guest user in your {product-short} custom configuration, link:https://docs.redhat.com/en/documentation/red_hat_developer_hub/{product-version}/html-single/administration_guide_for_red_hat_developer_hub/index#proc-add-custom-app-config-file-ocp-operator_admin-rhdh[edit your {product-short} application configuration] with following content:
+* To enable the guest user in your {product-short} custom configuration, link:{configuring-book-url}#provisioning-your-custom-configuration[edit your {product-short} application configuration] with following content:
 +
-.`app-config-rhdh.yaml` fragment
+.`{my-app-config-file}` fragment
 [source,yaml]
 ----
 auth:

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

@@ -36,10 +36,10 @@ Save the value for the next step:
 `AUTH_OIDC_CLIENT_SECRET`:: Enter the saved **Client Secret**.
 `AUTH_OIDC_METADATA_URL`:: Enter the saved **{rhbk} realm base URL**.
 
-. To set up the {rhbk} 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 {rhbk} 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 `{my-app-config-file}` content:
 +
 --
-.`app-config-rhdh.yaml` fragment with mandatory fields to enable authentication with {rhbk}
+.`{my-app-config-file}` fragment with mandatory fields to enable authentication with {rhbk}
 [source,yaml]
 ----
 auth:
@@ -72,7 +72,7 @@ To enable authentication without requiring to provision users in the {product-sh
 +
 WARNING: Use this option to explore {product-short} features, but do not use it in production.
 +
-.`app-config-rhdh.yaml` fragment with optional field to allow authenticating users absent from the software catalog
+.`{my-app-config-file}` fragment with optional field to allow authenticating users absent from the software catalog
 [source,yaml]
 ----
 auth:
@@ -92,7 +92,7 @@ dangerouslyAllowSignInWithoutUserInCatalog: true
 --
 {rhbk} callback URL.
 
-.`app-config-rhdh.yaml` fragment with optional `callbackURL` field
+.`{my-app-config-file}` fragment with optional `callbackURL` field
 [source,yaml]
 ----
 auth:
@@ -107,7 +107,7 @@ auth:
 --
 Token endpoint authentication method.
 
-.`app-config-rhdh.yaml` fragment with optional `tokenEndpointAuthMethod` field
+.`{my-app-config-file}` fragment with optional `tokenEndpointAuthMethod` field
 [source,yaml]
 ----
 auth:
@@ -122,7 +122,7 @@ auth:
 --
 Token signed response algorithm.
 
-.`app-config-rhdh.yaml` fragment with optional `tokenSignedResponseAlg` field
+.`{my-app-config-file}` fragment with optional `tokenSignedResponseAlg` field
 [source,yaml]
 ----
 auth:
@@ -137,7 +137,7 @@ auth:
 --
 {rhbk} scope.
 
-.`app-config-rhdh.yaml` fragment with optional `scope` field
+.`{my-app-config-file}` fragment with optional `scope` field
 [source,yaml]
 ----
 auth:
@@ -153,7 +153,7 @@ auth:
 Declarative resolvers to override the default resolver: `emailLocalPartMatchingUserEntityName`.
 The authentication provider tries each sign-in resolver until it succeeds, and fails if none succeed.
 
-.`app-config-rhdh.yaml` fragment with optional `callbackURL` field
+.`{my-app-config-file}` fragment with optional `callbackURL` field
 [source,yaml]
 ----
 auth:
@@ -172,7 +172,7 @@ auth:
 --
 To modify the {product-short} token expiration from its default value of one hour, note that this refers to the validity of short-term cryptographic tokens, not the session duration. The expiration value must be set between 10 minutes and 24 hours.
 
-.`app-config-rhdh.yaml` fragment with optional `auth.backstageTokenExpiration` field
+.`{my-app-config-file}` fragment with optional `auth.backstageTokenExpiration` field
 [source,yaml,subs="+quotes"]
 ----
 auth:

modules/authentication/proc-provisioning-users-from-github-to-the-software-catalog.adoc

@@ -11,11 +11,11 @@ Consider configuring {product-short} to provision users from GitHub to the softw
 
 .Procedure
 
-* To enable GitHub 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 GitHub member discovery, edit your custom {product-short} ConfigMap, such as `app-config-rhdh`, and add the following lines to the `{my-app-config-file}` content:
 +
 --
 [id=githubProviderId]
-.`app-config.yaml` fragment with mandatory `github` fields
+.`{my-app-config-file}` fragment with mandatory `github` fields
 [source,yaml]
 ----
 dangerouslyAllowSignInWithoutUserInCatalog: false

modules/authentication/proc-provisioning-users-from-microsoft-azure-to-the-software-catalog.adoc

@@ -7,11 +7,11 @@ To authenticate users with Microsoft Azure, after xref:enabling-authentication-w
 * You have xref:enabling-authentication-with-microsoft-azure[enabled authentication with Microsoft Azure].
 
 .Procedure
-* To enable Microsoft Azure member discovery, edit your custom {product-short} ConfigMap, such as `app-config-rhdh`, and add following lines to the `app-config-rhdh.yaml` content:
+* To enable Microsoft Azure member discovery, edit your custom {product-short} ConfigMap, such as `app-config-rhdh`, and add following lines to the `{my-app-config-file}` content:
 +
 --
 [id=microsoftGraphOrgProviderId]
-.`app-config.yaml` fragment with mandatory `microsoftGraphOrg` fields
+.`{my-app-config-file}` fragment with mandatory `microsoftGraphOrg` fields
 [source,yaml]
 ----
 dangerouslyAllowSignInWithoutUserInCatalog: false
@@ -43,7 +43,7 @@ Defines the authority used.
 Change the value to use a different link:https://learn.microsoft.com/en-us/graph/deployments#app-registration-and-token-service-root-endpoints[authority], such as Azure US government.
 Default value: `https://login.microsoftonline.com`.
 +
-.`app-config.yaml` fragment with optional `queryMode` field
+.`{my-app-config-file}` fragment with optional `queryMode` field
 [source,yaml]
 ----
 catalog:
@@ -57,7 +57,7 @@ catalog:
 Certain features require `advanced` querying capabilities.
 See link:https://docs.microsoft.com/en-us/graph/aad-advanced-queries[Microsoft Azure Advanced queries].
 +
-.`app-config.yaml` fragment with optional `queryMode` field
+.`{my-app-config-file}` fragment with optional `queryMode` field
 [source,yaml]
 ----
 catalog:
@@ -74,7 +74,7 @@ Only one relationship can be expanded in a single request.
 See https://docs.microsoft.com/en-us/graph/query-parameters#expand-parameter[Microsoft Graph query expand parameter].
 This parameter can be combined with xref:userGroupMemberFilter[] or xref:userFilter[].
 +
-.`app-config.yaml` fragment with optional `user.expand` field
+.`{my-app-config-file}` fragment with optional `user.expand` field
 [source,yaml]
 ----
 catalog:
@@ -91,7 +91,7 @@ To filter users.
 See link:https://docs.microsoft.com/en-us/graph/api/resources/user?view=graph-rest-1.0#properties[Microsoft Graph API] and link:https://docs.microsoft.com/en-us/graph/query-parameters#filter-parameter[Microsoft Graph API query filter parameters syntax].
 This parameter and xref:userGroupMemberFilter[] are mutually exclusive, only one can be specified.
 +
-.`app-config.yaml` fragment with optional `user.filter` field
+.`{my-app-config-file}` fragment with optional `user.filter` field
 [source,yaml]
 ----
 catalog:
@@ -107,7 +107,7 @@ catalog:
 Load photos by default.
 Set to `false` to not load user photos.
 +
-.`app-config.yaml` fragment with optional `user.loadPhotos` field
+.`{my-app-config-file}` fragment with optional `user.loadPhotos` field
 [source,yaml]
 ----
 catalog:
@@ -122,7 +122,7 @@ catalog:
 `user.select`::
 Define the link:https://docs.microsoft.com/en-us/graph/api/resources/schemaextension?view=graph-rest-1.0[Microsoft Graph resource types] to retrieve.
 +
-.`app-config.yaml` fragment with optional `user.select` field
+.`{my-app-config-file}` fragment with optional `user.select` field
 [source,yaml]
 ----
 catalog:
@@ -139,7 +139,7 @@ To use group membership to get users.
 To filter groups and fetch their members.
 This parameter and xref:userFilter[] are mutually exclusive, only one can be specified.
 +
-.`app-config.yaml` fragment with optional `userGroupMember.filter` field
+.`{my-app-config-file}` fragment with optional `userGroupMember.filter` field
 [source,yaml]
 ----
 catalog:
@@ -156,7 +156,7 @@ To use group membership to get users.
 To search for groups and fetch their members.
 This parameter and xref:userFilter[] are mutually exclusive, only one can be specified.
 +
-.`app-config.yaml` fragment with optional `userGroupMember.search` field
+.`{my-app-config-file}` fragment with optional `userGroupMember.search` field
 [source,yaml]
 ----
 catalog:
@@ -174,7 +174,7 @@ Only one relationship can be expanded in a single request.
 See https://docs.microsoft.com/en-us/graph/query-parameters#expand-parameter
 This parameter can be combined with xref:userGroupMemberFilter[] instead of xref:userFilter[].
 +
-.`app-config.yaml` fragment with optional `group.expand` field
+.`{my-app-config-file}` fragment with optional `group.expand` field
 [source,yaml]
 ----
 catalog:
@@ -190,7 +190,7 @@ catalog:
 To filter groups.
 See link:https://docs.microsoft.com/en-us/graph/api/resources/group?view=graph-rest-1.0#properties[Microsoft Graph API query group syntax].
 +
-.`app-config.yaml` fragment with optional `group.filter` field
+.`{my-app-config-file}` fragment with optional `group.filter` field
 [source,yaml]
 ----
 catalog:
@@ -206,7 +206,7 @@ catalog:
 To search for groups.
 See link:https://docs.microsoft.com/en-us/graph/search-query-parameter[Microsoft Graph API query search parameter].
 +
-.`app-config.yaml` fragment with optional `group.search` field
+.`{my-app-config-file}` fragment with optional `group.search` field
 [source,yaml]
 ----
 catalog:
@@ -221,7 +221,7 @@ catalog:
 `group.select`::
 To define the link:https://docs.microsoft.com/en-us/graph/api/resources/schemaextension?view=graph-rest-1.0[Microsoft Graph resource types] to retrieve.
 +
-.`app-config.yaml` fragment with optional `group.select` field
+.`{my-app-config-file}` fragment with optional `group.select` field
 [source,yaml]
 ----
 catalog:
@@ -236,7 +236,7 @@ catalog:
 To specify custom schedule frequency.
 Supports cron, ISO duration, and "human duration" as used in code.
 +
-.`app-config.yaml` fragment with optional `schedule.frequency` field
+.`{my-app-config-file}` fragment with optional `schedule.frequency` field
 [source,yaml]
 ----
 catalog:
@@ -251,7 +251,7 @@ catalog:
 To specify custom timeout.
 Supports ISO duration and "human duration" as used in code.
 +
-.`app-config.yaml` fragment with optional `schedule.timeout` field
+.`{my-app-config-file}` fragment with optional `schedule.timeout` field
 [source,yaml]
 ----
 catalog:
@@ -266,7 +266,7 @@ catalog:
 To specify custom initial delay.
 Supports ISO duration and "human duration" as used in code.
 +
-.`app-config.yaml` fragment with optional `schedule.initialDelay` field
+.`{my-app-config-file}` fragment with optional `schedule.initialDelay` field
 [source,yaml]
 ----
 catalog:

modules/authentication/proc-provisioning-users-from-rhbk-to-the-software-catalog.adoc

@@ -6,11 +6,11 @@
 
 .Procedure
 
-* To enable {rhbk} 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 {rhbk} member discovery, edit your custom {product-short} ConfigMap, such as `app-config-rhdh`, and add the following lines to the `{my-app-config-file}` content:
 +
 --
 [id=keycloakOrgProviderId]
-.`app-config.yaml` fragment with mandatory `keycloakOrg` fields
+.`{my-app-config-file}` fragment with mandatory `keycloakOrg` fields
 [source,yaml]
 ----
 dangerouslyAllowSignInWithoutUserInCatalog: false
@@ -41,7 +41,7 @@ Optional: Consider adding the following optional fields:
 Realm to synchronize.
 Default value: `master`.
 +
-.`app-config.yaml` fragment with optional `realm` field
+.`{my-app-config-file}` fragment with optional `realm` field
 [source,yaml]
 ----
 catalog:
@@ -55,7 +55,7 @@ catalog:
 Realm used to authenticate.
 Default value: `master`.
 +
-.`app-config.yaml` fragment with optional `loginRealm` field
+.`{my-app-config-file}` fragment with optional `loginRealm` field
 [source,yaml]
 ----
 catalog:
@@ -69,7 +69,7 @@ catalog:
 User number to query simultaneously.
 Default value: `100`.
 +
-.`app-config.yaml` fragment with optional `userQuerySize` field
+.`{my-app-config-file}` fragment with optional `userQuerySize` field
 [source,yaml]
 ----
 catalog:
@@ -83,7 +83,7 @@ catalog:
 Group number to query simultaneously.
 Default value: `100`.
 +
-.`app-config.yaml` fragment with optional `groupQuerySize` field
+.`{my-app-config-file}` fragment with optional `groupQuerySize` field
 [source,yaml]
 ----
 catalog:
@@ -97,7 +97,7 @@ catalog:
 To specify custom schedule frequency.
 Supports cron, ISO duration, and "human duration" as used in code.
 +
-.`app-config.yaml` fragment with optional `schedule.frequency` field
+.`{my-app-config-file}` fragment with optional `schedule.frequency` field
 [source,yaml]
 ----
 catalog:
@@ -112,7 +112,7 @@ catalog:
 To specify custom timeout.
 Supports ISO duration and "human duration" as used in code.
 +
-.`app-config.yaml` fragment with optional `schedule.timeout` field
+.`{my-app-config-file}` fragment with optional `schedule.timeout` field
 [source,yaml]
 ----
 catalog:
@@ -127,7 +127,7 @@ catalog:
 To specify custom initial delay.
 Supports ISO duration and "human duration" as used in code.
 +
-.`app-config.yaml` fragment with optional `schedule.initialDelay` field
+.`{my-app-config-file}` fragment with optional `schedule.initialDelay` field
 [source,yaml]
 ----
 catalog:

modules/authorization/proc-defining-authorizations-in-external-files-by-using-helm.adoc

@@ -91,7 +91,7 @@ configMap::
 defaultMode::: `420`
 name::: `rbac-policies`
 
-. Update your {product-short} `app-config.yaml` configuration file to use the `rbac-policies.csv` and `rbac-conditional-policies.yaml` external files:
+. Update your {product-short} `{my-app-config-file}` configuration file to use the `rbac-policies.csv` and `rbac-conditional-policies.yaml` external files:
 +
 .`app-config.yml` fragment
 [source,yaml]

modules/authorization/proc-determining-permission-policy-and-role-configuration-source.adoc

@@ -8,7 +8,7 @@ You can only use this source to change the resource.
 The available sources are:
 
 Configuration file::
-Configure roles and policies in the {product-short} `app-config.yaml` configuration file, for instance to xref:enabling-and-giving-access-to-rbac[declare your policy administrators].
+Configure roles and policies in the {product-short} `{my-app-config-file}` configuration file, for instance to xref:enabling-and-giving-access-to-rbac[declare your policy administrators].
 +
 The Configuration file pertains to the default `role:default/rbac_admin` role provided by the RBAC plugin.
 The default role has limited permissions to create, read, update, delete permission policies or roles, and to read catalog entities.

modules/authorization/proc-enabling-the-rbac-plugin.adoc

@@ -27,9 +27,9 @@ See link:{installing-and-viewing-dynamic-plugins-url}[{installing-and-viewing-dy
 . Declare policy administrators to enable a select number of authenticated users to configure RBAC policies through the REST API or Web UI, instead of modifying the CSV file directly.
 The permissions can be specified in a separate CSV file referenced in the `app-config-rhdh` ConfigMap, or permissions can be created using the REST API or Web UI.
 +
-To declare users such as _<your_policy_administrator_name>_ as policy administrators, edit your custom {product-short} ConfigMap, such as `app-config-rhdh`, and add following code to the `app-config-rhdh.yaml` content:
+To declare users such as _<your_policy_administrator_name>_ as policy administrators, edit your custom {product-short} ConfigMap, such as `app-config-rhdh`, and add following code to the `{my-app-config-file}` content:
 +
-.`app-config.yaml` fragment
+.`{my-app-config-file}` fragment
 [source,yaml,subs=+quotes]
 ----
 permission:

modules/customizing-the-home-page/proc-customizing-the-home-page-cards.adoc

@@ -51,7 +51,7 @@ dynamicPlugins:
 ----
 
 .Prerequisites
-* You have administrative access and can modify the `app-config.yaml` file for dynamic plugin configurations.
+* You have administrative access and can modify the `{my-app-config-file}` file for dynamic plugin configurations.
 
 .Procedure
 * Configure different cards for your Home page in {product} as follows: