Skip to content
Merged
Show file tree
Hide file tree
Changes from 1 commit
Commits
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
23 changes: 14 additions & 9 deletions artifacts/attributes.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -65,30 +65,35 @@

:LinkGettingStartedGuide: https://access.redhat.com/documentation/en-us/red_hat_developer_hub/{product-version}/html-single/getting_started_with_red_hat_developer_hub/index

:LinkInstallationGuide: https://docs.redhat.com/en/documentation/red_hat_developer_hub/{product-version}/html-single/installing_red_hat_developer_hub_on_openshift_container_platform/index

: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}

:LinkRHIDPIssue: https://issues.redhat.com/browse/
: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

:installing-on-ocp-book-url: https://docs.redhat.com/en/documentation/red_hat_developer_hub/1.2/html/installing_red_hat_developer_hub_on_openshift_container_platform/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-ocp-book-title: Installing {product} on {ocp-short}

:installing-on-eks-book-url: https://docs.redhat.com/en/documentation/red_hat_developer_hub/1.2/html/installing_red_hat_developer_hub_on_amazon_elastic_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-eks-book-title: Installing {product} on {eks-brand-name}

:installing-on-aks-book-url: https://docs.redhat.com/en/documentation/red_hat_developer_hub/1.2/html/installing_red_hat_developer_hub_on_microsoft_azure_kubernetes_service/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-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/1.2/html/installing_red_hat_developer_hub_in_an_air-gapped_environment/index
: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-in-air-gap-book-title: Installing {product} in an air-gapped environment

:upgrading-book-url: https://docs.redhat.com/en/documentation/red_hat_developer_hub/1.2/html/upgrading_red_hat_developer_hub/index
:upgrading-book-title: Upgrading {product}
: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}

: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
4 changes: 2 additions & 2 deletions modules/admin/proc-rbac-send-request-rbac-rest-api.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -6,8 +6,8 @@ The RBAC REST API enables you to interact with the permission policies and roles
.Prerequisites

* {product} is installed and running.
//For more information about installing {product}, see xref:proc-install-rhdh-ocp-helm_{context}[].
//replace with a link to the installation guide.

For more information about installing {product}, see link:{installing-on-ocp-book-url}#assembly-install-rhdh-ocp-helm[Installing Red Hat Developer Hub on OpenShift Container Platform with the Helm chart].

* You have access to the {product-short}.

Expand Down
7 changes: 5 additions & 2 deletions modules/admin/proc-rhdh-monitoring-logging-aks.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -23,8 +23,11 @@ You can access live data logs generated by Kubernetes objects and collect log da
.Prerequisites

* You have deployed {product-short} on {aks-short}.
//For more information, see xref:proc-rhdh-deploy-aks_{context}[].
//replace with a link to the installation guide.

For more information, see xref:{installing-on-aks-book-url}#assembly-install-rhdh-aks[Installing Red Hat Developer Hub on Azure Kubernetes Service (AKS)].


assembly-install-rhdh-aks.adoc

.Procedure

Expand Down
13 changes: 7 additions & 6 deletions modules/admin/proc-using-azure-auth-provider.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -6,15 +6,16 @@ The `core-plugin-api` package in {product-short} comes integrated with Microsoft

.Prerequisites
* You have deployed {product-short} on AKS.
//For more information, see xref:proc-rhdh-deploy-aks_{context}[].
//replace with a link to the installation guide.

For more information, see xref:{installing-on-aks-book-url}#assembly-install-rhdh-aks[Installing Red Hat Developer Hub on Azure Kubernetes Service (AKS)].

* You have created registered your application in Azure portal. For more information, see https://learn.microsoft.com/en-us/entra/identity-platform/quickstart-register-app[Register an application with the Microsoft identity platform].

== Using Microsoft Azure as an authentication provider in Helm deployment

You can use Microsoft Azure as an authentication provider in {product}, when installed using the Helm Chart.
//For more information, see xref:proc-rhdh-deploy-aks-helm_{context}[].
//replace with a link to the installation guide.

For more information, see xref:{installing-on-aks-book-url}#proc-rhdh-deploy-aks-helm_assembly-install-rhdh-aks[Deploying Developer Hub on AKS with the Helm chart].

.Procedure

Expand Down Expand Up @@ -113,8 +114,8 @@ kubectl -n <your_namespace> delete pods -l backstage.io/app=backstage-<your-rhdh
== Using Microsoft Azure as an authentication provider in Operator-backed deployment

You can use Microsoft Azure as an authentication provider in {product}, when installed using the Operator.
//For more information, see xref:proc-install-rhdh-ocp-operator_{context}[].
//replace with a link to the installation guide.

For more information, see xref:{installing-on-ocp-book-url}#proc-install-operator_assembly-install-rhdh-ocp-operator[Installing Red Hat Developer Hub on OpenShift Container Platform with the Operator].

.Procedure

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -8,8 +8,8 @@ To populate the Catalog in {product}, you need to add software templates, and to
* You have a GitHub account.
* You have an account on the Red Hat OpenShift cluster.
* You have installed the {product-short}, otherwise the GitHub login fails.
//For more information about installation, see xref:proc-install-rhdh_{context}[].
//replace with link to installation guide.

For more information about installation, see xref:{installing-on-ocp-book-url}/#assembly-install-rhdh-ocp[Installing Red Hat Developer Hub on OpenShift Container Platform].

== Configuring GitHub authentication

Expand Down
6 changes: 2 additions & 4 deletions modules/getting-started/proc-customize-rhdh-homepage.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -11,9 +11,8 @@ To access the Home page in {product}, the base URL must include the `/developer-
.Prerequisites

You have installed {product} by using either the Operator or Helm chart.
//For more information, see xref:proc-install-rhdh_rhdh-getting-started[].
//replace with link to installation guide.

For more information, see xref:{installing-on-ocp-book-url}#assembly-install-rhdh-ocp[{installing-on-ocp-book-title}].

.Procedure

Expand Down Expand Up @@ -49,8 +48,7 @@ When using a dedicated service, you can do the following:
.Prerequisites

* You have installed the {product} using Helm Chart.
//For more information, see xref:proc-install-rhdh_{context}[].
//replace with link to the installation guide.
For more information, see xref:{installing-on-ocp-book-url}#assembly-install-rhdh-ocp-helm[Installing Red Hat Developer Hub on OpenShift Container Platform with the Helm chart].

.Procedure

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -20,8 +20,7 @@ You can provide data to the Learning Path from the following sources:
.Prerequisites

You have installed {product} by using either the Operator or Helm chart.
//For more information, see xref:proc-install-rhdh_rhdh-getting-started[].
//replace with link to installation guide.
For more information, see xref:{installing-on-ocp-book-url}#assembly-install-rhdh-ocp[{installing-on-ocp-book-title}].

.Procedure

Expand Down Expand Up @@ -54,8 +53,7 @@ When using a dedicated service, you can do the following:
.Prerequisites

* You have installed the {product} using Helm chart.
//For more information, see xref:proc-install-rhdh_rhdh-getting-started[].
//replace with link to installation guide.
For more information, see xref:{installing-on-ocp-book-url}#assembly-install-rhdh-ocp[{installing-on-ocp-book-title}].

.Procedure

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -22,8 +22,7 @@ You can provide data to the Tech Radar page from the following sources:
.Prerequisites

You have installed {product} by using either the Operator or Helm chart.
//For more information, see xref:proc-install-rhdh_rhdh-getting-started[].
//replace with link to installation guide.
For more information, see xref:{installing-on-ocp-book-url}#assembly-install-rhdh-ocp[{installing-on-ocp-book-title}].

.Procedure

Expand Down Expand Up @@ -61,8 +60,7 @@ When using a dedicated service, you can do the following:
.Prerequisites

* You have installed the {product} using Helm Chart.
//For more information, see xref:proc-install-rhdh_{context}[].
//replace with link to the installation guide.
For more information, see xref:{installing-on-ocp-book-url}#assembly-install-rhdh-ocp-helm[{installing-on-ocp-book-title} with the Helm chart].

.Procedure

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -6,8 +6,7 @@ In {product}, the ServiceNow custom actions are provided as a pre-loaded plugin,
.Prerequisites

* {product} is installed and running.
//For more information about installing the {product-short}, see xref:proc-install-rhdh_{context}[].
//replace with link to the installation guide.
For more information about installing the {product-short}, see xref:{installing-on-ocp-book-url}#assembly-install-rhdh-ocp-helm[{installing-on-ocp-book-title} with the Helm chart].
* You have created a project in the {product-short}.

.Procedure
Expand Down
3 changes: 1 addition & 2 deletions modules/installation/proc-enable-signin.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -63,8 +63,7 @@ The {product} supports the following authentication providers:
.Prerequisites

* You have installed the {product-short}.
//For more information about installation, see xref:proc-install-rhdh_{context}[].
//replace with link to the installation guide.
For more information about installation, see xref:{installing-on-ocp-book-url}#assembly-install-rhdh-ocp-helm[{installing-on-ocp-book-title} with the Helm chart].

.Procedure

Expand Down
3 changes: 1 addition & 2 deletions modules/upgrade/proc-upgrade-rhdh-operator.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -37,6 +37,5 @@ If there is no upgrade available, the *Upgrade status* field value is *Up to dat
[role="_additional-resources"]
.Additional resources

//* xref:proc-install-rhdh-ocp-operator_{context}[Deploying {product} on {ocp-short} with the Operator]
//replace with a link to the installation guide.
* xref:{installing-on-ocp-book-url}#proc-install-operator_assembly-install-rhdh-ocp-operator[Installing Red Hat Developer Hub on OpenShift Container Platform with the Operator].
* link:https://docs.openshift.com/container-platform/{ocp-version}/operators/admin/olm-adding-operators-to-cluster.html#olm-installing-from-operatorhub-using-web-console_olm-adding-operators-to-a-cluster[Installing from OperatorHub using the web console]