Skip to content
Merged
Show file tree
Hide file tree
Changes from 9 commits
Commits
Show all changes
26 commits
Select commit Hold shift + click to select a range
768a28c
RHIDP-5409 update book links
themr0c Mar 7, 2025
c0d5c15
Update assemblies/assembly-configuring-techdocs.adoc
themr0c Mar 7, 2025
42d7ccc
Update artifacts/rhdh-plugins-reference/argocd/argocd-plugin-admin.adoc
themr0c Mar 7, 2025
0e01548
Update artifacts/rhdh-plugins-reference/argocd/argocd-plugin-admin.adoc
themr0c Mar 7, 2025
beacc46
Update artifacts/rhdh-plugins-reference/argocd/argocd-plugin-admin.adoc
themr0c Mar 7, 2025
aece50b
Update artifacts/rhdh-plugins-reference/argocd/argocd-plugin-readme.adoc
themr0c Mar 7, 2025
a0cbc8f
Update artifacts/rhdh-plugins-reference/argocd/argocd-plugin-user.adoc
themr0c Mar 7, 2025
fa9fed1
Update assemblies/dynamic-plugins/assembly-rhdh-installing-dynamic-pl…
themr0c Mar 7, 2025
ee9d338
Update modules/customizing-the-tech-radar-page/proc-customize-rhdh-te…
themr0c Mar 7, 2025
7e3aa01
Update modules/dynamic-plugins/ref-rh-compatible-plugins.adoc
themr0c Mar 7, 2025
9e02528
Update modules/authentication/proc-enabling-authentication-with-githu…
themr0c Mar 7, 2025
107781a
Update assemblies/assembly-configuring-techdocs.adoc
themr0c Mar 7, 2025
e5817b1
Update assemblies/dynamic-plugins/assembly-rhdh-installing-dynamic-pl…
themr0c Mar 7, 2025
a147e90
Update assemblies/dynamic-plugins/assembly-rhdh-installing-dynamic-pl…
themr0c Mar 7, 2025
9f81a73
Update modules/authentication/proc-enabling-authentication-with-micro…
themr0c Mar 7, 2025
880ab92
Update modules/dynamic-plugins/ref-rh-compatible-plugins.adoc
themr0c Mar 7, 2025
52f1886
Update modules/customizing-the-tech-radar-page/proc-customize-rhdh-te…
themr0c Mar 7, 2025
40e97f4
Update modules/authentication/proc-enabling-authentication-with-rhbk.…
themr0c Mar 7, 2025
877fda5
Update modules/dynamic-plugins/ref-rh-compatible-plugins.adoc
themr0c Mar 7, 2025
bcc575e
Update modules/dynamic-plugins/ref-rh-compatible-plugins.adoc
themr0c Mar 7, 2025
17fce3e
Update modules/dynamic-plugins/ref-rh-compatible-plugins.adoc
themr0c Mar 7, 2025
aa0cdca
Update modules/customizing-the-tech-radar-page/proc-customize-rhdh-te…
themr0c Mar 7, 2025
5799ddf
Update modules/customizing-the-tech-radar-page/proc-customize-rhdh-te…
themr0c Mar 7, 2025
a9ebb56
Update modules/customizing-the-tech-radar-page/proc-customize-rhdh-te…
themr0c Mar 7, 2025
43f552f
Update modules/customizing-the-tech-radar-page/proc-customize-rhdh-te…
themr0c Mar 7, 2025
a5cfb49
Merge branch 'main' into RHIDP-5409-update-book-links
themr0c Mar 7, 2025
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
98 changes: 46 additions & 52 deletions artifacts/attributes.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -85,75 +85,69 @@
:gcp-brand-name: Google Cloud Platform
:gcp-short: GCP

// Release Notes
:rn-product-title: Release notes for Red Hat Developer Hub

// Red Hat Developer Hub administration guide
:ag-product-title: Administration guide for Red Hat Developer Hub

// Red Hat Developer Hub getting started guide
:gs-product-title: Getting started with Red Hat Developer Hub

// Backstage Plugins for Red Hat Developer Hub
//:bs-product-title: Backstage Plugins for Red Hat Developer Hub

// User Guide
:ug-product-title: Red Hat Developer Hub User Guide

// Links


:LinkPluginsGuide: https://access.redhat.com/documentation/en-us/red_hat_developer_hub/{product-version}/html-single/configuring_plugins_in_red_hat_developer_hub/index
:NameOfPluginsGuide: Configuring plugins in {product}

:release-notes-url: https://docs.redhat.com/en/documentation/red_hat_developer_hub/{product-version}/html-single/release_notes/index
:release-notes-title: Release notes

:installing-and-viewing-dynamic-plugins-url: https://docs.redhat.com/en/documentation/red_hat_developer_hub/{product-version}/html-single/installing_and_viewing_dynamic_plugins/index
:installing-and-viewing-dynamic-plugins-title: Installing and viewing dynamic plugins

:authentication-book-url: https://docs.redhat.com/documentation/en-us/red_hat_developer_hub/{product-version}/html-single/authentication/index
:authentication-book-title: Authentication

:authorization-book-url: https://docs.redhat.com/documentation/en-us/red_hat_developer_hub/{product-version}/html-single/authorization/index
:authorization-book-title: Authorization

:configuring-book-url: https://docs.redhat.com/documentation/en-us/red_hat_developer_hub/{product-version}/html-single/configuring/index
:configuring-book-title: Configuring
:discover-category-url: https://docs.redhat.com/en/documentation/red_hat_developer_hub/{product-version}/#Discover
:about-book-url: https://docs.redhat.com/en/documentation/red_hat_developer_hub/{product-version}/html-single/about_red_hat_developer_hub/index
:about-book-title: About {product}

:customizing-book-url: https://docs.redhat.com/documentation/en-us/red_hat_developer_hub/{product-version}/html-single/customizing/index
:customizing-book-title: Customizing
:release-notes-category-url: https://docs.redhat.com/en/documentation/red_hat_developer_hub/{product-version}/#Release Notes
:release-notes-book-url: https://docs.redhat.com/en/documentation/red_hat_developer_hub/{product-version}/html-single/red_hat_developer_hub_release_notes/index
:release-notes-book-title: {product} release notes

:installing-on-osd-on-gcp-book-url: https://docs.redhat.com/en/documentation/red_hat_developer_hub/{product-version}/html-single/installing_red_hat_developer_hub_on_openshift_dedicated_on_google_cloud_platform/index
:installing-on-osd-on-gcp-book-title: Installing {product} on {gcp-brand-name} on {gcp-brand-name}

:installing-on-ocp-book-url: https://docs.redhat.com/en/documentation/red_hat_developer_hub/{product-version}/html-single/installing_red_hat_developer_hub_on_openshift_container_platform/index
:install-category-url: https://docs.redhat.com/en/documentation/red_hat_developer_hub/{product-version}/#Install
:installing-on-ocp-book-title: Installing {product} on {ocp-short}

:installing-on-gke-book-url: https://docs.redhat.com/en/documentation/red_hat_developer_hub/{product-version}/html-single/installing_red_hat_developer_hub_on_google_kubernetes_engine/index
:installing-on-gke-book-title: Installing {product} on {gke-brand-name}

:installing-on-eks-book-url: https://docs.redhat.com/en/documentation/red_hat_developer_hub/{product-version}/html-single/installing_red_hat_developer_hub_on_amazon_elastic_kubernetes_service/index
:installing-on-ocp-book-url: https://docs.redhat.com/en/documentation/red_hat_developer_hub/{product-version}/html-single/installing_red_hat_developer_hub_on_openshift_container_platform/index
:installing-on-eks-book-title: Installing {product} on {eks-brand-name}

:installing-on-aks-book-url: https://docs.redhat.com/en/documentation/red_hat_developer_hub/{product-version}/html-single/installing_red_hat_developer_hub_on_microsoft_azure_kubernetes_service/index
:installing-on-eks-book-url: https://docs.redhat.com/en/documentation/red_hat_developer_hub/{product-version}/html-single/installing_red_hat_developer_hub_on_amazon_elastic_kubernetes_service/index
:installing-on-aks-book-title: Installing {product} on {aks-brand-name}

:installing-in-air-gap-book-url: https://docs.redhat.com/en/documentation/red_hat_developer_hub/{product-version}/html-single/installing_red_hat_developer_hub_in_an_air-gapped_environment/index
:installing-on-aks-book-url: https://docs.redhat.com/en/documentation/red_hat_developer_hub/{product-version}/html-single/installing_red_hat_developer_hub_on_microsoft_azure_kubernetes_service/index
:installing-on-osd-on-gcp-book-title: Installing {product} on {gcp-brand-name} on {gcp-brand-name}
:installing-on-osd-on-gcp-book-url: https://docs.redhat.com/en/documentation/red_hat_developer_hub/{product-version}/html-single/installing_red_hat_developer_hub_on_openshift_dedicated_on_google_cloud_platform/index
:installing-on-gke-book-title: Installing {product} on {gke-brand-name}
:installing-on-gke-book-url: https://docs.redhat.com/en/documentation/red_hat_developer_hub/{product-version}/html-single/installing_red_hat_developer_hub_on_google_kubernetes_engine/index
:installing-in-air-gap-book-title: Installing {product} in an air-gapped environment
:installing-in-air-gap-book-url: https://docs.redhat.com/en/documentation/red_hat_developer_hub/{product-version}/html-single/installing_red_hat_developer_hub_in_an_air-gapped_environment/index

:upgrade-category-url: https://docs.redhat.com/en/documentation/red_hat_developer_hub/{product-version}/#Upgrade
:upgrading-book-url: https://docs.redhat.com/en/documentation/red_hat_developer_hub/{product-version}/html-single/upgrading_red_hat_developer_hub/index
:upgrading-book-title: Upgrading {product}

:configure-category-url: https://docs.redhat.com/en/documentation/red_hat_developer_hub/{product-version}/#Configure
:configuring-book-url: https://docs.redhat.com/documentation/en-us/red_hat_developer_hub/{product-version}/html-single/configuring_red_hat_developer_hub/index
:configuring-book-title: Configuring {product}
:customizing-book-url: https://docs.redhat.com/documentation/en-us/red_hat_developer_hub/{product-version}/html-single/customizing_red_hat_developer_hub/index
:customizing-book-title: Customizing {product}
:techdocs-book-url: https://docs.redhat.com/documentation/en-us/red_hat_developer_hub/{product-version}/html-single/techdocs_for_red_hat_developer_hub/index
:techdocs-book-title: TechDocs for {product}

:control-access-category-url: https://docs.redhat.com/en/documentation/red_hat_developer_hub/{product-version}/#Control access
:authentication-book-url: https://docs.redhat.com/documentation/en-us/red_hat_developer_hub/{product-version}/html-single/authentication_in_red_hat_developer_hub/index
:authentication-book-title: Authentication in {product}
:authorization-book-url: https://docs.redhat.com/documentation/en-us/red_hat_developer_hub/{product-version}/html-single/authorization_in_red_hat_developer_hub/index
:authorization-book-title: Authorization in {product}

:observability-category-url: https://docs.redhat.com/en/documentation/red_hat_developer_hub/{product-version}/#Observability
:audit-log-book-url: https://docs.redhat.com/en/documentation/red_hat_developer_hub/{product-version}/html-single/audit_logs_in_red_hat_developer_hub/index
:audit-log-book-title: Audit logs in {product}
:monitoring-and-logging-book-url: https://docs.redhat.com/en/documentation/red_hat_developer_hub/{product-version}/html-single/monitoring_and_logging/index
:monitoring-and-logging-book-title: Monitoring and logging
:telemetry-data-collection-book-url: https://docs.redhat.com/en/documentation/red_hat_developer_hub/{product-version}/html-single/telemetry_data_collection/index
:telemetry-data-collection-book-title: Telemetry data collection

:audit-log-book-url: https://docs.redhat.com/en/documentation/red_hat_developer_hub/{product-version}/html-single/audit_log/index
:audit-log-book-title: Audit log
:extend-category-url: https://docs.redhat.com/en/documentation/red_hat_developer_hub/{product-version}/#Extend
:introduction-to-plugins-book-url: https://docs.redhat.com/en/documentation/red_hat_developer_hub/{product-version}/html-single/introduction_to_plugins/index
:introduction-to-plugins-book-title: Introduction to plugins
:configuring-dynamic-plugins-book-url: https://docs.redhat.com/en/documentation/red_hat_developer_hub/{product-version}/html-single/introduction_to_plugins/index
:configuring-dynamic-plugins-book-title: Configuring dynamic plugins
:installing-and-viewing-plugins-book-url: https://docs.redhat.com/en/documentation/red_hat_developer_hub/{product-version}/html-single/installing_and_viewing_plugins_in_red_hat_developer_hub/index
:installing-and-viewing-plugins-book-title: Installing and viewing plugins in {product}
:using-dynamic-plugins-book-url: https://docs.redhat.com/en/documentation/red_hat_developer_hub/{product-version}/html-single/installing_and_viewing_plugins_in_red_hat_developer_hub/index
:using-dynamic-plugins-book-title: Using dynamic plugins
:dynamic-plugins-reference-book-url: https://docs.redhat.com/en/documentation/red_hat_developer_hub/{product-version}/html-single/dynamic_plugins_reference/index
:dynamic-plugins-reference-book-title: Dynamic plugins reference

:monitoring-and-logging-book-url: https://docs.redhat.com/en/documentation/red_hat_developer_hub/{product-version}/html-single/monitoring_and_logging/index
:monitoring-and-logging-book-title: Monitoring and logging

:plugins-configure-book-url: https://docs.redhat.com/en/documentation/red_hat_developer_hub/{product-version}/html-single/configuring_dynamic_plugins/index
:plugins-configure-book-title: Configuring dynamic plugins

Original file line number Diff line number Diff line change
Expand Up @@ -73,6 +73,6 @@ global:
[role="_additional-resources"]
.Additional resources

* The package path, scope, and name of the {company-name} ArgoCD plugin has changed since 1.2. For more information, see link:{release-notes-url}#removed-functionality-rhidp-4293[Breaking Changes] in the _{rn-product-title}_.
* The package path, scope, and name of the {company-name} ArgoCD plugin has changed since 1.2. For more information, see link:{release-notes-book-url}#removed-functionality-rhidp-4293[Breaking Changes] in the _{release-notes-book-title}_.

* For more information on installing dynamic plugins, see link:{installing-and-viewing-dynamic-plugins-url}[{installing-and-viewing-dynamic-plugins-title}].
* For more information on installing dynamic plugins, see link:{installing-and-viewing-plugins-book-url}[{installing-and-viewing-plugins-book-title}].
Original file line number Diff line number Diff line change
Expand Up @@ -33,4 +33,4 @@ image::rhdh-plugins-reference/deployment_summary.png[Deployment summary]
[role="_additional-resources"]
.Additional resources

* For more information on installing dynamic plugins, see link:{installing-and-viewing-dynamic-plugins-url}[{installing-and-viewing-dynamic-plugins-title}].
* For more information on installing dynamic plugins, see link:{installing-and-viewing-plugins-book-url}[{installing-and-viewing-plugins-book-title}].
Original file line number Diff line number Diff line change
Expand Up @@ -31,4 +31,4 @@ image::rhdh-plugins-reference/deployment_summary.png[Deployment summary]
[role="_additional-resources"]
.Additional resources

* For more information on installing dynamic plugins, see link:{installing-and-viewing-dynamic-plugins-url}[{installing-and-viewing-dynamic-plugins-title}].
* For more information on installing dynamic plugins, see link:{installing-and-viewing-plugins-book-url}[{installing-and-viewing-plugins-book-title}].
2 changes: 1 addition & 1 deletion assemblies/assembly-configuring-techdocs.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ After you configure {odf-name} to store the files that TechDocs generates, you c
[role="_additional-resources"]
.Additional resources

* For more information, see link:{LinkPluginsGuide}[Configuring plugins in {product}].
* For more information, see link:{configuring-dynamic-plugins-url}[{configuring-dynamic-plugins-title}].

include::modules/customizing-techdocs/con-techdocs-configure-storage.adoc[leveloffset=+1]

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ include::../modules/dynamic-plugins/ref-rh-supported-plugins.adoc[leveloffset=+3

[NOTE]
====
* For more information about configuring KeyCloak, see link:{plugins-configure-book-url}[{plugins-configure-book-title}].
* For more information about configuring KeyCloak, see link:{configuring-dynamic-plugins-url}[{configuring-dynamic-plugins-book-title}].

* For more information about configuring TechDocs, see link:{customizing-book-url}#configuring-techdocs[Configuring TechDocs].
====
Expand All @@ -29,7 +29,7 @@ include::../modules/dynamic-plugins/ref-rh-tech-preview-plugins.adoc[leveloffset

[NOTE]
====
* A new Technology Preview plugin for Red Hat Ansible Automation Platform (RHAAP) is available, which replaces this older one. See link:{LinkPluginsGuide}#rhdh-compatible-plugins[Other installable plugins] in the _{NameOfPluginsGuide} guide_ for further details. See xref:rhdh-compatible-plugins[Dynamic plugins support matrix].
* A new Technology Preview plugin for Red Hat Ansible Automation Platform (RHAAP) is available, which replaces this older one. See link:{configuring-dynamic-plugins-url}#rhdh-compatible-plugins[Other installable plugins] in _{configuring-dynamic-plugins-book-title}_ for further details. See xref:rhdh-compatible-plugins[Dynamic plugins support matrix].
====

// Community plugins
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -51,7 +51,7 @@ TIP: If you plan to make changes using the GitHub API, ensure that `Read and wri
* **Private key**
* **Webhook secret**

. To add your GitHub credentials to {product-short}, add the following key/value pairs to link:{plugins-configure-book-url}#provisioning-your-custom-configuration[your {product-short} secrets]:
. To add your GitHub credentials to {product-short}, add the following key/value pairs to link:{configuring-dynamic-plugins-url}#provisioning-your-custom-configuration[your {product-short} secrets]:
+
`AUTH_GITHUB_APP_ID`:: Enter the saved **App ID**.
`AUTH_GITHUB_CLIENT_ID`:: Enter the saved **Client ID**.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,7 @@ To grant administrator consent, a directory administrator must go to the link:ht
- **Application (client) ID**
- **Application (client) secret**

. To add your Microsoft Azure credentials to {product-short}, add the following key/value pairs to link:{plugins-configure-book-url}#provisioning-your-custom-configuration[your {product-short} secrets]:
. To add your Microsoft Azure credentials to {product-short}, add the following key/value pairs to link:{configuring-dynamic-plugins-url}#provisioning-your-custom-configuration[your {product-short} secrets]:
+
`AUTH_AZURE_TENANT_ID`:: Enter your saved *Directory (tenant) ID*.
`AUTH_AZURE_CLIENT_ID`:: Enter your saved *Application (client) ID*.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ Save the value for the next step:

.. To prepare for the verification steps, in the same realm, get the credential information for an existing user or link:https://docs.redhat.com/en/documentation/red_hat_build_of_keycloak/24.0/html-single/getting_started_guide/index#getting-started-zip-create-a-user[create a user]. Save the user credential information for the verification steps.

. To add your {rhsso} credentials to your {product-short}, add the following key/value pairs to link:{plugins-configure-book-url}#provisioning-your-custom-configuration[your {product-short} secrets]:
. To add your {rhsso} credentials to your {product-short}, add the following key/value pairs to link:{configuring-dynamic-plugins-url}#provisioning-your-custom-configuration[your {product-short} secrets]:
+
`AUTH_OIDC_CLIENT_ID`:: Enter the saved **Client ID**.
`AUTH_OIDC_CLIENT_SECRET`:: Enter the saved **Client Secret**.
Expand Down
2 changes: 1 addition & 1 deletion modules/authorization/proc-enabling-the-rbac-plugin.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ plugins:
disabled: false
----
+
See link:{installing-and-viewing-dynamic-plugins-url}[{installing-and-viewing-dynamic-plugins-title}].
See link:{installing-and-viewing-plugins-book-url}[{installing-and-viewing-plugins-book-title}].

. 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.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -87,6 +87,6 @@ Consider provisioning additional config maps and secrets:
* To use an external PostgreSQL database, xref:configuring-external-postgresql-databases[provision your PostgreSQL database secrets].


* To enable dynamic plugins, link:{installing-and-viewing-dynamic-plugins-url}[provision your dynamic plugins config map].
* To enable dynamic plugins, link:{installing-and-viewing-plugins-book-url}[provision your dynamic plugins config map].

* To configure authorization by using external files, link:{authorization-book-url}#managing-authorizations-by-using-external-files[provision your RBAC policies config map].
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
[id='proc-customize-rhdh-tech-radar-page_{context}']
= Customizing the Tech Radar page in {product}

In {product}, the Tech Radar page is provided by the `tech-radar` dynamic plugin, which is disabled by default. For information about enabling dynamic plugins in {product} see link:{LinkPluginsGuide}[Configuring plugins in {product}].
In {product}, the Tech Radar page is provided by the `tech-radar` dynamic plugin, which is disabled by default. For information about enabling dynamic plugins in {product} see link:{configuring-dynamic-plugins-url}[{configuring-dynamic-plugins-title}].

In {product}, you can configure Learning Paths by passing the data into the `app-config.yaml` file as a proxy. The base Tech Radar URL must include the `/developer-hub/tech-radar` proxy.

Expand Down Expand Up @@ -33,7 +33,7 @@ To access the data from the JSON files, complete the following step:
+
[source,yaml]
----
techRadar:
techRadar:
url: ${TECH_RADAR_DATA_URL} <1>
----
<1> `TECH_RADAR_DATA_URL` is the URL from which the JSON data is loaded.
Expand All @@ -59,16 +59,16 @@ To use a separate service to provide the Tech Radar data, complete the following
+
[source,yaml]
----
backend:
reading:
allow:
backend:
reading:
allow:
- host: 'hostname'
----
. Add the following to the `app-config.yaml` file:
+
[source,yaml]
----
techRadar:
techRadar:
url: ${TECH_RADAR_DATA_URL} <1>
----
<1> `TECH_RADAR_DATA_URL` is the URL from which the JSON data is loaded.
<1> `TECH_RADAR_DATA_URL` is the URL from which the JSON data is loaded.
Loading
Loading