You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: assemblies/assembly-configuring-techdocs.adoc
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,7 +1,7 @@
1
1
:_mod-docs-content-type: ASSEMBLY
2
2
:context: configuring-techdocs
3
3
[id="{context}"]
4
-
= Configuring TechDocs
4
+
= TechDocs configuration
5
5
6
6
The TechDocs plugin is preinstalled and enabled on a {product-short} instance by default. You can disable or enable the TechDocs plugin, and change other parameters, by configuring the {product} Helm chart or the {product} Operator ConfigMap.
= Installing {product} on {ocp-short} in an air-gapped environment with the Helm chart
3
+
4
+
You can install {product} in a fully disconnected or partially disconnected environment using the {product} Helm chart.
5
+
6
+
[role="_additional-resources"]
7
+
.Additional resources
8
+
* For more information about registry authentication, see https://access.redhat.com/RegistryAuthentication[{company-name} Container Registry Authentication].
TechDocs add-ons are supported by {company-name} are imported by the `backstage-plugin-techdocs-module-addons-contrib` plugin package. The `<ReportIssue />` add-on is preinstalled in the TechDocs plugin and enabled by default. You can install external TechDocs add-ons by adding them to `backstage-plugin-techdocs-module-addons-contrib` package with either the {product} Operator or Helm chart. Additionally, you can import compatible third-party add-ons, including add-ons that you create yourself, with a third-party dynamic plugin.
* link:https://docs.redhat.com/en/documentation/red_hat_developer_hub/1.4/html/installing_and_viewing_plugins_in_red_hat_developer_hub/rhdh-installing-rhdh-plugins_title-plugins-rhdh-about[Installing dynamic plugins in Red Hat Developer Hub]
16
+
* link:https://docs.redhat.com/en/documentation/red_hat_developer_hub/1.4/html/installing_and_viewing_plugins_in_red_hat_developer_hub/assembly-third-party-plugins[Third-party plugins in Red Hat Developer Hub]
Administrators can remove installed TechDocs add-ons from your {product} instance by using either the Operator or Helm chart, depending on the method used to install the add-on. If you used the Operator to install the add-on, remove it from the ConfigMap. If you used the Helm chart to install the add-on, remove it from the Helm chart.
7
+
8
+
If you want to disable a plugin instead of removing it from your {product} instance, you can disable the plugin that you are using to import the TechDocs add-on. Since the `disabled` status is controlled at the plugin level, disabling the plugin disables all of the TechDocs add-ons in the specified plugin package.
After an administrator installs a TechDocs add-on in your {product} instance, you can use it to extend the functionality of the TechDocs plugin and enhance your documentation experience.
TechDocs add-ons are dynamic plugins that extend the functionality of the built-in TechDocs plugin. For example, you can use add-ons to report documentation issues, change text size, or view images in overlay in either the TechDocs Reader page or an Entity page.
7
+
8
+
The following table describes the TechDocs add-ons that are available for {product}{product-version}:
9
+
10
+
.TechDocs Add-ons available in {product}
11
+
|===
12
+
| TechDocs Add-on | Package/Plugin | Description | Type
| Select a portion of text on a TechDocs page and open an issue against the repository that contains the documentation. The issue template is automatically populated with the selected text.
| Customize text size on documentation pages by increasing or decreasing the font size with a slider or buttons. The default value for font size is 100% and this setting is kept in the browser's local storage whenever it is changed.
| Open images in a light-box on documentation pages, to navigate to multiple images on a single page. The image size of the light-box image is the same as the image size on the document page. Clicking the zoom icon increases the image size to fit the screen.
//future release | Expand or collapse the subtitles in the TechDocs navigation menu and keep your preferred state between documentation sites.
32
+
|===
33
+
34
+
You can use a dynamic plugin to import a TechDocs add-on. TechDocs add-ons are enabled at the plugin level, therefore, enabling a plugin enables all of the TechDocs add-ons in the specified plugin package. The preinstalled and external add-ons supported by {company} are imported by the `backstage-plugin-techdocs-module-addons-contrib` plugin package. Since the `disabled` status is set at the plugin level, the `disabled` status of the plugin package applies to all of the TechDocs add-ons imported by that package.
{product} ({product-very-short}) includes the Extensions feature which is preinstalled and enabled by default. Extensions provides users with a centralized interface to browse and manage available plugins
9
+
10
+
You can use Extensions to discover plugins that extend {product-very-short} functionality, streamline development workflows, and improve the developer experience.
11
+
12
+
// The feature is a first read-only version of the extensions plugin
13
+
// (previously called marketplace)
14
+
// It can show Plugins (a display name, icon, highlights, description) and
15
+
// Packages (npm package names and versions) in RHDH under
16
+
// Administration > Extensions
17
+
// The data are stored in the Software Catalog
18
+
// There are default Plugins for all Dynamic plugin.
Copy file name to clipboardExpand all lines: modules/authentication/proc-enabling-authentication-with-rhbk.adoc
+48-10Lines changed: 48 additions & 10 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -39,20 +39,59 @@ Save the value for the next step:
39
39
[source,yaml]
40
40
----
41
41
auth:
42
-
environment: production # <1>
42
+
environment: production
43
43
providers:
44
44
oidc:
45
45
production:
46
-
metadataUrl: ${AUTH_OIDC_METADATA_URL} # <2>
46
+
metadataUrl: ${AUTH_OIDC_METADATA_URL}
47
47
clientId: ${AUTH_OIDC_CLIENT_ID}
48
48
clientSecret: ${AUTH_OIDC_CLIENT_SECRET}
49
-
signInPage: oidc # <3>
49
+
prompt: auto
50
+
signInPage: oidc
50
51
----
51
-
<1> Mark the environment as `production` and disable the Guest login option in the {product-short} login page.
52
-
<2> Apply the {rhbk} credentials configured in your {product-short} secrets.
53
-
<3> To enable the {rhbk} provider as your {product-short} sign-in provider.
52
+
53
+
`environment: production`::
54
+
Mark the environment as `production` to hide the Guest login in the {product-short} home page.
55
+
56
+
`metadataUrl`, `clientId`, `clientSecret`::
57
+
To configure the OIDC provider with your secrets.
58
+
59
+
`sigInPage: oidc`::
60
+
To enable the OIDC provider as default sign-in provider.
61
+
62
+
`prompt: auto`::
63
+
To allow the identity provider to automatically determine whether to prompt for credentials or bypass the login redirect if an active {rhsso} session exists.
64
+
65
+
[NOTE]
66
+
====
67
+
If `prompt: auto` is not set, the identity provider defaults to `prompt: none`, which assumes that you are already logged in and rejects sign-in requests without an active session.
68
+
====
69
+
70
+
Optional: Consider adding the following optional fields:
You can use the search bar in the header to filter the Extensions plugin cards by name. For example, if you type “A” into the search bar, Extensions shows only the plugins that contain the letter “A” in the Name field.
5
+
6
+
Optionally, you can use the search bar in conjunction with a filter to filter only plugins of the selected filter by name. For example, you can apply the *Category* filter and then type a character into the search bar to view only Openshift plugins that contain the typed character in the name.
0 commit comments