From 705166c37c836eb1e328a3644c1c779dab421590 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Fabrice=20Flore-Th=C3=A9bault?= Date: Tue, 9 Sep 2025 12:06:01 +0200 Subject: [PATCH 01/11] Used the product attribute consistently MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Signed-off-by: Fabrice Flore-Thébault --- modules/about/ref-customer-support-info.adoc | 2 +- ...ice-to-provide-data-to-the-quick-access-card.adoc | 2 +- .../proc-installing-and-configuring-lightspeed.adoc | 12 ++++++------ .../dynamic-plugins/con-ansible-plugin-admin.adoc | 2 +- modules/dynamic-plugins/con-ansible-plugin-user.adoc | 2 +- modules/dynamic-plugins/con-ansible-plugin.adoc | 4 ++-- .../dynamic-plugins/proc-extensions-creating.adoc | 10 +++++----- ...enabling-the-bulk-import-from-github-feature.adoc | 2 +- .../installation/proc-deploy-rhdh-instance-gke.adoc | 2 +- .../proc-install-create-custom-flavor.adoc | 4 ++-- .../installation/proc-install-rhdh-ocp-helm-gui.adoc | 1 - .../installation/proc-rhdh-deploy-aks-operator.adoc | 2 +- .../ref-release-notes-new-features.adoc | 2 +- .../proc-techdocs-addon-install-third-party.adoc | 2 +- 14 files changed, 24 insertions(+), 25 deletions(-) diff --git a/modules/about/ref-customer-support-info.adoc b/modules/about/ref-customer-support-info.adoc index d55a54c42f..99d9258eb1 100644 --- a/modules/about/ref-customer-support-info.adoc +++ b/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: diff --git a/modules/customizing-the-quick-access-card/proc-using-a-dedicated-service-to-provide-data-to-the-quick-access-card.adoc b/modules/customizing-the-quick-access-card/proc-using-a-dedicated-service-to-provide-data-to-the-quick-access-card.adoc index 26edb3ed55..5093ea5ec4 100644 --- a/modules/customizing-the-quick-access-card/proc-using-a-dedicated-service-to-provide-data-to-the-quick-access-card.adoc +++ b/modules/customizing-the-quick-access-card/proc-using-a-dedicated-service-to-provide-data-to-the-quick-access-card.adoc @@ -120,7 +120,7 @@ metadata: data: {my-app-config-file}: | app: - title: Red Hat Developer Hub + title: {product} backend: csp: connect-src: diff --git a/modules/developer-lightspeed/proc-installing-and-configuring-lightspeed.adoc b/modules/developer-lightspeed/proc-installing-and-configuring-lightspeed.adoc index 85125c85f1..7d9073b664 100644 --- a/modules/developer-lightspeed/proc-installing-and-configuring-lightspeed.adoc +++ b/modules/developer-lightspeed/proc-installing-and-configuring-lightspeed.adoc @@ -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' + - title: 'Getting Started with {product}' 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? # 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,7 +158,7 @@ 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' + - title: 'Getting Started with {product}' 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? @@ -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,7 +332,7 @@ 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' + - title: 'Getting Started with {product}' 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? diff --git a/modules/dynamic-plugins/con-ansible-plugin-admin.adoc b/modules/dynamic-plugins/con-ansible-plugin-admin.adoc index e2ac1461e5..739213e91b 100644 --- a/modules/dynamic-plugins/con-ansible-plugin-admin.adoc +++ b/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}_]. diff --git a/modules/dynamic-plugins/con-ansible-plugin-user.adoc b/modules/dynamic-plugins/con-ansible-plugin-user.adoc index 99090e5d11..25df8205ed 100644 --- a/modules/dynamic-plugins/con-ansible-plugin-user.adoc +++ b/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}_]. diff --git a/modules/dynamic-plugins/con-ansible-plugin.adoc b/modules/dynamic-plugins/con-ansible-plugin.adoc index d69d5d817b..d2b846690a 100644 --- a/modules/dynamic-plugins/con-ansible-plugin.adoc +++ b/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}_]. diff --git a/modules/dynamic-plugins/proc-extensions-creating.adoc b/modules/dynamic-plugins/proc-extensions-creating.adoc index 0dc545040a..5979d1dfd0 100644 --- a/modules/dynamic-plugins/proc-extensions-creating.adoc +++ b/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: diff --git a/modules/importing-repositories/procedure-enabling-the-bulk-import-from-github-feature.adoc b/modules/importing-repositories/procedure-enabling-the-bulk-import-from-github-feature.adoc index 1817b3ad7e..47836cf434 100644 --- a/modules/importing-repositories/procedure-enabling-the-bulk-import-from-github-feature.adoc +++ b/modules/importing-repositories/procedure-enabling-the-bulk-import-from-github-feature.adoc @@ -32,7 +32,7 @@ p, role:default/bulk-import, bulk.import, use, allow g, user:default/____, role:default/bulk-import ---- + -Note that only {product-short} administrators or users with the `bulk.import` permission can use the Bulk Import feature. See {authorization-book-link}#ref-rbac-permission-policies_title-authorization[Permission policies in Red Hat Developer Hub]. +Note that only {product-short} administrators or users with the `bulk.import` permission can use the Bulk Import feature. See {authorization-book-link}#ref-rbac-permission-policies_title-authorization[Permission policies in {product}]. .Verification * The sidebar displays a *Bulk Import* option. diff --git a/modules/installation/proc-deploy-rhdh-instance-gke.adoc b/modules/installation/proc-deploy-rhdh-instance-gke.adoc index 2a047eb00e..ebb2a211d1 100644 --- a/modules/installation/proc-deploy-rhdh-instance-gke.adoc +++ b/modules/installation/proc-deploy-rhdh-instance-gke.adoc @@ -30,7 +30,7 @@ metadata: data: "{my-app-config-file}": | app: - title: Red Hat Developer Hub + title: {product} baseUrl: {my-product-url} backend: auth: diff --git a/modules/installation/proc-install-create-custom-flavor.adoc b/modules/installation/proc-install-create-custom-flavor.adoc index 294e8ff35a..c2f6dd1d18 100644 --- a/modules/installation/proc-install-create-custom-flavor.adoc +++ b/modules/installation/proc-install-create-custom-flavor.adoc @@ -30,7 +30,7 @@ where _kustomize.yaml_:: This is your flavor's manifest file that acts as the central definition, orchestrating the application of all other files in the directory. -_config/_:: Contains the core app-config.yaml for Red Hat Developer Hub, along with any plugin-specific configuration files. +_config/_:: Contains the core app-config.yaml for {product}, along with any plugin-specific configuration files. _resources/_:: Holds additional Kubernetes resources your flavor needs. This can include CRDs for dependencies or initial catalog entities to populate {product-very-short}. @@ -40,4 +40,4 @@ _hooks/_:: Contains manifests for Kubernetes jobs that run before (pre-install) . (Optional) For dependencies that require operators or other infrastructure, specify them in the _plugin-infra_ directory. -. (Optional) Write Kubernetes job manifests for any pre-installation or post-installation tasks. The Operator will execute these jobs and monitor their status. \ No newline at end of file +. (Optional) Write Kubernetes job manifests for any pre-installation or post-installation tasks. The Operator will execute these jobs and monitor their status. diff --git a/modules/installation/proc-install-rhdh-ocp-helm-gui.adoc b/modules/installation/proc-install-rhdh-ocp-helm-gui.adoc index 00ae9ef92d..2662bceb11 100644 --- a/modules/installation/proc-install-rhdh-ocp-helm-gui.adoc +++ b/modules/installation/proc-install-rhdh-ocp-helm-gui.adoc @@ -45,7 +45,6 @@ global: backend: enabled: true clusterRouterBase: apps..com - # other Red Hat Developer Hub Helm Chart configurations ---- + . Edit the other values if needed. diff --git a/modules/installation/proc-rhdh-deploy-aks-operator.adoc b/modules/installation/proc-rhdh-deploy-aks-operator.adoc index 4d60ecc404..40dd92c871 100644 --- a/modules/installation/proc-rhdh-deploy-aks-operator.adoc +++ b/modules/installation/proc-rhdh-deploy-aks-operator.adoc @@ -101,7 +101,7 @@ metadata: data: "{my-app-config-file}": | app: - title: Red Hat Developer Hub + title: {product} baseUrl: https:// backend: auth: diff --git a/modules/release-notes/ref-release-notes-new-features.adoc b/modules/release-notes/ref-release-notes-new-features.adoc index 66f5fd7b45..6dae2d9575 100644 --- a/modules/release-notes/ref-release-notes-new-features.adoc +++ b/modules/release-notes/ref-release-notes-new-features.adoc @@ -81,7 +81,7 @@ Scaffolder templates can now be versioned using the backstage.io/template-versio {product} now supports high availability setups in {eks-brand-name} ({eks-short}). This enhancement allows the deployment to scale beyond a single replica, ensuring the application remains operational and accessible even in the event of failures or disruptions. -For more information, see {configuring-book-link}#HighAvailability[_Configuring high availability in Red Hat Developer Hub_]. +For more information, see {configuring-book-link}#HighAvailability[_Configuring high availability in {product}_]. [id="feature-rhidp-7610"] == Adoption Insights in {product} diff --git a/modules/techdocs/proc-techdocs-addon-install-third-party.adoc b/modules/techdocs/proc-techdocs-addon-install-third-party.adoc index 2363c7e118..33ae7112db 100644 --- a/modules/techdocs/proc-techdocs-addon-install-third-party.adoc +++ b/modules/techdocs/proc-techdocs-addon-install-third-party.adoc @@ -10,7 +10,7 @@ You can install compatible third-party TechDocs add-on on your {product} instanc .Prerequisites * The third-party TechDocs add-on has a valid `package.json` file in its root directory, containing all required metadata and dependencies. -* The third-party plugin is packaged as a dynamic plugin in an OCI image. For alternative package types, see link:https://redhat-developer.github.io/red-hat-developers-documentation-rhdh/release-1.5/plugins-rhdh-install/#assembly-install-third-party-plugins-rhdh[Installing third-party plugins in Red Hat Developer Hub]. +* The third-party plugin is packaged as a dynamic plugin in an OCI image. For alternative package types, see link:https://redhat-developer.github.io/red-hat-developers-documentation-rhdh/release-1.5/plugins-rhdh-install/#assembly-install-third-party-plugins-rhdh[Installing third-party plugins in {product}]. * You have installed the `yarn` package manager. * The third-party plugin is packaged as a dynamic plugin in an OCI image.* You have installed and configured Node.js and NPM. From 11e04f18e88457ff3834d6c3b3d5acee665ddece Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Fabrice=20Flore-Th=C3=A9bault?= Date: Tue, 9 Sep 2025 12:12:48 +0200 Subject: [PATCH 02/11] Replaces double space MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Signed-off-by: Fabrice Flore-Thébault --- ...ationg-with-the-guest-user-on-a-helm-based-installation.adoc | 2 +- ...g-with-the-guest-user-on-an-operator-based-installation.adoc | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/modules/authentication/proc-authenticationg-with-the-guest-user-on-a-helm-based-installation.adoc b/modules/authentication/proc-authenticationg-with-the-guest-user-on-a-helm-based-installation.adoc index 3f9cafcd83..4a084a853c 100644 --- a/modules/authentication/proc-authenticationg-with-the-guest-user-on-a-helm-based-installation.adoc +++ b/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: diff --git a/modules/authentication/proc-authenticationg-with-the-guest-user-on-an-operator-based-installation.adoc b/modules/authentication/proc-authenticationg-with-the-guest-user-on-an-operator-based-installation.adoc index d596c81836..468e56407b 100644 --- a/modules/authentication/proc-authenticationg-with-the-guest-user-on-an-operator-based-installation.adoc +++ b/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: From 844dc1da13e7a8c1a2f505be3d5f0113809aee7c Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Fabrice=20Flore-Th=C3=A9bault?= Date: Tue, 9 Sep 2025 12:15:04 +0200 Subject: [PATCH 03/11] Fixed leftover after replacing link by attribute MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Signed-off-by: Fabrice Flore-Thébault --- .../proc-install-rhdh-operator-airgapped-partial.adoc | 2 +- modules/observe/con-audit-log-config.adoc | 4 ++-- 2 files changed, 3 insertions(+), 3 deletions(-) diff --git a/modules/installation/proc-install-rhdh-operator-airgapped-partial.adoc b/modules/installation/proc-install-rhdh-operator-airgapped-partial.adoc index 4efd474b02..b54942e566 100644 --- a/modules/installation/proc-install-rhdh-operator-airgapped-partial.adoc +++ b/modules/installation/proc-install-rhdh-operator-airgapped-partial.adoc @@ -21,7 +21,7 @@ When connected to a {ocp-short} cluster, the helper script detects it and automa * You have installed `umoci` CLI tool. * You have an active `oc registry`, `podman`, or `skopeo` session to the `registry.redhat.io` {company-name} Ecosystem Catalog. For more information, see link:link:https://access.redhat.com/articles/RegistryAuthentication[{company-name} Container Registry Authentication]. * You have an active `skopeo` session with administrative access to the target mirror registry. For more information, see link:https://github.com/containers/skopeo#authenticating-to-a-registry[Authenticating to a registry]. -* You have installed the `opm` CLI tool. For more information, see link:{ocp-docs-link}/html/cli_tools/opm-cli#olm-about-opm_cli-opm-install[Installing the opm CLI]. +* You have installed the `opm` CLI tool. For more information, see {ocp-docs-link}/html/cli_tools/opm-cli#olm-about-opm_cli-opm-install[Installing the opm CLI]. * If you are using an {ocp-short} cluster, you have the following prerequisites: ** (Optional) You have installed the `oc-mirror` {ocp-short} CLI plugin if you want to use it to mirror images. * If you are using a supported Kubernetes cluster, you have the following prerequisites: diff --git a/modules/observe/con-audit-log-config.adoc b/modules/observe/con-audit-log-config.adoc index 71a9d61e30..4389581e4c 100644 --- a/modules/observe/con-audit-log-config.adoc +++ b/modules/observe/con-audit-log-config.adoc @@ -6,10 +6,10 @@ Use the {ocp-short} web console to configure the following {ocp-short} logging components to use audit logging for {product-short}: Logging deployment:: -Configure the logging environment, including both the CPU and memory limits for each logging component. For more information, see link:{ocp-docs-link}/html-single/logging/index#cluster-logging-memory[{ocp-brand-name} - Configuring your Logging deployment]. +Configure the logging environment, including both the CPU and memory limits for each logging component. For more information, see {ocp-docs-link}/html-single/logging/index#cluster-logging-memory[{ocp-brand-name} - Configuring your Logging deployment]. Logging collector:: -Configure the `spec.collection` stanza in the `ClusterLogging` custom resource (CR) to use a supported modification to the log collector and collect logs from `STDOUT`. For more information, see link:{ocp-docs-link}/html-single/logging/index#cluster-logging-collector[{ocp-brand-name} - Configuring the logging collector]. +Configure the `spec.collection` stanza in the `ClusterLogging` custom resource (CR) to use a supported modification to the log collector and collect logs from `STDOUT`. For more information, see {ocp-docs-link}/html-single/logging/index#cluster-logging-collector[{ocp-brand-name} - Configuring the logging collector]. Log forwarding:: Send logs to specific endpoints inside and outside your {ocp-short} cluster by specifying a combination of outputs and pipelines in a `ClusterLogForwarder` CR. For more information, see {ocp-docs-link}/html-single/logging/index#cluster-logging-json-log-forwarding_cluster-logging-enabling-json-logging[{ocp-brand-name} - Enabling JSON log forwarding] and {ocp-docs-link}/html-single/logging/index#configuring-log-forwarding[{ocp-brand-name} - Configuring log forwarding]. From da9a614cfd018a00162731850d109adee2c7b7db Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Fabrice=20Flore-Th=C3=A9bault?= Date: Tue, 9 Sep 2025 12:16:33 +0200 Subject: [PATCH 04/11] Fixed leftover after replacing xref by attribute MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Signed-off-by: Fabrice Flore-Thébault --- ...rvice-to-provide-data-to-the-quick-access-card.adoc | 2 +- ...files-to-provide-data-to-the-quick-access-card.adoc | 2 +- modules/installation/proc-enable-signin.adoc | 2 +- modules/installation/proc-install-operator.adoc | 2 +- .../installation/proc-install-rhdh-ocp-operator.adoc | 10 +++++----- .../installation/proc-install-rhdh-osd-gcp-helm.adoc | 2 +- .../proc-install-rhdh-osd-gcp-operator.adoc | 2 +- modules/observe/proc-view-logs-aks.adoc | 2 +- 8 files changed, 12 insertions(+), 12 deletions(-) diff --git a/modules/customizing-the-quick-access-card/proc-using-a-dedicated-service-to-provide-data-to-the-quick-access-card.adoc b/modules/customizing-the-quick-access-card/proc-using-a-dedicated-service-to-provide-data-to-the-quick-access-card.adoc index 5093ea5ec4..f837896ed0 100644 --- a/modules/customizing-the-quick-access-card/proc-using-a-dedicated-service-to-provide-data-to-the-quick-access-card.adoc +++ b/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 diff --git a/modules/customizing-the-quick-access-card/proc-using-hosted-json-files-to-provide-data-to-the-quick-access-card.adoc b/modules/customizing-the-quick-access-card/proc-using-hosted-json-files-to-provide-data-to-the-quick-access-card.adoc index f3818d7e4b..f546ed30a1 100644 --- a/modules/customizing-the-quick-access-card/proc-using-hosted-json-files-to-provide-data-to-the-quick-access-card.adoc +++ b/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 diff --git a/modules/installation/proc-enable-signin.adoc b/modules/installation/proc-enable-signin.adoc index 55643e67da..e31969fa9f 100644 --- a/modules/installation/proc-enable-signin.adoc +++ b/modules/installation/proc-enable-signin.adoc @@ -63,7 +63,7 @@ The {product} supports the following authentication providers: .Prerequisites * You have installed the {product-short}. -For more information about installation, see xref:{installing-on-ocp-book-link}#assembly-install-rhdh-ocp-helm[{installing-on-ocp-book-title} with the Helm chart]. +For more information about installation, see {installing-on-ocp-book-link}#assembly-install-rhdh-ocp-helm[{installing-on-ocp-book-title} with the Helm chart]. .Procedure diff --git a/modules/installation/proc-install-operator.adoc b/modules/installation/proc-install-operator.adoc index 63556c1046..8843a8c9ac 100644 --- a/modules/installation/proc-install-operator.adoc +++ b/modules/installation/proc-install-operator.adoc @@ -26,7 +26,7 @@ Containers are available for the following CPU architectures: + Before you create a {product-short} instance, you must create the required config map and Secret resources in your project. These include the `baseUrl` and service-to-service authentication secrets. + -For detailed steps, see xref:{configuring-book-link}#provisioning-and-using-your-custom-configuration[Provisioning your custom {product} configuration]. +For detailed steps, see {configuring-book-link}#provisioning-and-using-your-custom-configuration[Provisioning your custom {product} configuration]. . From the *Update channel* drop-down menu, select the update channel that you want to use, for example, *fast* or *fast-{product-version}*. + [IMPORTANT] diff --git a/modules/installation/proc-install-rhdh-ocp-operator.adoc b/modules/installation/proc-install-rhdh-ocp-operator.adoc index add05f2f90..bf77cdb3b0 100644 --- a/modules/installation/proc-install-rhdh-ocp-operator.adoc +++ b/modules/installation/proc-install-rhdh-ocp-operator.adoc @@ -9,8 +9,8 @@ As a developer, you can deploy a {product} instance on {ocp-short} by using the .Prerequisites * You have set the `baseUrl` in your `{my-app-config-file}` to match the external URL of your {product-short} instance. Without it, frontend and backend services cannot communicate, and features might not work as expected. * xref:proc-install-operator_{context}[An {ocp-short} administrator has installed the {product} Operator]. -* xref:{configuring-book-link}#provisioning-your-custom-configuration[You have provisioned your custom config maps and secrets in your `_<{my-product-namespace}>_` project]. -* xref:{configuring-book-link}#using-the-operator-to-run-rhdh-with-your-custom-configuration[You have authored your {product-custom-resource-type} custom resource]. +* {configuring-book-link}#provisioning-your-custom-configuration[You have provisioned your custom config maps and secrets in your `_<{my-product-namespace}>_` project]. +* {configuring-book-link}#using-the-operator-to-run-rhdh-with-your-custom-configuration[You have authored your {product-custom-resource-type} custom resource]. .Procedure @@ -44,7 +44,7 @@ data: + Use a config map named `app-config-rhdh` to provide your `app-config.yaml` file, and a Secret for service-to-service authentication (such as `BACKEND_SECRET`). + -To create and apply these configuration resources, follow the steps in xref:{configuring-book-link}#provisioning-and-using-your-custom-configuration[Provisioning your custom {product} configuration] for the full procedure. +To create and apply these configuration resources, follow the steps in {configuring-book-link}#provisioning-and-using-your-custom-configuration[Provisioning your custom {product} configuration] for the full procedure. + [NOTE] ==== @@ -68,10 +68,10 @@ stringData: + [NOTE] ==== -Ensure that your secret includes `BACKEND_SECRET`, used for service-to-service authentication. For structure and provisioning steps, see xref:{configuring-book-link}#provisioning-and-using-your-custom-configuration[Provisioning your custom {product} configuration]. +Ensure that your secret includes `BACKEND_SECRET`, used for service-to-service authentication. For structure and provisioning steps, see {configuring-book-link}#provisioning-and-using-your-custom-configuration[Provisioning your custom {product} configuration]. ==== . Click *Create*. -. xref:{configuring-book-link}#using-the-operator-to-run-rhdh-with-your-custom-configuration[Add your {product-custom-resource-type} custom resource content]. +. {configuring-book-link}#using-the-operator-to-run-rhdh-with-your-custom-configuration[Add your {product-custom-resource-type} custom resource content]. . On the *Create Backstage* page, click *Create*. .Verification diff --git a/modules/installation/proc-install-rhdh-osd-gcp-helm.adoc b/modules/installation/proc-install-rhdh-osd-gcp-helm.adoc index a06264cd4b..421d233b6d 100644 --- a/modules/installation/proc-install-rhdh-osd-gcp-helm.adoc +++ b/modules/installation/proc-install-rhdh-osd-gcp-helm.adoc @@ -35,7 +35,7 @@ global: origin: https:// ---- You can also define additional secrets, plugins, and advanced configuration in your `values.yaml` file. For full instructions, see: -xref:{configuring-book-link}#provisioning-and-using-your-custom-configuration[Provisioning your custom {product} configuration]. +{configuring-book-link}#provisioning-and-using-your-custom-configuration[Provisioning your custom {product} configuration]. ==== + The *Form view* is selected by default. diff --git a/modules/installation/proc-install-rhdh-osd-gcp-operator.adoc b/modules/installation/proc-install-rhdh-osd-gcp-operator.adoc index 4a8b716723..fa3b88d728 100644 --- a/modules/installation/proc-install-rhdh-osd-gcp-operator.adoc +++ b/modules/installation/proc-install-rhdh-osd-gcp-operator.adoc @@ -46,7 +46,7 @@ data: + You must create a config map named `app-config-rhdh` and a Kubernetes Secret containing the `BACKEND_SECRET`. These resources are used by the {product-short} instance for authentication and application settings. + -For further steps, see xref:{configuring-book-link}#provisioning-and-using-your-custom-configuration[Provisioning your custom {product} configuration]. +For further steps, see {configuring-book-link}#provisioning-and-using-your-custom-configuration[Provisioning your custom {product} configuration]. . Create a config map named `app-config-rhdh` that includes your `{my-app-config-file}` as shown: + -- diff --git a/modules/observe/proc-view-logs-aks.adoc b/modules/observe/proc-view-logs-aks.adoc index 6d01fcef33..1ea9fdba37 100644 --- a/modules/observe/proc-view-logs-aks.adoc +++ b/modules/observe/proc-view-logs-aks.adoc @@ -7,7 +7,7 @@ You can access live data logs generated by Kubernetes objects and collect log da * You have deployed {product-short} on {aks-short}. -For more information, see xref:{installing-on-aks-book-link}#assembly-install-rhdh-aks[{installing-on-aks-book-title}]. +For more information, see {installing-on-aks-book-link}#assembly-install-rhdh-aks[{installing-on-aks-book-title}]. .Procedure From 7aecc0cb0276ccf7acb47555a72c3c0e6bcff6d1 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Fabrice=20Flore-Th=C3=A9bault?= Date: Tue, 9 Sep 2025 12:23:40 +0200 Subject: [PATCH 05/11] Used the product-short attribute consistently MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Signed-off-by: Fabrice Flore-Thébault --- ...uicklinks-and-starred-items-in-global-header.adoc | 4 ++-- ...bling-quicklinks-starred-items-after-upgrade.adoc | 4 ++-- .../proc-customize-rhdh-quickstart.adoc | 12 ++++++------ .../proc-installing-and-configuring-lightspeed.adoc | 8 ++++---- .../installation/proc-deploy-rhdh-instance-gke.adoc | 2 +- .../proc-install-rhdh-airgapped-full-k8s-helm.adoc | 4 ++-- ...proc-install-rhdh-airgapped-partial-k8s-helm.adoc | 4 ++-- .../installation/proc-install-rhdh-ocp-helm-gui.adoc | 2 +- 8 files changed, 20 insertions(+), 20 deletions(-) diff --git a/modules/configuring-the-global-header/con-quicklinks-and-starred-items-in-global-header.adoc b/modules/configuring-the-global-header/con-quicklinks-and-starred-items-in-global-header.adoc index 6698b8074c..c32fa39fe7 100644 --- a/modules/configuring-the-global-header/con-quicklinks-and-starred-items-in-global-header.adoc +++ b/modules/configuring-the-global-header/con-quicklinks-and-starred-items-in-global-header.adoc @@ -33,7 +33,7 @@ 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 @@ -41,7 +41,7 @@ The default configuration includes the following components: section: Documentation priority: 150 props: - title: Developer Hub + title: {product-short} icon: developerHub link: https://docs.redhat.com/en/documentation/red_hat_developer_hub diff --git a/modules/configuring-the-global-header/proc-enabling-quicklinks-starred-items-after-upgrade.adoc b/modules/configuring-the-global-header/proc-enabling-quicklinks-starred-items-after-upgrade.adoc index 740ae9e7a3..4faaa30c2d 100644 --- a/modules/configuring-the-global-header/proc-enabling-quicklinks-starred-items-after-upgrade.adoc +++ b/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 diff --git a/modules/configuring-the-quickstarts/proc-customize-rhdh-quickstart.adoc b/modules/configuring-the-quickstarts/proc-customize-rhdh-quickstart.adoc index 86e0d60618..798ef3fbf5 100644 --- a/modules/configuring-the-quickstarts/proc-customize-rhdh-quickstart.adoc +++ b/modules/configuring-the-quickstarts/proc-customize-rhdh-quickstart.adoc @@ -1,7 +1,7 @@ [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. @@ -9,13 +9,13 @@ 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 ----- \ No newline at end of file +---- diff --git a/modules/developer-lightspeed/proc-installing-and-configuring-lightspeed.adoc b/modules/developer-lightspeed/proc-installing-and-configuring-lightspeed.adoc index 7d9073b664..be85f6eb1c 100644 --- a/modules/developer-lightspeed/proc-installing-and-configuring-lightspeed.adoc +++ b/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 @@ -116,7 +116,7 @@ data: # If not provided, the plugin uses built-in default prompts prompts: - title: 'Getting Started with {product}' - 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? + 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} @@ -159,7 +159,7 @@ includes: # If not provided, the plugin uses built-in default prompts prompts: - title: 'Getting Started with {product}' - message: Can you guide me through the first steps to start using Developer Hub + 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: @@ -333,7 +333,7 @@ dynamic: # If not provided, the plugin uses built-in default prompts prompts: - title: 'Getting Started with {product}' - message: Can you guide me through the first steps to start using Developer Hub + 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: diff --git a/modules/installation/proc-deploy-rhdh-instance-gke.adoc b/modules/installation/proc-deploy-rhdh-instance-gke.adoc index ebb2a211d1..2c347185f0 100644 --- a/modules/installation/proc-deploy-rhdh-instance-gke.adoc +++ b/modules/installation/proc-deploy-rhdh-instance-gke.adoc @@ -154,7 +154,7 @@ For more information about setting a policy to redirect to HTTPS, see https://cl apiVersion: networking.k8s.io/v1 kind: Ingress metadata: - # TODO: this the name of your Developer Hub Ingress + # TODO: this the name of your {product-short} Ingress name: my-rhdh annotations: # If the class annotation is not specified it defaults to "gce". diff --git a/modules/installation/proc-install-rhdh-airgapped-full-k8s-helm.adoc b/modules/installation/proc-install-rhdh-airgapped-full-k8s-helm.adoc index 6220f9882b..3dc6596b47 100644 --- a/modules/installation/proc-install-rhdh-airgapped-full-k8s-helm.adoc +++ b/modules/installation/proc-install-rhdh-airgapped-full-k8s-helm.adoc @@ -134,11 +134,11 @@ upstream: + * For {eks-short}, use the following `values.yaml` file template: + -[source,yaml,subs="+quotes"] +[source,yaml,subs="+attributes,+quotes"] ---- global: # TODO: Set your application domain name. - host: + host: route: enabled: false diff --git a/modules/installation/proc-install-rhdh-airgapped-partial-k8s-helm.adoc b/modules/installation/proc-install-rhdh-airgapped-partial-k8s-helm.adoc index 9d2a67bf7c..229a10515d 100644 --- a/modules/installation/proc-install-rhdh-airgapped-partial-k8s-helm.adoc +++ b/modules/installation/proc-install-rhdh-airgapped-partial-k8s-helm.adoc @@ -115,11 +115,11 @@ upstream: + * For {eks-short}, use the following `values.yaml` file template: + -[source,yaml,subs="+quotes"] +[source,yaml,subs="+attributes,+quotes"] ---- global: # TODO: Set your application domain name. - host: + host: route: enabled: false diff --git a/modules/installation/proc-install-rhdh-ocp-helm-gui.adoc b/modules/installation/proc-install-rhdh-ocp-helm-gui.adoc index 2662bceb11..49089b3404 100644 --- a/modules/installation/proc-install-rhdh-ocp-helm-gui.adoc +++ b/modules/installation/proc-install-rhdh-ocp-helm-gui.adoc @@ -25,7 +25,7 @@ The {product} Helm chart is available in the Helm catalog on {osd-short} and {oc . From the *Developer* perspective on the {product-short} web console, click *+Add*. . From the *Developer Catalog* panel, click *Helm Chart*. -. In the *Filter by keyword* box, enter _Developer Hub_ and click the *{product}* card. +. In the *Filter by keyword* box, enter _{product-short}_ and click the *{product}* card. . From the {product} page, click *Create*. . From your cluster, copy the {ocp-short} router host (for example: `apps..com`). . Select the radio button to configure the {product-short} instance with either the form view or YAML view. The Form view is selected by default. From f443f38abf404c8292125c8d529c3cda0afd0029 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Fabrice=20Flore-Th=C3=A9bault?= Date: Tue, 9 Sep 2025 12:28:26 +0200 Subject: [PATCH 06/11] Used the product-very-short attribute consistently MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Signed-off-by: Fabrice Flore-Thébault --- ...c-enabling-user-authentication-with-rhbk.adoc | 2 +- ...oc-installing-and-configuring-lightspeed.adoc | 16 ++++++++-------- ...-linking-to-source-code-editor-or-source.adoc | 2 +- .../ref-rh-compatible-plugins.adoc | 4 ++-- .../proc-install-create-custom-flavor.adoc | 2 +- modules/techdocs/proc-techdocs-addon-create.adoc | 2 +- 6 files changed, 14 insertions(+), 14 deletions(-) diff --git a/modules/authentication/proc-enabling-user-authentication-with-rhbk.adoc b/modules/authentication/proc-enabling-user-authentication-with-rhbk.adoc index cf4d4ab3e2..a3558965ec 100644 --- a/modules/authentication/proc-enabling-user-authentication-with-rhbk.adoc +++ b/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://____/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** diff --git a/modules/developer-lightspeed/proc-installing-and-configuring-lightspeed.adoc b/modules/developer-lightspeed/proc-installing-and-configuring-lightspeed.adoc index be85f6eb1c..0d384fe667 100644 --- a/modules/developer-lightspeed/proc-installing-and-configuring-lightspeed.adoc +++ b/modules/developer-lightspeed/proc-installing-and-configuring-lightspeed.adoc @@ -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 @@ -396,7 +396,7 @@ extraVolumes: ---- ... Add the {rcs-short} image as shown in the following example: + -[source,yaml] +[source,yaml,subs="+attributes"] ---- extraContainers: - env: @@ -404,7 +404,7 @@ extraVolumes: 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: diff --git a/modules/dynamic-plugins/proc-linking-to-source-code-editor-or-source.adoc b/modules/dynamic-plugins/proc-linking-to-source-code-editor-or-source.adoc index 6696ea1f88..ba1b13fbc9 100644 --- a/modules/dynamic-plugins/proc-linking-to-source-code-editor-or-source.adoc +++ b/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. diff --git a/modules/dynamic-plugins/ref-rh-compatible-plugins.adoc b/modules/dynamic-plugins/ref-rh-compatible-plugins.adoc index 5cc280fe2d..d7aed6eca6 100644 --- a/modules/dynamic-plugins/ref-rh-compatible-plugins.adoc +++ b/modules/dynamic-plugins/ref-rh-compatible-plugins.adoc @@ -18,10 +18,10 @@ The following Technology Preview plugins are not preinstalled and must be instal | {ansible-automation-platform-docs-link}/html-single/installing_ansible_plug-ins_for_red_hat_developer_hub/index[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] +//|Orchestrator Frontend|`https://www.npmjs.com/package/@red-hat-developer-hub/backstage-plugin-orchestrator[@red-hat-developer-hub/backstage-plugin-orchestrator]` | N/A for {product-very-short} 1.4 | https://github.com/redhat-developer/rhdh-plugins/tree/main/workspaces/orchestrator/[Learn more] // temporarily removed until we have a good installation story from the Orchestrator team -//|Orchestrator Backend|`https://npm.registry.redhat.com/@redhat/backstage-plugin-orchestrator-backend-dynamic/[@redhat/backstage-plugin-orchestrator-backend-dynamic]` | N/A for RHDH 1.4 | https://github.com/redhat-developer/rhdh-plugins/tree/main/workspaces/orchestrator[Learn more] +//|Orchestrator Backend|`https://npm.registry.redhat.com/@redhat/backstage-plugin-orchestrator-backend-dynamic/[@redhat/backstage-plugin-orchestrator-backend-dynamic]` | N/A for {product-very-short} 1.4 | https://github.com/redhat-developer/rhdh-plugins/tree/main/workspaces/orchestrator[Learn more] |=== diff --git a/modules/installation/proc-install-create-custom-flavor.adoc b/modules/installation/proc-install-create-custom-flavor.adoc index c2f6dd1d18..a1522d260f 100644 --- a/modules/installation/proc-install-create-custom-flavor.adoc +++ b/modules/installation/proc-install-create-custom-flavor.adoc @@ -34,7 +34,7 @@ _config/_:: Contains the core app-config.yaml for {product}, along with any plug _resources/_:: Holds additional Kubernetes resources your flavor needs. This can include CRDs for dependencies or initial catalog entities to populate {product-very-short}. -_hooks/_:: Contains manifests for Kubernetes jobs that run before (pre-install) or after (post-install) the RHDH instance is deployed. +_hooks/_:: Contains manifests for Kubernetes jobs that run before (pre-install) or after (post-install) the {product-very-short} instance is deployed. . (Optional) If your flavor uses dynamic plugins that require specific Kubernetes resources, define these resources as YAML manifests in your `config/profile/{PROFILE}/plugin-deps` directory. diff --git a/modules/techdocs/proc-techdocs-addon-create.adoc b/modules/techdocs/proc-techdocs-addon-create.adoc index 392b9b63ee..ebe94a95c3 100644 --- a/modules/techdocs/proc-techdocs-addon-create.adoc +++ b/modules/techdocs/proc-techdocs-addon-create.adoc @@ -146,5 +146,5 @@ __ (Optional) :: Specifies the `props` for your new Te . Install and configure your new TechDocs add-on by following the steps in {techdocs-book-link}#techdocs-addon-installing[Installing and configuring a TechDocs add-on] .Verification -. Restart the RHDH application and verify that the plugin is successfully activated and configured. +. Restart the {product-very-short} application and verify that the plugin is successfully activated and configured. . Verify the application logs for confirmation and ensure the plugin is functioning as expected. From 19e844f869c50e8003d22778ecb050f36b9e8fe4 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Fabrice=20Flore-Th=C3=A9bault?= Date: Tue, 9 Sep 2025 13:25:37 +0200 Subject: [PATCH 07/11] Used the product-very-short attribute consistently MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Signed-off-by: Fabrice Flore-Thébault --- .../assembly-extensions-plugins.adoc | 14 +++++++------- titles/plugins-rhdh-install/master.adoc | 4 ++-- 2 files changed, 9 insertions(+), 9 deletions(-) diff --git a/assemblies/dynamic-plugins/assembly-extensions-plugins.adoc b/assemblies/dynamic-plugins/assembly-extensions-plugins.adoc index 7d63869aa5..26cea6802f 100644 --- a/assemblies/dynamic-plugins/assembly-extensions-plugins.adoc +++ b/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] \ No newline at end of file +//include::../modules/dynamic-plugins/proc-extensions-creating.adoc[leveloffset=+1] diff --git a/titles/plugins-rhdh-install/master.adoc b/titles/plugins-rhdh-install/master.adoc index 50b2d6ac9d..fff65e1cf0 100644 --- a/titles/plugins-rhdh-install/master.adoc +++ b/titles/plugins-rhdh-install/master.adoc @@ -14,7 +14,7 @@ include::assemblies/dynamic-plugins/assembly-installing-rhdh-plugins.adoc[levelo //third-party plugins include::assemblies/dynamic-plugins/assembly-third-party-plugins.adoc[leveloffset=+1] -//Install RHDH container image plugins +//Install {product-very-short} container image plugins include::modules/dynamic-plugins/proc-enable-plugins-rhdh-container-image.adoc[leveloffset=+1] // Viewing installed plugins - moved to Extensions @@ -27,4 +27,4 @@ include::assemblies/dynamic-plugins/assembly-extensions-plugins.adoc[leveloffset include::modules/dynamic-plugins/proc-plugins-troubleshooting.adoc[leveloffset=+1] // frontend plugin wiring -include::assemblies/dynamic-plugins/assembly-front-end-plugin-wiring.adoc[leveloffset=+1] \ No newline at end of file +include::assemblies/dynamic-plugins/assembly-front-end-plugin-wiring.adoc[leveloffset=+1] From da9282b24a3fe5607611ee8df155cce69e40197d Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Fabrice=20Flore-Th=C3=A9bault?= Date: Tue, 9 Sep 2025 13:26:47 +0200 Subject: [PATCH 08/11] Update modules/developer-lightspeed/proc-installing-and-configuring-lightspeed.adoc --- .../proc-installing-and-configuring-lightspeed.adoc | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/modules/developer-lightspeed/proc-installing-and-configuring-lightspeed.adoc b/modules/developer-lightspeed/proc-installing-and-configuring-lightspeed.adoc index 0d384fe667..d762f71b32 100644 --- a/modules/developer-lightspeed/proc-installing-and-configuring-lightspeed.adoc +++ b/modules/developer-lightspeed/proc-installing-and-configuring-lightspeed.adoc @@ -289,7 +289,7 @@ spec: - name: RCS_CONFIG_FILE value: /app-root/config/rcsconfig.yaml # Your existing {product-very-short} ConfigMap - - name: {product-very-short}_CONFIG_FILE + - name: RHDH_CONFIG_FILE value: /app-root/config/app-config-rhdh.yaml envFrom: - secretRef: From 8db8ce423a072c92d5ce1e66abbd879ce1bfbec6 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Fabrice=20Flore-Th=C3=A9bault?= Date: Tue, 9 Sep 2025 13:29:42 +0200 Subject: [PATCH 09/11] Apply suggestions from code review --- .../proc-installing-and-configuring-lightspeed.adoc | 4 ++-- .../proc-install-rhdh-airgapped-full-k8s-helm.adoc | 2 +- 2 files changed, 3 insertions(+), 3 deletions(-) diff --git a/modules/developer-lightspeed/proc-installing-and-configuring-lightspeed.adoc b/modules/developer-lightspeed/proc-installing-and-configuring-lightspeed.adoc index d762f71b32..e68ac5ac05 100644 --- a/modules/developer-lightspeed/proc-installing-and-configuring-lightspeed.adoc +++ b/modules/developer-lightspeed/proc-installing-and-configuring-lightspeed.adoc @@ -404,7 +404,7 @@ extraVolumes: value: rhdh - name: RCS_CONFIG_FILE value: /app-root/config/rcsconfig.yaml - - name: {product-very-short}_CONFIG_FILE + - name: RHDH_CONFIG_FILE value: /app-root/config/lightspeed-app-config.yaml envFrom: - secretRef: @@ -451,7 +451,7 @@ upstream: value: rhdh - name: RCS_CONFIG_FILE value: /app-root/config/rcsconfig.yaml - - name: {product-very-short}_CONFIG_FILE + - name: RHDH_CONFIG_FILE value: /app-root/config/lightspeed-app-config.yaml envFrom: - secretRef: diff --git a/modules/installation/proc-install-rhdh-airgapped-full-k8s-helm.adoc b/modules/installation/proc-install-rhdh-airgapped-full-k8s-helm.adoc index 3dc6596b47..73f60153da 100644 --- a/modules/installation/proc-install-rhdh-airgapped-full-k8s-helm.adoc +++ b/modules/installation/proc-install-rhdh-airgapped-full-k8s-helm.adoc @@ -138,7 +138,7 @@ upstream: ---- global: # TODO: Set your application domain name. - host: + host: {my-product-domain} route: enabled: false From a6cbddf411e83cda68730dc9aebf885b8313bc06 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Fabrice=20Flore-Th=C3=A9bault?= Date: Tue, 9 Sep 2025 13:30:59 +0200 Subject: [PATCH 10/11] Update modules/installation/proc-rhdh-deploy-aks-operator.adoc --- modules/installation/proc-rhdh-deploy-aks-operator.adoc | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/modules/installation/proc-rhdh-deploy-aks-operator.adoc b/modules/installation/proc-rhdh-deploy-aks-operator.adoc index 40dd92c871..9f5c109aae 100644 --- a/modules/installation/proc-rhdh-deploy-aks-operator.adoc +++ b/modules/installation/proc-rhdh-deploy-aks-operator.adoc @@ -102,7 +102,7 @@ data: "{my-app-config-file}": | app: title: {product} - baseUrl: https:// + baseUrl: {my-product-url} backend: auth: externalAccess: From 8988b4d24f581defaf26b1007dabee9ad833780f Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Fabrice=20Flore-Th=C3=A9bault?= Date: Tue, 9 Sep 2025 13:37:01 +0200 Subject: [PATCH 11/11] Used attributes consistently MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Signed-off-by: Fabrice Flore-Thébault --- modules/installation/proc-rhdh-deploy-aks-operator.adoc | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/modules/installation/proc-rhdh-deploy-aks-operator.adoc b/modules/installation/proc-rhdh-deploy-aks-operator.adoc index 9f5c109aae..171b1ba766 100644 --- a/modules/installation/proc-rhdh-deploy-aks-operator.adoc +++ b/modules/installation/proc-rhdh-deploy-aks-operator.adoc @@ -92,7 +92,7 @@ kubectl -n apply -f rhdh-ingress.yaml . Create a `{my-app-config-config-map}` config map containing the `{my-app-config-file}` {product-short} configuration file by using the following example: + -- -[source,yaml,subs="+attributes"] +[source,yaml,subs="+attributes,+quotes"] ---- apiVersion: v1 kind: ConfigMap @@ -110,9 +110,9 @@ data: options: subject: legacy-default-config secret: "${BACKEND_SECRET}" - baseUrl: https:// + baseUrl: {my-product-url} cors: - origin: https:// + origin: {my-product-url} ---- --