Skip to content

Commit 348fa6a

Browse files
jmagakGitHub Actions
and
GitHub Actions
authored
RHIDP-5372- Fix inconsistent reference to the app config file (redhat-developer#914)
* Fix inconsistent reference to the app config file Fix inconsistent reference to the app config file Fix inconsistent reference to the app config file Fix inconsistent reference to the app config file Fix inconsistent reference to the app config file * Fix inconsistent reference to the app config file * Fix inconsistent reference to the app config file * Apply peer suggestions --------- Co-authored-by: GitHub Actions <[email protected]>
1 parent f7e9a1d commit 348fa6a

File tree

30 files changed

+94
-83
lines changed

30 files changed

+94
-83
lines changed

modules/authentication/proc-enabling-authentication-with-github.adoc

+6-7
Original file line numberDiff line numberDiff line change
@@ -63,10 +63,9 @@ TIP: If you plan to make changes using the GitHub API, ensure that `Read and wri
6363
`GITHUB_WEBHOOK_URL`:: Enter your {product-short} URL: `pass:c,a,q[{my-product-url}]`.
6464
`GITHUB_WEBHOOK_SECRET`:: Enter the saved *Webhook secret*.
6565

66-
. To set up the GitHub authentication provider and enable integration with the GitHub API in your {product-short} custom configuration, edit your custom {product-short} ConfigMap such as `app-config-rhdh`, and add the following lines to the `app-config-rhdh.yaml` content:
67-
.. Configure mandatory fields:
66+
. . To set up the GitHub authentication provider and enable integration with the GitHub API in your {product-short} custom configuration, edit your custom {product-short} config map such as `{my-app-config-config-map}`, and add the following lines to the `{my-app-config-file}` file content:
6867
+
69-
.`app-config-rhdh.yaml` fragment with mandatory fields to enable authentication with GitHub
68+
.`{my-app-config-file}` file fragment with mandatory fields to enable authentication with GitHub
7069
[source,yaml]
7170
----
7271
auth:
@@ -99,7 +98,7 @@ signInPage: github # <3>
9998
The callback URL that GitHub uses when initiating an OAuth flow, such as: __<your_intermediate_service_url/handler>__.
10099
Define it when {product-short} is not the immediate receiver, such as in cases when you use one OAuth app for many {product-short} instances.
101100
+
102-
.`app-config-rhdh.yaml` fragment with optional `enterpriseInstanceUrl` field
101+
.`{my-app-config-file}` file fragment with optional `enterpriseInstanceUrl` field
103102
[source,yaml,subs="+quotes"]
104103
----
105104
auth:
@@ -114,7 +113,7 @@ auth:
114113
Your GitHub Enterprise URL.
115114
Requires you defined the `GITHUB_HOST_DOMAIN` secret in the previous step.
116115
+
117-
.`app-config-rhdh.yaml` fragment with optional `enterpriseInstanceUrl` field
116+
.`{my-app-config-file}` file fragment with optional `enterpriseInstanceUrl` field
118117
[source,yaml,subs="+quotes"]
119118
----
120119
auth:
@@ -161,7 +160,7 @@ Configure the sign-in resolver to bypass the user provisioning requirement in th
161160
+
162161
WARNING: Use `dangerouslyAllowSignInWithoutUserInCatalog` to explore {product-short} features, but do not use it in production.
163162
+
164-
.`app-config-rhdh.yaml` fragment with optional field to allow signing in users absent from the software catalog
163+
.`{my-app-config-file}` file fragment with optional field to allow signing in users absent from the software catalog
165164
[source,yaml]
166165
----
167166
auth:
@@ -196,7 +195,7 @@ To enable GitHub integration with a different authentication provider, complete
196195
* Add the GitHub provider to the existing `auth` section.
197196
* Keep the `signInPage` section from your authentication provider configuration.
198197
199-
.`app-config-rhdh.yaml` fragment with mandatory fields to enable GitHub integration and use a different authentication provider
198+
.`{my-app-config-file}` file fragment with mandatory fields to enable GitHub integration and use a different authentication provider
200199
[source,yaml,subs="+quotes"]
201200
----
202201
auth:

modules/authentication/proc-enabling-authentication-with-microsoft-azure.adoc

+6-7
Original file line numberDiff line numberDiff line change
@@ -27,8 +27,7 @@
2727
* `openid`
2828
* `profile`
2929
* `User.Read`
30-
* Optional custom scopes for the Microsoft Graph API that you define both in this section and in the {product-short} configuration (`app-config-rhdh.yaml`).
31-
+
30+
* Optional custom scopes for the Microsoft Graph API that you define both in this section and in the `{my-app-config-file}` {product-short} configuration file.
3231
[NOTE]
3332
====
3433
Your company might require you to grant admin consent for these permissions.
@@ -50,10 +49,10 @@ To grant administrator consent, a directory administrator must go to the link:ht
5049
`AUTH_AZURE_CLIENT_ID`:: Enter your saved *Application (client) ID*.
5150
`AUTH_AZURE_CLIENT_SECRET`:: Enter your saved *Application (client) secret*.
5251

53-
. Set up the Microsoft Azure authentication provider in your {product-short} custom configuration, such as `app-config-rhdh`:
54-
.. Configure mandatory fields:
52+
. Set up the Microsoft Azure authentication provider in your `{my-app-config-file}` file:
5553
+
56-
.`app-config-rhdh.yaml` fragment
54+
--
55+
.`{my-app-config-file}` file fragment
5756
[source,yaml,subs="+quotes,+attributes"]
5857
----
5958
auth:
@@ -79,7 +78,7 @@ If you want to use this parameter for a single-tenant application, uncomment and
7978
If your application registration is multi-tenant, leave this parameter blank.
8079
For more information, see link:https://learn.microsoft.com/en-us/azure/active-directory/manage-apps/home-realm-discovery-policy[Home Realm Discovery].
8180
+
82-
.`app-config-rhdh.yaml` fragment with optional `domainHint` field
81+
.`{my-app-config-file}` file fragment with optional `domainHint` field
8382
[source,yaml,subs="+quotes,+attributes"]
8483
----
8584
auth:
@@ -95,7 +94,7 @@ Optional for additional scopes.
9594
To add scopes for the application registration, uncomment and enter the list of scopes that you want to add.
9695
The default and mandatory value lists: `'openid', 'offline_access', 'profile', 'email', 'User.Read'`.
9796
+
98-
.`app-config-rhdh.yaml` fragment with optional `additionalScopes` field
97+
.`{my-app-config-file}` file fragment with optional `additionalScopes` field
9998
[source,yaml,subs="+quotes,+attributes"]
10099
----
101100
auth:

modules/authorization/proc-configuring-the-RBAC-backend-plugin.adoc

+3-3
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,13 @@
11
[id="configuring-the-rbac-backend-plugin_{context}"]
22
= Configuring the RBAC backend plugin
33

4-
You can configure the RBAC backend plugin by updating the `app-config.yaml` file to enable the permission framework.
4+
You can configure the RBAC backend plugin by updating the `{my-app-config-file}` file to enable the permission framework.
55

66
.Prerequisites
77
* You have installed the `@janus-idp/backstage-plugin-rbac` plugin in {product-short}. For more information, see link:{plugins-configure-book-url}[{plugins-configure-book-title}].
88

99
.Procedure
10-
* Update the `app-config.yaml` file to enable the permission framework as shown:
10+
* Update the `{my-app-config-file}` file to enable the permission framework as shown:
1111

1212
[source,yaml,subs=+quotes]
1313
----
@@ -25,5 +25,5 @@ permission
2525

2626
[NOTE]
2727
====
28-
The `pluginsWithPermission` section of the `app-config.yaml` section includes only three plugins by default. Update the section as needed to include any additional plugins that also incorporate permissions.
28+
The `pluginsWithPermission` section of the `{my-app-config-file}` file includes only three plugins by default. Update the section as needed to include any additional plugins that also incorporate permissions.
2929
====

modules/authorization/proc-defining-authorizations-in-external-files-by-using-helm.adoc

+1-1
Original file line numberDiff line numberDiff line change
@@ -93,7 +93,7 @@ name::: `rbac-policies`
9393

9494
. Update your {product-short} `{my-app-config-file}` configuration file to use the `rbac-policies.csv` and `rbac-conditional-policies.yaml` external files:
9595
+
96-
.`app-config.yml` fragment
96+
.`{my-app-config-file}` file fragment
9797
[source,yaml]
9898
----
9999
permission:

modules/authorization/proc-defining-authorizations-in-external-files-by-using-the-operator.adoc

+2-2
Original file line numberDiff line numberDiff line change
@@ -90,9 +90,9 @@ spec:
9090
- name: rbac-policies
9191
----
9292

93-
. Update your {product-short} `app-config.yaml` configuration file to use the `rbac-policies.csv` and `rbac-conditional-policies.yaml` external files:
93+
. Update your {product-short} `{my-app-config-file}` configuration file to use the `rbac-policies.csv` and `rbac-conditional-policies.yaml` external files:
9494
+
95-
.`app-config.yml` fragment
95+
.`{my-app-config-file}` file fragment
9696
[source,yaml]
9797
----
9898
permission:

modules/authorization/proc-enabling-the-rbac-plugin.adoc

+1-1
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@ plugins:
2525
See link:{installing-and-viewing-plugins-book-url}[{installing-and-viewing-plugins-book-title}].
2626

2727
. 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.
28-
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.
28+
The permissions can be specified in a separate CSV file referenced in your `{my-app-config-config-map}` config map, or permissions can be created using the REST API or Web UI.
2929
+
3030
To declare users such as _<your_policy_administrator_name>_ as policy administrators, edit your custom {product-short} ConfigMap, such as `app-config-rhdh`, and add following code to the `{my-app-config-file}` content:
3131
+

modules/authorization/proc-setting-up-the-guest-authentication-provider.adoc

+2-2
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ You can enable guest authentication and use it alongside the RBAC frontend plugi
88

99
.Procedure
1010

11-
* In the `app-config.yaml` file, add the user entity reference to resolve and enable the `dangerouslyAllowOutsideDevelopment` option, as shown in the following example:
11+
* In the `{my-app-config-file}` file, add the user entity reference to resolve and enable the `dangerouslyAllowOutsideDevelopment` option, as shown in the following example:
1212

1313
[source,yaml,subs="+attributes,+quotes"]
1414
----
@@ -22,5 +22,5 @@ auth:
2222

2323
[NOTE]
2424
====
25-
You can use `user:default/guest` as the user entity reference to match the added user under the `permission.rbac.admin.users` section of the `app-config.yaml` file.
25+
You can use `user:default/guest` as the user entity reference to match the added user under the `permission.rbac.admin.users` section of the `{my-app-config-file}` file.
2626
====

modules/customizing-templates/proc-adding-templates.adoc

+1-1
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ You can add an existing template to your {product} instance by using the Catalog
1515
1616
.Procedure
1717

18-
* In the `app-config.yaml` configuration file, modify the `catalog.rules` section to include a rule for templates, and configure the `catalog.locations` section to point to the template that you want to add, as shown in the following example:
18+
* In the `{my-app-config-file}` configuration file, modify the `catalog.rules` section to include a rule for templates, and configure the `catalog.locations` section to point to the template that you want to add, as shown in the following example:
1919
+
2020
[source,yaml]
2121
----

modules/customizing-the-appearance/proc-customize-rhdh-branding-logo.adoc

+1-1
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55
[id="proc-customize-rhdh-branding-logo_{context}"]
66
= Customizing the branding logo of your {product-short} instance
77

8-
You can customize the branding logo of your {product-short} instance by configuring the `branding` section the `app-config-rhdh.yaml` file, as shown in the following example:
8+
You can customize the branding logo of your {product-short} instance by configuring the `branding` section the `{my-app-config-file}` file, as shown in the following example:
99

1010
[source,yaml]
1111
----

modules/customizing-the-appearance/proc-customize-rhdh-font.adoc

+1-1
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44
[id="proc-customize-rhdh-font_{context}"]
55
= Customizing the font for your {product-short} instance
66

7-
You can configure the `typography` section of the `app-config-rhdh.yaml` file to change the default font family and size of the page text, as well as the font family and size of each heading level, as shown in the following example:
7+
You can configure the `typography` section of the `{my-app-config-file}` file to change the default font family and size of the page text, as well as the font family and size of each heading level, as shown in the following example:
88

99
[source,yaml]
1010
----

modules/customizing-the-appearance/proc-customize-rhdh-page-theme.adoc

+1-1
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44
[id="proc-customize-rhdh-page-theme_{context}"]
55
= Customizing the page theme header for your {product-short} instance
66

7-
You can customize the header color for the light and dark theme modes in your {product-short} instance by modifying the `branding.theme` section of the `app-config-rhdh.yaml` file. You can also customize the page headers for additional {product-short} pages, such as the *Home*, *Catalog*, and *APIs* pages.
7+
You can customize the header color for the light and dark theme modes in your {product-short} instance by modifying the `branding.theme` section of the `{my-app-config-file}` file. You can also customize the page headers for additional {product-short} pages, such as the *Home*, *Catalog*, and *APIs* pages.
88

99
[source,yaml]
1010
----

modules/customizing-the-appearance/proc-customize-rhdh-palette.adoc

+1-1
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44
[id="proc-customize-rhdh-branding_{context}"]
55
= Customizing the theme mode color palettes for your {product-short} instance
66

7-
You can customize the color palettes of the light and dark theme modes in your {product-short} instance by configuring the `light.palette` and `dark.palette` parameters in the `branding.theme` section of the `app-config-rhdh.yaml` file, as shown in the following example:
7+
You can customize the color palettes of the light and dark theme modes in your {product-short} instance by configuring the `light.palette` and `dark.palette` parameters in the `branding.theme` section of the `{my-app-config-file}` file, as shown in the following example:
88

99
[source,yaml]
1010
----

modules/customizing-the-appearance/proc-customize-rhdh-sidebar-menuitems.adoc

+12-1
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,18 @@ The sidebar menu in {product} consists of two main parts that you can configure:
66
Dynamic plugin menu items:: Your preferences and your active plugins define dynamically one part of the sidebar menu.
77
Main menu items:: The core navigation structure of sidebar is static.
88

9-
.Default static menu item configuration
9+
* *Dynamic plugin menu items*: These items are displayed beneath the main menu and can be customized based on the plugins installed. The main menu items section is dynamic and can change based on your preferences and installed plugins.
10+
11+
.Procedure
12+
13+
. Customize the main menu items using the following steps:
14+
+
15+
--
16+
.. Open the `{my-app-config-file}` file.
17+
.. To customize the order and parent-child relationships for the main menu items, use the `dynamicPlugins.frontend.default.main-menu-items.menuItems` field.
18+
.. For dynamic plugin menu items, use the `dynamicPlugins.frontend.<package_name>.menuItems` field.
19+
20+
.Example `{my-app-config-file}` file
1021
[source,yaml]
1122
----
1223
dynamicPlugins:

modules/customizing-the-appearance/proc-loading-custom-theme-using-dynamic-plugin.adoc

+1-1
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ For more information about creating a custom theme, see link:https://backstage.i
2424

2525
. Configure {product-short} to load the theme in the UI by using the `themes` configuration field:
2626
+
27-
.`app-config-rhdh.yaml` fragment
27+
.`{my-app-config-file}` fragment
2828
[source,yaml]
2929
----
3030
dynamicPlugins:

modules/customizing-the-appearance/ref-customize-rhdh-custom-components.adoc

+1-1
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ There are two component variants that you can use to customize various component
1111

1212
In addition to assigning a component variant to each parameter in the light or dark theme mode configurations, you can toggle the `rippleEffect` `on` or `off`.
1313

14-
The following code shows the options that you can use in the `app-config-rhdh.yaml` file to configure the theme components for your {product-short} instance:
14+
The following code shows the options that you can use in the link:{configuring-book-url}[`{my-app-config-file}` file] to configure the theme components for your {product-short} instance:
1515

1616
[source,yaml]
1717
----

modules/customizing-the-appearance/ref-customize-rhdh-default-backstage.adoc

+4-4
Original file line numberDiff line numberDiff line change
@@ -4,11 +4,11 @@
44
[id="ref-customize-rhdh-default-backstage_{context}"]
55
= Default Backstage theme
66

7-
You can use the default Backstage theme configurations to make your {product-short} instance look like a standard Backstage instance. You can also modify the `app-config-rhdh.yaml` file to customize or disable particular parameters.
7+
You can use the default Backstage theme configurations to make your {product-short} instance look like a standard Backstage instance. You can also modify the `{my-app-config-file}` file to customize or disable particular parameters.
88

99
== Default Backstage theme color palette
1010

11-
The `app-config-rhdh.yaml` file uses the following configurations for the default Backstage color palette:
11+
The `{my-app-config-file}` file uses the following configurations for the default Backstage color palette:
1212

1313
[source,yaml]
1414
----
@@ -138,7 +138,7 @@ app:
138138
warningText: "#000000"
139139
----
140140

141-
Alternatively, you can use the following `variant` and `mode` values in the `app-config-rhdh.yaml` file to apply the previous default configuration:
141+
Alternatively, you can use the following `variant` and `mode` values in the `{my-app-config-file}` file to apply the previous default configuration:
142142

143143
[source,yaml]
144144
----
@@ -155,7 +155,7 @@ app:
155155

156156
== Default Backstage page themes
157157

158-
The default Backstage header color is white in light mode and black in dark mode, as shown in the following `app-config-rhdh.yaml` file configuration:
158+
The default Backstage header color is white in light mode and black in dark mode, as shown in the following `{my-app-config-file}` file configuration:
159159

160160
[source,yaml]
161161
----

modules/customizing-the-appearance/ref-customize-rhdh-default-rhdh.adoc

+4-4
Original file line numberDiff line numberDiff line change
@@ -4,11 +4,11 @@
44
[id="ref-customize-rhdh-default-rhdh_{context}"]
55
= Default {product} theme
66

7-
You can use the default {product} theme configurations to make your {product-short} instance look like a standard {product} instance. You can also modify the `app-config-rhdh.yaml` file to customize or disable particular parameters.
7+
You can use the default {product} theme configurations to make your {product-short} instance look like a standard {product} instance. You can also modify the `{my-app-config-file}` file to customize or disable particular parameters.
88

99
== Default {product} theme color palette
1010

11-
The `app-config-rhdh.yaml` file uses the following configurations for the default {product} color palette:
11+
The `{my-app-config-file}` file uses the following configurations for the default {product} color palette:
1212

1313
[source,yaml]
1414
----
@@ -202,7 +202,7 @@ app:
202202
headerBackgroundImage: "none"
203203
----
204204

205-
Alternatively, you can use the following `variant` and `mode` values in the `app-config-rhdh.yaml` file to apply the previous default configuration:
205+
Alternatively, you can use the following `variant` and `mode` values in the `{my-app-config-file}` file to apply the previous default configuration:
206206

207207
[source,yaml]
208208
----
@@ -219,7 +219,7 @@ app:
219219

220220
== Default {product} page themes
221221

222-
The default {product-short} header color is white in light mode and black in dark mode, as shown in the following `app-config-rhdh.yaml` file configuration:
222+
The default {product-short} header color is white in light mode and black in dark mode, as shown in the following `{my-app-config-file}` file configuration:
223223

224224
[source,yaml]
225225
----

modules/customizing-the-home-page/proc-customizing-the-home-page-cards.adoc

+1-1
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@
77

88
Administrators can change the fixed height of cards that are in a 12-column grid.
99

10-
The default Home page is as shown in the following `app-config` file configuration:
10+
The default Home page is as shown in the following `{my-app-config-file}` file configuration:
1111

1212
[source,yaml]
1313
----

modules/customizing-the-home-page/proc-defining-the-layout-of-the-product-home-page.adoc

+2-2
Original file line numberDiff line numberDiff line change
@@ -14,8 +14,8 @@ The Home page uses a 12-column grid to position your cards. You can use the opti
1414
** position (x and y)
1515

1616
.Procedure
17-
. Configure the layout of the cards on the home page by entering one of the following configurations in your {product-short} `{my-app-config-file}` file.
18-
* Use the full space on smaller windows and half of the space on larger windows as shown in the following example:
17+
* Configure your {product-short} `{my-app-config-file}` configuration file by choosing one of the following options:
18+
** Use the full space on smaller windows and half of the space on larger windows as follows:
1919

2020
[source,yaml]
2121
----

modules/customizing-the-learning-paths/proc-customize-rhdh-learning-paths.adoc

+1-1
Original file line numberDiff line numberDiff line change
@@ -59,7 +59,7 @@ For more information, see xref:{installing-on-ocp-book-url}#assembly-install-rhd
5959

6060
To use a dedicated service to provide the Learning Path data, complete the following steps:
6161

62-
. Add the following code to the `app-config-rhdh.yaml` file:
62+
. Add the following code to the link:{configuring-book-url}[`{my-app-config-file}` file]:
6363
+
6464
[source,yaml]
6565
----

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

+5-5
Original file line numberDiff line numberDiff line change
@@ -36,7 +36,7 @@ To use the `red-hat-developer-hub-customization-provider` service, add the URL f
3636
*Target Port* automatically generates a Kubernetes or {ocp-short} service to communicate with.
3737
====
3838
+
39-
. Add the following code to the `app-config-rhdh.yaml` file:
39+
. Add the following code to the link:{configuring-book-url}[`{my-app-config-file}` file]:
4040
+
4141
[source,yaml]
4242
----
@@ -54,7 +54,7 @@ proxy:
5454
+
5555
[NOTE]
5656
====
57-
The `red-hat-developer-hub-customization-provider` service contains the 8080 port by default. If you are using a custom port, you can specify it with the 'PORT' environmental variable in the `app-config-rhdh.yaml` file.
57+
The `red-hat-developer-hub-customization-provider` service contains the 8080 port by default. If you are using a custom port, you can specify it with the 'PORT' environmental variable in the `{my-app-config-file}` file.
5858
====
5959
+
6060
. Replace the `HOMEPAGE_DATA_URL` by adding the URL to `rhdh-secrets` or by directly replacing it in your custom ConfigMap.
@@ -111,14 +111,14 @@ If the request call fails or is not configured, the {product-short} instance fal
111111

112112
* If the images or icons do not load, then allowlist them by adding your image or icon host URLs to the content security policy (csp) `img-src` in your custom ConfigMap as shown in the following example:
113113

114-
[source,yaml]
114+
[source,yaml,subs="attributes+"]
115115
----
116116
kind: ConfigMap
117117
apiVersion: v1
118118
metadata:
119-
name: app-config-rhdh
119+
name: {my-app-config-file}
120120
data:
121-
app-config-rhdh.yaml: |
121+
{my-app-config-file}: |
122122
app:
123123
title: Red Hat Developer Hub
124124
backend:

0 commit comments

Comments
 (0)