Skip to content

Commit 45abbfd

Browse files
committed
Work on consistency
Signed-off-by: Fabrice Flore-Thébault <[email protected]>
1 parent ae3c9a4 commit 45abbfd

File tree

3 files changed

+10
-21
lines changed

3 files changed

+10
-21
lines changed

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

Lines changed: 2 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -73,9 +73,7 @@ plugins:
7373

7474
. To provision GitHub users and groups to the {product-short} software catalog, add the `catalog.providers.githubOrg` section to your custom {product-short} `{my-app-config-file}` configuration file:
7575
+
76-
--
7776
[id=githubProviderId]
78-
.`{my-app-config-file}` fragment with mandatory `catalog.providers.githubOrg` fields
7977
[source,yaml]
8078
----
8179
catalog:
@@ -111,12 +109,9 @@ Enter your schedule timeout, in the ISO duration or "human duration" format.
111109

112110
`schedule.initialDelay`::
113111
Enter your schedule initial delay, in the ISO duration or "human duration" format.
114-
--
115112

116113
. To set up the GitHub authentication provider, add the `auth.providers.github` section to your `{my-app-config-file}` file:
117114
+
118-
--
119-
.`{my-app-config-file}` file fragment with mandatory fields to enable authentication with GitHub
120115
[source,yaml]
121116
----
122117
auth:
@@ -142,11 +137,10 @@ Enter the configured secret variable name: `$\{GITHUB_CLIENT_SECRET}`.
142137
Enter `github` to enable the GitHub provider as your {product-short} sign-in provider.
143138
+
144139
Optional: Consider adding optional fields.
145-
ifeval::[{optional-steps} == 'disable']
140+
ifeval::["{optional-steps}" == "disable"]
146141
See {configuring-book-link}[{configuring-book-title}].
147142
endif::[]
148-
ifeval::[{optional-steps} == 'enable']
149-
+
143+
ifeval::["{optional-steps}" == "enable"]
150144
[source,yaml,subs="+quotes"]
151145
----
152146
auth:
@@ -203,7 +197,6 @@ Configure the sign-in resolver to bypass the user provisioning requirement in th
203197
Use `dangerouslyAllowSignInWithoutUserInCatalog` to explore {product-short} features, but do not use it in production.
204198
====
205199
endif::[]
206-
--
207200

208201
.Verification
209202
. To verify user and group provisioning, check the console logs.

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

Lines changed: 4 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -145,10 +145,10 @@ In a large organization, user provisioning might take a long time, therefore avo
145145
Enter the schedule initial delay in the ISO duration or human duration format.
146146
+
147147
Optional: Consider adding optional fields.
148-
ifeval::[{optional-steps} == 'disable']
148+
ifeval::["{optional-steps}" == "disable"]
149149
See {configuring-book-link}[{configuring-book-title}].
150150
endif::[]
151-
ifeval::[{optional-steps} == 'enable']
151+
ifeval::["{optional-steps}" == "enable"]
152152
[id=authority]
153153
`authority`::
154154
Enter your link:https://learn.microsoft.com/en-us/graph/deployments#app-registration-and-token-service-root-endpoints[{azure-short} authority URL], when different from the default: `\https://login.microsoftonline.com`.
@@ -384,11 +384,10 @@ Enter the configured secret variable name: `$\{AUTHENTICATION_AZURE_TENANT_ID}`.
384384
Enter `microsoft` to set the {azure-short} provider as your {product-short} sign-in provider.
385385
+
386386
Optional: Consider adding optional fields.
387-
ifeval::[{optional-steps} == 'disable']
387+
ifeval::["{optional-steps}" == "disable"]
388388
See {configuring-book-link}[{configuring-book-title}].
389389
endif::[]
390-
ifeval::[{optional-steps} == 'enable']
391-
390+
ifeval::["{optional-steps}" == "enable"]
392391
`domainHint`::
393392
Optional for single-tenant applications.
394393
You can reduce login friction for users with accounts in multiple tenants by automatically filtering out accounts from other tenants.

modules/authentication/proc-enabling-user-authentication-with-rhbk.adoc

Lines changed: 4 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -83,10 +83,10 @@ Enter the realm name to provision users, such as `master`.
8383
Enter the realm name to authenticate users, such as `master`.
8484
+
8585
Optional: Consider adding optional fields.
86-
ifeval::[{optional-steps} == 'disable']
86+
ifeval::["{optional-steps}" == "disable"]
8787
See {configuring-book-link}[{configuring-book-title}].
8888
endif::[]
89-
ifeval::[{optional-steps} == 'enable']
89+
ifeval::["{optional-steps}" == "enable"]
9090
`userQuerySize`::
9191
Enter the user count to query simultaneously.
9292
Default value: `100`.
@@ -162,10 +162,7 @@ catalog:
162162
endif::[]
163163

164164
. To set up the {rhbk} authentication provider in your {product-short} custom configuration, edit your custom {product-short} ConfigMap such as `app-config-rhdh`, and add the following lines to the `{my-app-config-file}` content:
165-
166-
.. Add mandatory fields:
167165
+
168-
.`{my-app-config-file}` fragment with mandatory fields to enable authentication with {rhbk}
169166
[source,yaml]
170167
----
171168
auth:
@@ -198,10 +195,10 @@ If `prompt: auto` is not set, the identity provider defaults to `prompt: none`,
198195
====
199196
+
200197
Optional: Consider adding optional fields.
201-
ifeval::[{optional-steps} == 'disable']
198+
ifeval::["{optional-steps}" == "disable"]
202199
See {configuring-book-link}[{configuring-book-title}].
203200
endif::[]
204-
ifeval::[{optional-steps} == 'enable']
201+
ifeval::["{optional-steps}" == "enable"]
205202
`callbackUrl`::
206203
{rhbk} callback URL.
207204
+

0 commit comments

Comments
 (0)