Merge branch 'main' into RHIDP-6396-Modularize-air-gapped-installation-doc-operator

Author: jmagak

assemblies/assembly-configuring-a-floating-action-button.adoc

@@ -3,6 +3,6 @@
 [id="{context}"]
 = Configuring a floating action button in {product}
 
-You can use the floating action button plugin to configure any action button as a floating button in any page in the {product-short} instance as you want. The floating action button plugin is disabled by default. You can also configure floating action buttons to display as submenu options within the main floating action button by assigning the floating action buttons to the same slot.
+You can use the floating action button plugin to configure any action as a floating button in the {product-short} instance. The floating action button plugin is enabled by default. You can also configure floating action buttons to display as submenu options within the main floating action button by assigning the floating action buttons to the same `slot` field of your `dynamic-plugins.yaml` file.
 
 include::modules/configuring-a-floating-action-button/proc-configuring-floating-action-button-as-a-dynamic-plugin.adoc[leveloffset=+1]

assemblies/assembly-configuring-techdocs.adoc

@@ -1,7 +1,7 @@
 :_mod-docs-content-type: ASSEMBLY
 :context: configuring-techdocs
 [id="{context}"]
-= Configuring TechDocs
+= TechDocs configuration
 
 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.
 

assemblies/assembly-install-rhdh-airgapped-environment-ocp-helm.adoc

@@ -0,0 +1,12 @@
+[id="assembly-install-rhdh-airgapped-environment-ocp-helm_{context}"]
+= Installing {product} on {ocp-short} in an air-gapped environment with the Helm chart
+
+You can install {product} in a fully disconnected or partially disconnected environment using the {product} Helm chart.
+
+[role="_additional-resources"]
+.Additional resources
+* For more information about registry authentication, see https://access.redhat.com/RegistryAuthentication[{company-name} Container Registry Authentication].
+
+include::modules/installation/proc-install-rhdh-helm-airgapped-full.adoc[leveloffset=+1]
+
+include::modules/installation/proc-install-rhdh-helm-airgapped-partial.adoc[leveloffset=+1]

assemblies/assembly-techdocs-addons-installing.adoc

@@ -0,0 +1,16 @@
+:_mod-docs-content-type: ASSEMBLY
+:context: techdocs-addon-installing
+[id="techdocs-addon-installing"]
+= Installing and configuring a TechDocs add-on
+
+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.
+
+include::modules/techdocs/proc-techdocs-addon-install-operator.adoc[]
+
+include::modules/techdocs/proc-techdocs-addon-install-helm.adoc[]
+
+include::modules/techdocs/proc-techdocs-addon-install-third-party.adoc[]
+
+.Additional resources
+* 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]
+* 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]

assemblies/assembly-techdocs-addons-removing.adoc

@@ -0,0 +1,12 @@
+:_mod-docs-content-type: ASSEMBLY
+:context: techdocs-addon-removing
+[id="techdocs-addon-removing"]
+= Removing a TechDocs add-on
+
+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.
+
+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.
+
+include::modules/techdocs/proc-techdocs-addon-remove-operator.adoc[]
+
+include::modules/techdocs/proc-techdocs-addon-remove-helm.adoc[]

assemblies/assembly-techdocs-addons-using.adoc

@@ -0,0 +1,12 @@
+:_mod-docs-content-type: ASSEMBLY
+:context: techdocs-addon-using
+[id="techdocs-addon-using"]
+= Using TechDocs add-ons
+
+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.
+
+include::modules/techdocs/proc-techdocs-addon-use-report-issue.adoc[]
+
+include::modules/techdocs/proc-techdocs-addon-use-text-size.adoc[]
+
+include::modules/techdocs/proc-techdocs-addon-use-light-box.adoc[]

assemblies/assembly-techdocs-addons.adoc

@@ -0,0 +1,34 @@
+:_mod-docs-content-type: ASSEMBLY
+:context: techdocs-addon
+[id="techdocs-addon"]
+= TechDocs add-ons
+
+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.
+
+The following table describes the TechDocs add-ons that are available for {product} {product-version}:
+
+.TechDocs Add-ons available in {product}
+|===
+| TechDocs Add-on  | Package/Plugin | Description | Type
+
+| `<ReportIssue />`
+| `backstage-plugin-techdocs-module-addons-contrib`
+| 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.
+| Preinstalled
+
+| `<TextSize />`
+| `backstage-plugin-techdocs-module-addons-contrib`
+| 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.
+| External
+
+| `<LightBox />`
+| `backstage-plugin-techdocs-module-addons-contrib`
+| 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.
+| External
+
+//future release | `<ExpandableNavigation />`
+//future release | `backstage-plugin-techdocs-module-addons-contrib`
+//future release | Expand or collapse the subtitles in the TechDocs navigation menu and keep your preferred state between documentation sites.
+|===
+
+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.

assemblies/dynamic-plugins/assembly-extensions-plugins.adoc

@@ -0,0 +1,42 @@
+[id="rhdh-extensions-plugins_{context}"]
+= Extensions in {product}
+
+include::{docdir}/artifacts/snip-technology-preview.adoc[]
+
+:context: rhdh-extensions-plugins
+
+{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 
+
+You can use Extensions to discover plugins that extend {product-very-short} functionality, streamline development workflows, and improve the developer experience.
+
+// The feature is a first read-only version of the extensions plugin
+// (previously called marketplace)
+// It can show Plugins (a display name, icon, highlights, description) and
+// Packages (npm package names and versions) in RHDH under
+// Administration > Extensions
+// The data are stored in the Software Catalog
+// There are default Plugins for all Dynamic plugin.
+// Customers can add their own.
+// There is no option to install a Plugin in 1.5.
+
+
+// Viewing Extensions
+include::../modules/dynamic-plugins/proc-catalog-viewing.adoc[leveloffset=+1]
+
+// Viewing installed plugins
+include::../modules/dynamic-plugins/proc-viewing-installed-plugins.adoc[leveloffset=+1]
+
+// Searching and filtering Extensions
+include::../modules/dynamic-plugins/con-catalog-searching-and-filtering.adoc[leveloffset=+1]
+
+// Viewing a plugin
+include::../modules/dynamic-plugins/ref-catalog-plugin.adoc[leveloffset=+2]
+
+// Disabling Extensions 
+include::../modules/dynamic-plugins/proc-extensions-disabling.adoc[leveloffset=+1]
+
+// Managing the extensions plugin entries - For 1.6+
+//include::../modules/dynamic-plugins/proc-extensions-managing.adoc[leveloffset=+1]
+
+// Creating the extensions plugin metadata - For 1.6+
+//include::../modules/dynamic-plugins/proc-extensions-creating.adoc[leveloffset=+1]

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

@@ -39,20 +39,59 @@ Save the value for the next step:
 [source,yaml]
 ----
 auth:
-  environment: production # <1>
+  environment: production
   providers:
     oidc:
       production:
-        metadataUrl: ${AUTH_OIDC_METADATA_URL} # <2>
+        metadataUrl: ${AUTH_OIDC_METADATA_URL}
         clientId: ${AUTH_OIDC_CLIENT_ID}
         clientSecret: ${AUTH_OIDC_CLIENT_SECRET}
-signInPage: oidc # <3>
+        prompt: auto
+signInPage: oidc
 ----
-<1>  Mark the environment as `production` and disable the Guest login option in the {product-short} login page.
-<2> Apply the {rhbk} credentials configured in your {product-short} secrets.
-<3> To enable the {rhbk} provider as your {product-short} sign-in provider.
+
+`environment: production`::
+Mark the environment as `production` to hide the Guest login in the {product-short} home page.
+
+`metadataUrl`, `clientId`, `clientSecret`::
+To configure the OIDC provider with your secrets.
+
+`sigInPage: oidc`::
+To enable the OIDC provider as default sign-in provider.
+
+`prompt: auto`::
+To allow the identity provider to automatically determine whether to prompt for credentials or bypass the login redirect if an active {rhsso} session exists.
+
+[NOTE]
+====
+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.
+====
+
+Optional: Consider adding the following optional fields:
+
+`dangerouslyAllowSignInWithoutUserInCatalog: true`::
 +
-.. Optional: Consider adding the following optional fields:
+--
+To enable authentication without requiring to provision users in the {product-short} software catalog.
+
+WARNING: Use this option to explore {product-short} features, but do not use it in production.
+
+.`{my-app-config-file}` fragment with optional field to allow authenticating users absent from the software catalog
+[source,yaml]
+----
+auth:
+  environment: production
+  providers:
+    oidc:
+      production:
+        metadataUrl: ${AUTH_OIDC_METADATA_URL}
+        clientId: ${AUTH_OIDC_CLIENT_ID}
+        clientSecret: ${AUTH_OIDC_CLIENT_SECRET}
+        prompt: auto
+signInPage: oidc
+dangerouslyAllowSignInWithoutUserInCatalog: true
+----
+--
 
 `callbackUrl`::
 {rhbk} callback URL.
@@ -112,14 +151,14 @@ After successful authentication, the user signing in must be resolved to an exis
 +
 The authentication provider tries each sign-in resolver in order until it succeeds, and fails if none succeed.
 +
-WARNING: In production mode, only configure one resolver to ensure users are securely matched. 
+WARNING: In production mode, only configure one resolver to ensure users are securely matched.
 `resolver`::::
 Enter the sign-in resolver name.
 Available values:
 * `emailLocalPartMatchingUserEntityName`
 * `emailMatchingUserEntityProfileEmail`
 * `preferredUsernameMatchingUserEntityName`
-+
+
 .`{my-app-config-file}` fragment with optional `resolvers` list
 [source,yaml]
 ----
@@ -197,4 +236,3 @@ If multiple valid refresh tokens are issued due to frequent refresh token reques
 . Go to the {product-short} login page.
 . Your {product-short} sign-in page displays *Sign in using OIDC* and the Guest user sign-in is disabled.
 . Log in with OIDC by using the saved **Username** and **Password** values.
-