RHDHBUGS-2005 Fixed broken links addendum

assemblies/dynamic-plugins/assembly-extensions-plugins.adoc

@@ -5,7 +5,7 @@ include::{docdir}/artifacts/snip-technology-preview.adoc[]
 
 :context: rhdh-extensions-plugins
 
-{product} ({product-very-short}) includes the Extensions feature which is preinstalled and enabled by default. Extensions provides users with a centralized interface to browse and manage available plugins 
+{product} ({product-very-short}) includes the Extensions feature which is preinstalled and enabled by default. Extensions provides users with a centralized interface to browse and manage available plugins
 
 You can use Extensions to discover plugins that extend {product-very-short} functionality, streamline development workflows, and improve the developer experience.
 
@@ -21,21 +21,21 @@ include::../modules/dynamic-plugins/con-catalog-searching-and-filtering.adoc[lev
 // Viewing a plugin - screenshots added post 1.5 GA, so this section is no longer necessary
 // include::../modules/dynamic-plugins/ref-catalog-plugin.adoc[leveloffset=+2]
 
-// Disabling Extensions 
+// Disabling Extensions
 include::../modules/dynamic-plugins/proc-extensions-disabling.adoc[leveloffset=+1]
 
-// START RHDH 1.7.0
+// START {product-very-short} 1.7.0
 // ==========
 // Managing plugins installation by using Extensions
 include::../modules/dynamic-plugins/con-extensions-managing-plugins.adoc[leveloffset=+1]
 
-// Configuring an RBAC role to manage Extensions 
+// Configuring an RBAC role to manage Extensions
 include::../modules/dynamic-plugins/proc-extensions-configuring-rbac-role.adoc[leveloffset=+2]
 
 // Enabling plugins installation by using Extensions
 include::../modules/dynamic-plugins/proc-extensions-enabling-plugins-installation.adoc[leveloffset=+2]
 
-// Enabling plugins in a RHDH Local installation by using Extensions
+// Enabling plugins in a {product-very-short} Local installation by using Extensions
 include::../modules/dynamic-plugins/proc-extensions-enabling-plugins-installation-rhdh-local.adoc[leveloffset=+2]
 
 // Installing plugins by using Extensions
@@ -48,7 +48,7 @@ include::../modules/dynamic-plugins/proc-extensions-configuring-plugins.adoc[lev
 // include::../modules/dynamic-plugins/con-extensions-troubleshooting-plugins-installation.adoc[leveloffset=+1]
 // ==========
 
-// END RHDH 1.7.0
+// END {product-very-short} 1.7.0
 
 // Operator installation by using plugin extension
 //include::../modules/dynamic-plugins/proc-operator-installing-a-plugin-using-extensions.adoc[leveloffset=+1]
@@ -57,4 +57,4 @@ include::../modules/dynamic-plugins/proc-extensions-configuring-plugins.adoc[lev
 //include::../modules/dynamic-plugins/proc-extensions-managing.adoc[leveloffset=+1]
 
 // Creating the extensions plugin metadata - For 1.6+
-//include::../modules/dynamic-plugins/proc-extensions-creating.adoc[leveloffset=+1]
+//include::../modules/dynamic-plugins/proc-extensions-creating.adoc[leveloffset=+1]

modules/about/ref-customer-support-info.adoc

@@ -1,5 +1,5 @@
 [id="ref-customer-support-info_{context}"]
-= Red Hat Developer Hub support
+= {product} support
 
 If you experience difficulty with a procedure described in this documentation, visit the https://access.redhat.com[Red Hat Customer Portal]. You can use the Red Hat Customer Portal for the following purposes:
 

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

@@ -6,7 +6,7 @@ On a Helm-based installation, you can configure {product-short} to log in as a G
 
 .Prerequisites
 * You {configuring-book-link}[added a custom {product-short} application configuration], and have sufficient permissions to modify it.
-* You {configuring-book-link}#using-the-helm-chart-to-run-rhdh-with-your-custom-configuration[use the {product} Helm chart to run  {product-short}].
+* You {configuring-book-link}#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, {configuring-book-link}#using-the-helm-chart-to-run-rhdh-with-your-custom-configuration[configure your {product} Helm Chart] with following content:

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

@@ -6,7 +6,7 @@ After an Operator-based installation, you can configure {product-short} to log i
 
 .Prerequisites
 * You {configuring-book-link}[added a custom {product-short} application configuration], and have sufficient permissions to modify it.
-* You {configuring-book-link}#using-the-operator-to-run-rhdh-with-your-custom-configurationn[use the {product} Operator to run  {product-short}].
+* You {configuring-book-link}#using-the-operator-to-run-rhdh-with-your-custom-configurationn[use the {product} Operator to run {product-short}].
 
 .Procedure
 * To enable the guest user in your {product-short} custom configuration, {configuring-book-link}#provisioning-your-custom-configuration[edit your {product-short} application configuration] with following content:

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

@@ -18,7 +18,7 @@ Save the value for the next step:
 
 .. 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:
 ... **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`.
+... **Valid redirect URIs**: Set to the OIDC handler URL: `pass:c,a,q[{my-product-url}/api/auth/oidc/handler/frame]`.
 ... Navigate to the **Credentials** tab and copy the **Client secret**.
 ... Save the values for the next step:
 * **Client ID**

modules/configuring-the-global-header/con-quicklinks-and-starred-items-in-global-header.adoc

@@ -33,15 +33,15 @@ The default configuration includes the following components:
 
 *MenuItemLink entries*: Define sections, titles, icons, and links within the *Quicklinks* matrix. The default configuration includes links to the {product-short} documentation and an {product-very-short} Local, as shown in the following configurations:
 
-[source,yaml]
+[source,yaml,subs="+attributes"]
 ----
 - mountPoint: global.header/application-launcher
   importName: MenuItemLink
   config:
     section: Documentation
     priority: 150
     props:
-      title: Developer Hub
+      title: {product-short}
       icon: developerHub
       link: https://docs.redhat.com/en/documentation/red_hat_developer_hub
 

modules/configuring-the-global-header/proc-enabling-quicklinks-starred-items-after-upgrade.adoc

@@ -28,7 +28,7 @@ Confirm that you listed the `red-hat-developer-hub-backstage-plugin-global-heade
 
 . Add the required components. Under the `mountPoints` section of the plugin, add the components as shown in the following example:
 +
-[source,yaml]
+[source,yaml,subs="+attributes"]
 ----
   mountPoints:
     - mountPoint: application/header
@@ -49,7 +49,7 @@ Confirm that you listed the `red-hat-developer-hub-backstage-plugin-global-heade
         section: Documentation
       priority: 150
       props:
-          title: Developer Hub
+          title: {product-short}
           icon: developerHub
           link: https://docs.redhat.com/en/documentation/red_hat_developer_hub
     - mountPoint: global.header/application-launcher

modules/configuring-the-quickstarts/proc-customize-rhdh-quickstart.adoc

@@ -1,21 +1,21 @@
 [id="customizing-your-product-quickstart_{context}"]
 = Customizing your {product} Quickstart
 
-As an administrator, you can configure the {product} Quickstart plugin to create customized onboarding for your {product-short} users. 
+As an administrator, you can configure the {product} Quickstart plugin to create customized onboarding for your {product-short} users.
 
 .Prerequisites
 You must have administrator permissions.
 
 .Procedure
 . Update your `{my-app-config-file}`, as follows:
 +
-.Example of a customized Quickstart plugin 
-[source,yaml]
+.Example of a customized Quickstart plugin
+[source,yaml,subs="+attributes"]
 ----
 app:
   quickstart:
-    - title: 'Welcome to Developer Hub' # <1>
-      description: 'Learn the basics of navigating the Developer Hub interface' # <2>
+    - title: 'Welcome to {product-short}' # <1>
+      description: 'Learn the basics of navigating the {product-short} interface' # <2>
       icon: 'home' # <3>
       cta:
         text: 'Get Started' # <4>
@@ -52,4 +52,4 @@ global:
     plugins:
       - package: ./dynamic-plugins/dist/red-hat-developer-hub-backstage-plugin-quickstart
         disabled: true
-----
+----

modules/customizing-the-quick-access-card/proc-using-a-dedicated-service-to-provide-data-to-the-quick-access-card.adoc

@@ -15,7 +15,7 @@ When using a dedicated service, you can do the following tasks:
 .Prerequisites
 
 * You have installed the {product} using Helm chart.
-For more information, see xref:{installing-on-ocp-book-link}#assembly-install-rhdh-ocp-helm[{installing-on-ocp-book-title} with the Helm chart].
+For more information, see {installing-on-ocp-book-link}#assembly-install-rhdh-ocp-helm[{installing-on-ocp-book-title} with the Helm chart].
 
 .Procedure
 
@@ -120,7 +120,7 @@ metadata:
 data:
   {my-app-config-file}: |
     app:
-      title: Red Hat Developer Hub
+      title: {product}
     backend:
       csp:
         connect-src:

modules/customizing-the-quick-access-card/proc-using-hosted-json-files-to-provide-data-to-the-quick-access-card.adoc

@@ -9,7 +9,7 @@
 .Prerequisites
 
 * You have installed {product} by using either the Operator or Helm chart.
-See xref:{installing-on-ocp-book-link}#assembly-install-rhdh-ocp[{installing-on-ocp-book-title}].
+See {installing-on-ocp-book-link}#assembly-install-rhdh-ocp[{installing-on-ocp-book-title}].
 
 .Procedure
 

modules/developer-lightspeed/proc-installing-and-configuring-lightspeed.adoc

@@ -79,7 +79,7 @@ Create a dedicated {ls-short} ConfigMap instead of adding an additional section
 .. Click *Create ConfigMap*.
 .. From the *Create ConfigMap* page, select the *YAML view* option in *Configure via*, and add the following example:
 +
-[source,yaml,subs=+attributes]
+[source,yaml,subs="+attributes"]
 ----
 kind: ConfigMap
 apiVersion: v1
@@ -115,14 +115,14 @@ data:
       # OPTIONAL: Custom users prompts displayed to users
       # If not provided, the plugin uses built-in default prompts
       prompts:
-        - title: 'Getting Started with Red Hat Developer Hub'
-          message: Can you guide me through the first steps to start using Developer Hub as a developer, like exploring the Software Catalog and adding my service?
+        - title: 'Getting Started with {product}'
+          message: Can you guide me through the first steps to start using {product-short} as a developer, like exploring the Software Catalog and adding my service?
 
       # OPTIONAL: Port for lightspeed service (default: 8080)
       # servicePort: ${LIGHTSPEED_SERVICE_PORT}
 
       # OPTIONAL: Override default RHDH system prompt
-      # systemPrompt: "You are a helpful assistant focused on Red Hat Developer Hub development."
+      # systemPrompt: "You are a helpful assistant focused on {product} development."
 ----
 . Create {ls-short} secret file.
 .. In the {ocp-short} web console, go to *Secrets*.
@@ -146,7 +146,7 @@ type: Opaque
 
 . To your existing dynamic plugins ConfigMap (for example, `dynamic-plugins-rhdh.yaml`), add the {ls-short} plugin image as shown in the following example:
 +
-[source,yaml]
+[source,yaml,subs="+attributes"]
 ----
 includes:
   - dynamic-plugins.default.yaml
@@ -158,8 +158,8 @@ includes:
         # OPTIONAL: Custom users prompts displayed to users
         # If not provided, the plugin uses built-in default prompts
         prompts:
-          - title: 'Getting Started with Red Hat Developer Hub'
-            message: Can you guide me through the first steps to start using Developer Hub
+          - title: 'Getting Started with {product}'
+            message: Can you guide me through the first steps to start using {product-short}
               as a developer, like exploring the Software Catalog and adding my
               service?
       dynamicPlugins:
@@ -285,11 +285,11 @@ spec:
               - env:
                   - name: PROJECT
                     value: rhdh
-# Mounting the RCS sidecar to your RHDH instance
+# Mounting the RCS sidecar to your {product-very-short} instance
                   - name: RCS_CONFIG_FILE
                     value: /app-root/config/rcsconfig.yaml
-# Your existing RHDH ConfigMap
-                  - name: RHDH_CONFIG_FILE
+# Your existing {product-very-short} ConfigMap
+                  - name: {product-very-short}_CONFIG_FILE
                     value: /app-root/config/app-config-rhdh.yaml
                 envFrom:
                   - secretRef:
@@ -301,7 +301,7 @@ spec:
                     name: rcs-backend
                     protocol: TCP
                 volumeMounts:
-# Mounting the RCS sidecar to your RHDH instance
+# Mounting the RCS sidecar to your {product-very-short} instance
                   - mountPath: /app-root/config/rcsconfig.yaml
                     name: rcsconfig
                     subPath: rcsconfig.yaml
@@ -318,7 +318,7 @@ spec:
 .. For a Helm-installed {product-very-short} instance, update your Helm chart.
 ... Add your dynamic plugins configuration in the`global.dynamic` property as shown in the following example:
 +
-[source,yaml]
+[source,yaml,subs="+attributes"]
 ----
 global:
 dynamic:
@@ -332,8 +332,8 @@ dynamic:
         # OPTIONAL: Custom users prompts displayed to users
         # If not provided, the plugin uses built-in default prompts
         prompts:
-          - title: 'Getting Started with Red Hat Developer Hub'
-            message: Can you guide me through the first steps to start using Developer Hub
+          - title: 'Getting Started with {product}'
+            message: Can you guide me through the first steps to start using {product-short}
               as a developer, like exploring the Software Catalog and adding my
               service?
       dynamicPlugins:
@@ -396,15 +396,15 @@ extraVolumes:
 ----
 ... Add the {rcs-short} image as shown in the following example:
 +
-[source,yaml]
+[source,yaml,subs="+attributes"]
 ----
    extraContainers:
       - env:
           - name: PROJECT
             value: rhdh
           - name: RCS_CONFIG_FILE
             value: /app-root/config/rcsconfig.yaml
-          - name: RHDH_CONFIG_FILE
+          - name: {product-very-short}_CONFIG_FILE
             value: /app-root/config/lightspeed-app-config.yaml
         envFrom:
           - secretRef:
@@ -432,7 +432,7 @@ Your {product-very-short} container is typically already present in your Helm ch
 ... Click *Helm upgrade*.
 +
 .Example of a Helm chart with the RCS container
-[source,yaml]
+[source,yaml,subs="+attributes"]
 ----
 global:
  ...
@@ -451,7 +451,7 @@ upstream:
            value: rhdh
          - name: RCS_CONFIG_FILE
            value: /app-root/config/rcsconfig.yaml
-         - name: RHDH_CONFIG_FILE
+         - name: {product-very-short}_CONFIG_FILE
            value: /app-root/config/lightspeed-app-config.yaml
        envFrom:
          - secretRef:

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
-{ansible-automation-platform-docs-link}/html-single/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-single/installing_ansible_plug-ins_for_red_hat_developer_hub/index[_Installing Ansible plug-ins for {product}_].
 

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
-{ansible-automation-platform-docs-link}/html-single/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-single/using_ansible_plug-ins_for_red_hat_developer_hub/index[_Using Ansible plug-ins for {product}_].
 

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
-{ansible-automation-platform-docs-link}/html-single/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-single/installing_ansible_plug-ins_for_red_hat_developer_hub/index[_Installing Ansible plug-ins for {product}_].
 
 == For users
 
 To use the Ansible plugins, see
-{ansible-automation-platform-docs-link}/html-single/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-single/using_ansible_plug-ins_for_red_hat_developer_hub/index[_Using Ansible plug-ins for {product}_].
 

modules/dynamic-plugins/proc-extensions-creating.adoc

@@ -8,7 +8,7 @@ You can add your own plugin metadata to Extensions.
 .Procedure
 . Update plugin metadata file, as follows:
 +
-[source,yaml]
+[source,yaml,subs="+attributes"]
 ----
 # yaml-language-server: $schema=https://raw.githubusercontent.com/redhat-developer/rhdh-plugins/refs/heads/main/workspaces/marketplace/json-schema/plugins.json
 apiVersion: extensions.backstage.io/v1alpha1
@@ -27,7 +27,7 @@ metadata:
       url: https://red.ht/rhdh
     - title: Bugs
       url: https://issues.redhat.com/browse/RHIDP
-    - title: Documentation for Red Hat Developer Hub
+    - title: Documentation for {product}
       url: https://docs.redhat.com/en/documentation/red_hat_developer_hub
     - title: Source Code
       url: https://github.com/backstage/community-plugins/tree/main/workspaces/github-issues/plugins/github-issues
@@ -91,15 +91,15 @@ spec:
 
     **Issues are sorted from the recently updated DESC order (the plugin might not render all issues from a single repo next to each other).**
 
-    ## Adding The Plugin To Red Hat Developer Hub
+    ## Adding The Plugin To {product}
 
-    See the [Red Hat Developer Hub documentation](https://docs.redhat.com/en/documentation/red_hat_developer_hub)
+    See the [{product} documentation](https://docs.redhat.com/en/documentation/red_hat_developer_hub)
     for further instructions on how to add, enable, configure, and remove plugins in your instance.
 
     ## Configuring The Plugin ##
 
     Plugins often need additional configuration to work correctly - particularly those that integrate with other
-    systems. See the original source code repository, the software vendor, or the [Red Hat Developer Hub documentation](https://docs.redhat.com/en/documentation/red_hat_developer_hub)
+    systems. See the original source code repository, the software vendor, or the [{product} documentation](https://docs.redhat.com/en/documentation/red_hat_developer_hub)
     for further details regarding the configuration required.
 
   packages:

modules/dynamic-plugins/proc-linking-to-source-code-editor-or-source.adoc

@@ -28,6 +28,6 @@ If Red Hat OpenShift Dev Spaces is installed and configured and Git URL annotati
 When you deploy your application using the OCP Git import flows, then you do not need to add the labels as import flows do that. Otherwise, you need to add the labels manually to the workload YAML file.
 ====
 
-//The labels are not similar to `backstage.io/edit-link` annotations as it points to the catalog entity metadata source file and is applied to RHDH catalog entity metadata YAML file, but not Kubernetes resources.
+//The labels are not similar to `backstage.io/edit-link` annotations as it points to the catalog entity metadata source file and is applied to {product-very-short} catalog entity metadata YAML file, but not Kubernetes resources.
 
 You can also add the `app.openshift.io/edit-link` annotation with the edit URL that you want to access using the decorator.