Skip to content

Commit 57dd60e

Browse files
author
GitHub Actions
committed
Move links in Prerequisites to Additional resources-Customizing
1 parent c12f7a6 commit 57dd60e

11 files changed

+54
-15
lines changed

modules/customizing-techdocs/proc-techdocs-configure-odf-helm.adoc

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ These variables are then used in the TechDocs plugin configuration.
1717
.Prerequisites
1818

1919
* You have installed {product} on {ocp-short} using the Helm chart.
20-
* 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]
20+
* You have created an `ObjectBucketClaim` CR for storing files generated by TechDocs.
2121
2222
.Procedure
2323

@@ -32,3 +32,8 @@ upstream:
3232
extraEnvVarsCM:
3333
- <rhdh_bucket_claim_name>
3434
----
35+
36+
[role="_additional-resources"]
37+
.Additional resources
38+
39+
* xref:proc-techdocs-using-odf-storage_{context}[Using {odf-name} for file storage]

modules/customizing-techdocs/proc-techdocs-using-odf-storage.adoc

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -8,8 +8,8 @@ You can configure {odf-name} to store the files that TechDocs generates instead
88

99
.Prerequisites
1010

11-
* 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].
12-
* 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].
11+
* An {ocp-short} administrator has installed the {odf-name} Operator in {ocp-brand-name}.
12+
* An {ocp-short} administrator has created an {odf-name} cluster and configured the `StorageSystem` schema.
1313
1414
.Procedure
1515

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

3939
* 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].
40+
* 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]
41+
* 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]

modules/customizing-the-appearance/proc-customizing-entity-detail-tab-layout.adoc

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ For consistency with your organization needs, you can change the entity detail t
66

77
.Prerequisites
88

9-
* 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].
9+
* The plugin that contributes the tab content allows a configuration, such as {product-short} plugins defining a default configuration in a `config` section.
1010

1111
.Procedure
1212

@@ -48,3 +48,8 @@ Copy the import name defined in the plugin default configuration, such as: `Tekt
4848
The tab content is displayed in a responsive grid that uses a 12 column-grid and supports different breakpoints (`xs`,
4949
`sm`, `md`, `lg`, `xl`) that can be specified for a CSS property, such as `gridColumn`.
5050
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).
51+
52+
[role="_additional-resources"]
53+
.Additional resources
54+
55+
* 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]

modules/customizing-the-learning-paths/proc-customizing-the-learning-paths-by-using-hosted-json-files.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -46,4 +46,4 @@ proxy:
4646
====
4747

4848
.Additional resources
49-
* xref:customizing-the-home-page[Customizing the Home page in {product}].
49+
* xref:customizing-the-home-page[Customizing the Home page in {product}]

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

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,6 @@ When using a dedicated service, you can do the following tasks:
1515
.Prerequisites
1616

1717
* You have installed the {product} using Helm chart.
18-
For more information, see xref:{installing-on-ocp-book-url}#assembly-install-rhdh-ocp-helm[{installing-on-ocp-book-title} with the Helm chart].
1918

2019
.Procedure
2120

@@ -136,4 +135,7 @@ data:
136135
# Other Configurations
137136
----
138137

138+
[role="_additional-resources"]
139+
.Additional resources
139140

141+
* xref:{installing-on-ocp-book-url}#assembly-install-rhdh-ocp-helm[{installing-on-ocp-book-title} with the Helm chart]

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

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,6 @@
99
.Prerequisites
1010

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

1413
.Procedure
1514

@@ -32,4 +31,9 @@ proxy:
3231
# Change to "false" in case of using self hosted cluster with a self-signed certificate
3332
headers:
3433
<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
35-
----
34+
----
35+
36+
[role="_additional-resources"]
37+
.Additional resources
38+
39+
* xref:{installing-on-ocp-book-url}#assembly-install-rhdh-ocp[{installing-on-ocp-book-title}]

modules/customizing-the-tech-radar-page/proc-customizing-the-tech-radar-page-by-using-a-customization-service.adoc

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,8 +6,6 @@ You can even use a different service for each page.
66

77
.Prerequisites
88
* You have specified the data sources for the Tech Radar plugin in the `integrations` section of the `{my-app-config-file}` file.
9-
For example, to configure GitHub as an integration, see link:{authentication-book-url}#enabling-user-authentication-with-github[Authenticating with GitHub].
10-
119
* You have enabled the `./dynamic-plugins/dist/backstage-community-plugin-tech-radar` and `/dynamic-plugins/dist/backstage-community-plugin-tech-radar-backend-dynamic` plugins.
1210

1311
.Procedure
@@ -35,3 +33,8 @@ techRadar:
3533
----
3634

3735
`_<tech_radar_data_url>_`:: Enter your Tech Radar data URL, such as: `pass:c,a,q[http://_<rhdh-customization-provider>_/tech-radar]`.
36+
37+
[role="_additional-resources"]
38+
.Additional resources
39+
40+
* link:{authentication-book-url}#enabling-user-authentication-with-github[Authenticating with GitHub]

modules/customizing-the-tech-radar-page/proc-customizing-the-tech-radar-page-by-using-a-json-file.adoc

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,8 +5,7 @@ For ease of use and simplicity, you can configure the Tech Radar page by using a
55

66
.Prerequisites
77

8-
* 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].
9-
8+
* You have specified the data sources for the Tech Radar plugin in the `integrations` section of the `{my-app-config-file}` file.
109
* You have enabled the `./dynamic-plugins/dist/backstage-community-plugin-tech-radar` and `/dynamic-plugins/dist/backstage-community-plugin-tech-radar-backend-dynamic` plugins.
1110

1211
.Procedure
@@ -22,3 +21,8 @@ techRadar:
2221
----
2322

2423
`_<tech_radar_data_url>_`:: Enter the Tech Radar data hosted JSON URL.
24+
25+
[role="_additional-resources"]
26+
.Additional resources
27+
28+
* link:{authentication-book-url}#enabling-user-authentication-with-github[Configuring GitHub as an integration]

modules/customizing/proc-customizing-the-backend-secret.adoc

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ The default {product} configuration defines the {product-short} backend secret f
66
You can define your custom {product-short} backend secret.
77

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

1111
.Procedure
1212

@@ -37,3 +37,7 @@ backend:
3737
secret: "${BACKEND_SECRET}"
3838
----
3939

40+
[role="_additional-resources"]
41+
.Additional resources
42+
43+
* link:{configuring-book-url}[Adding a custom {product-short} application configuration]

modules/customizing/proc-customizing-your-product-base-url.adoc

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ You can change the default {product} base URL.
55

66
.Prerequisites
77
* 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.
8-
* link:{configuring-book-url}[Custom {product-short} configuration].
8+
* Custom {product-short} configuration.
99

1010
.Procedure
1111
* In your custom `{my-app-config-file}` file, enter your {product-short} external URL, such as pass:c,a,q[{my-product-url}].
@@ -20,3 +20,8 @@ backend:
2020
cors:
2121
origin: {my-product-url}
2222
----
23+
24+
[role="_additional-resources"]
25+
.Additional resources
26+
27+
* link:{configuring-book-url}[Custom {product-short} configuration]

0 commit comments

Comments
 (0)