Skip to content
Closed
Show file tree
Hide file tree
Changes from all commits
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
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ These variables are then used in the TechDocs plugin configuration.
.Prerequisites

* You have installed {product} on {ocp-short} using the Helm chart.
* You have created an `ObjectBucketClaim` CR for storing files generated by TechDocs. For more information see xref:proc-techdocs-using-odf-storage_{context}[Using {odf-name} for file storage]
* You have created an `ObjectBucketClaim` CR for storing files generated by TechDocs.

.Procedure

Expand All @@ -32,3 +32,8 @@ upstream:
extraEnvVarsCM:
- <rhdh_bucket_claim_name>
----

[role="_additional-resources"]
.Additional resources

* xref:proc-techdocs-using-odf-storage_{context}[Using {odf-name} for file storage]
Original file line number Diff line number Diff line change
Expand Up @@ -8,8 +8,8 @@ You can configure {odf-name} to store the files that TechDocs generates instead

.Prerequisites

* An {ocp-short} administrator has installed the {odf-name} Operator in {ocp-brand-name}. For more information, see link:https://access.redhat.com/documentation/en-us/red_hat_openshift_data_foundation/4.15/html/deploying_openshift_data_foundation_using_amazon_web_services/deploy-using-dynamic-storage-devices-aws#installing-openshift-data-foundation-operator-using-the-operator-hub_cloud-storage[{ocp-short} - Installing {company-name} {odf-name} Operator].
* An {ocp-short} administrator has created an {odf-name} cluster and configured the `StorageSystem` schema. For more information, see link:https://access.redhat.com/documentation/en-us/red_hat_openshift_data_foundation/latest/html/deploying_openshift_data_foundation_using_amazon_web_services/deploy-using-dynamic-storage-devices-aws#creating-an-openshift-data-foundation-service_cloud-storage[{ocp-short} - Creating an {odf-name} cluster].
* An {ocp-short} administrator has installed the {odf-name} Operator in {ocp-brand-name}.
* An {ocp-short} administrator has created an {odf-name} cluster and configured the `StorageSystem` schema.

.Procedure

Expand Down Expand Up @@ -37,3 +37,5 @@ After you create the `ObjectBucketClaim` CR, you can use the information stored
.Additional resources

* For more information about the Object Bucket Claim, see link:https://access.redhat.com/documentation/en-us/red_hat_openshift_data_foundation/4.12/html/managing_hybrid_and_multicloud_resources/object-bucket-claim#doc-wrapper[{ocp-short} - Object Bucket Claim].
* link:https://access.redhat.com/documentation/en-us/red_hat_openshift_data_foundation/4.15/html/deploying_openshift_data_foundation_using_amazon_web_services/deploy-using-dynamic-storage-devices-aws#installing-openshift-data-foundation-operator-using-the-operator-hub_cloud-storage[{ocp-short} - Installing {company-name} {odf-name} Operator]
* link:https://access.redhat.com/documentation/en-us/red_hat_openshift_data_foundation/latest/html/deploying_openshift_data_foundation_using_amazon_web_services/deploy-using-dynamic-storage-devices-aws#creating-an-openshift-data-foundation-service_cloud-storage[{ocp-short} - Creating an {odf-name} cluster]
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ For consistency with your organization needs, you can change the entity detail t

.Prerequisites

* The plugin that contributes the tab content allows a configuration, such as https://github.com/redhat-developer/rhdh/blob/release-{product-version}/dynamic-plugins.default.yaml[{product-short} plugins defining a default configuration in a `config` section].
* The plugin that contributes the tab content allows a configuration, such as {product-short} plugins defining a default configuration in a `config` section.

.Procedure

Expand Down Expand Up @@ -48,3 +48,8 @@ Copy the import name defined in the plugin default configuration, such as: `Tekt
The tab content is displayed in a responsive grid that uses a 12 column-grid and supports different breakpoints (`xs`,
`sm`, `md`, `lg`, `xl`) that can be specified for a CSS property, such as `gridColumn`.
The example uses 6 of the 12 columns to show two Tekton CI cards side-by-side on large (`lg`) screens (`span 6` columns) and show them among themselves (`xs` and above `span 12` columns).

[role="_additional-resources"]
.Additional resources

* link:https://github.com/redhat-developer/rhdh/blob/release-{product-version}/dynamic-plugins.default.yaml[{product-short} plugins defining a default configuration in a `config` section]
Original file line number Diff line number Diff line change
Expand Up @@ -46,4 +46,4 @@ proxy:
====

.Additional resources
* xref:customizing-the-home-page[Customizing the Home page in {product}].
* xref:customizing-the-home-page[Customizing the Home page in {product}]
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,6 @@ 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-url}#assembly-install-rhdh-ocp-helm[{installing-on-ocp-book-title} with the Helm chart].

.Procedure

Expand Down Expand Up @@ -136,4 +135,7 @@ data:
# Other Configurations
----

[role="_additional-resources"]
.Additional resources

* xref:{installing-on-ocp-book-url}#assembly-install-rhdh-ocp-helm[{installing-on-ocp-book-title} with the Helm chart]
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,6 @@
.Prerequisites

* You have installed {product} by using either the Operator or Helm chart.
See xref:{installing-on-ocp-book-url}#assembly-install-rhdh-ocp[{installing-on-ocp-book-title}].

.Procedure

Expand All @@ -32,4 +31,9 @@ proxy:
# Change to "false" in case of using self hosted cluster with a self-signed certificate
headers:
<HEADER_KEY>: <HEADER_VALUE> # optional and can be passed as needed i.e Authorization can be passed for private GitHub repo and PRIVATE-TOKEN can be passed for private GitLab repo
----
----

[role="_additional-resources"]
.Additional resources

* xref:{installing-on-ocp-book-url}#assembly-install-rhdh-ocp[{installing-on-ocp-book-title}]
Original file line number Diff line number Diff line change
Expand Up @@ -6,8 +6,6 @@ You can even use a different service for each page.

.Prerequisites
* You have specified the data sources for the Tech Radar plugin in the `integrations` section of the `{my-app-config-file}` file.
For example, to configure GitHub as an integration, see link:{authentication-book-url}#enabling-user-authentication-with-github[Authenticating with GitHub].

* You have enabled the `./dynamic-plugins/dist/backstage-community-plugin-tech-radar` and `/dynamic-plugins/dist/backstage-community-plugin-tech-radar-backend-dynamic` plugins.

.Procedure
Expand Down Expand Up @@ -35,3 +33,8 @@ techRadar:
----

`_<tech_radar_data_url>_`:: Enter your Tech Radar data URL, such as: `pass:c,a,q[http://_<rhdh-customization-provider>_/tech-radar]`.

[role="_additional-resources"]
.Additional resources

* link:{authentication-book-url}#enabling-user-authentication-with-github[Authenticating with GitHub]
Original file line number Diff line number Diff line change
Expand Up @@ -5,8 +5,7 @@ For ease of use and simplicity, you can configure the Tech Radar page by using a

.Prerequisites

* You have specified the data sources for the Tech Radar plugin in the `integrations` section of the `{my-app-config-file}` file. For example, to configure GitHub as an integration, see link:{authentication-book-url}#enabling-user-authentication-with-github[Authenticating with GitHub].

* You have specified the data sources for the Tech Radar plugin in the `integrations` section of the `{my-app-config-file}` file.
* You have enabled the `./dynamic-plugins/dist/backstage-community-plugin-tech-radar` and `/dynamic-plugins/dist/backstage-community-plugin-tech-radar-backend-dynamic` plugins.

.Procedure
Expand All @@ -22,3 +21,8 @@ techRadar:
----

`_<tech_radar_data_url>_`:: Enter the Tech Radar data hosted JSON URL.

[role="_additional-resources"]
.Additional resources

* link:{authentication-book-url}#enabling-user-authentication-with-github[Configuring GitHub as an integration]
6 changes: 5 additions & 1 deletion modules/customizing/proc-customizing-the-backend-secret.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ The default {product} configuration defines the {product-short} backend secret f
You can define your custom {product-short} backend secret.

.Prerequisites
* You link:{configuring-book-url}[added a custom {product-short} application configuration], and have sufficient permissions to modify it.
* You added a custom {product-short} application configuration, and have sufficient permissions to modify it.

.Procedure

Expand Down Expand Up @@ -37,3 +37,7 @@ backend:
secret: "${BACKEND_SECRET}"
----

[role="_additional-resources"]
.Additional resources

* link:{configuring-book-url}[Adding a custom {product-short} application configuration]
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ You can change the default {product} base URL.

.Prerequisites
* You know your desired {product-short} external URL: pass:c,a,q[{my-product-url}], and have configured DNS to point to your {ocp-brand-name} cluster.
* link:{configuring-book-url}[Custom {product-short} configuration].
* Custom {product-short} configuration.

.Procedure
* In your custom `{my-app-config-file}` file, enter your {product-short} external URL, such as pass:c,a,q[{my-product-url}].
Expand All @@ -20,3 +20,8 @@ backend:
cors:
origin: {my-product-url}
----

[role="_additional-resources"]
.Additional resources

* link:{configuring-book-url}[Custom {product-short} configuration]
7 changes: 6 additions & 1 deletion modules/customizing/proc-customizing-your-product-title.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
You can change the default {product} display name.

.Prerequisites
* link:{configuring-book-url}[Custom {product-short} configuration].
* Custom {product-short} configuration.

.Procedure
* In your custom `{my-app-config-file}` file, enter your {product-short} instance display name, such as _<{product}>_.
Expand All @@ -15,3 +15,8 @@ You can change the default {product} display name.
app:
title: My custom {product} title
----

[role="_additional-resources"]
.Additional resources

* link:{configuring-book-url}[Custom {product-short} configuration]