Merge branch 'main' into RHIDP-5372-Consistency-for-references-to-the-application-configuration-file

Author: jmagak

artifacts/attributes.adoc

@@ -85,75 +85,69 @@
 :gcp-brand-name: Google Cloud Platform
 :gcp-short: GCP
 
-// Release Notes
-:rn-product-title: Release notes for Red Hat Developer Hub
-
-// Red Hat Developer Hub administration guide
-:ag-product-title: Administration guide for Red Hat Developer Hub
-
-// Red Hat Developer Hub getting started guide
-:gs-product-title: Getting started with Red Hat Developer Hub
-
-// Backstage Plugins for Red Hat Developer Hub
-//:bs-product-title: Backstage Plugins for Red Hat Developer Hub
-
-//  User Guide
-:ug-product-title: Red Hat Developer Hub User Guide
 
 // Links
 
 
-:LinkPluginsGuide: https://access.redhat.com/documentation/en-us/red_hat_developer_hub/{product-version}/html-single/configuring_plugins_in_red_hat_developer_hub/index
-:NameOfPluginsGuide: Configuring plugins in {product}
-
-:release-notes-url: https://docs.redhat.com/en/documentation/red_hat_developer_hub/{product-version}/html-single/release_notes/index
-:release-notes-title: Release notes
-
-:installing-and-viewing-dynamic-plugins-url: https://docs.redhat.com/en/documentation/red_hat_developer_hub/{product-version}/html-single/installing_and_viewing_dynamic_plugins/index
-:installing-and-viewing-dynamic-plugins-title: Installing and viewing dynamic plugins
-
-:authentication-book-url: https://docs.redhat.com/documentation/en-us/red_hat_developer_hub/{product-version}/html-single/authentication/index
-:authentication-book-title: Authentication
-
-:authorization-book-url: https://docs.redhat.com/documentation/en-us/red_hat_developer_hub/{product-version}/html-single/authorization/index
-:authorization-book-title: Authorization
-
-:configuring-book-url: https://docs.redhat.com/documentation/en-us/red_hat_developer_hub/{product-version}/html-single/configuring/index
-:configuring-book-title: Configuring
+:discover-category-url: https://docs.redhat.com/en/documentation/red_hat_developer_hub/{product-version}/#Discover
+:about-book-url: https://docs.redhat.com/en/documentation/red_hat_developer_hub/{product-version}/html-single/about_red_hat_developer_hub/index
+:about-book-title: About {product}
 
-:customizing-book-url: https://docs.redhat.com/documentation/en-us/red_hat_developer_hub/{product-version}/html-single/customizing/index
-:customizing-book-title: Customizing
+:release-notes-category-url: https://docs.redhat.com/en/documentation/red_hat_developer_hub/{product-version}/#Release Notes
+:release-notes-book-url: https://docs.redhat.com/en/documentation/red_hat_developer_hub/{product-version}/html-single/red_hat_developer_hub_release_notes/index
+:release-notes-book-title: {product} release notes
 
-:installing-on-osd-on-gcp-book-url: https://docs.redhat.com/en/documentation/red_hat_developer_hub/{product-version}/html-single/installing_red_hat_developer_hub_on_openshift_dedicated_on_google_cloud_platform/index
-:installing-on-osd-on-gcp-book-title: Installing {product} on {gcp-brand-name} on {gcp-brand-name}
-
-:installing-on-ocp-book-url: https://docs.redhat.com/en/documentation/red_hat_developer_hub/{product-version}/html-single/installing_red_hat_developer_hub_on_openshift_container_platform/index
+:install-category-url: https://docs.redhat.com/en/documentation/red_hat_developer_hub/{product-version}/#Install
 :installing-on-ocp-book-title: Installing {product} on {ocp-short}
-
-:installing-on-gke-book-url: https://docs.redhat.com/en/documentation/red_hat_developer_hub/{product-version}/html-single/installing_red_hat_developer_hub_on_google_kubernetes_engine/index
-:installing-on-gke-book-title: Installing {product} on {gke-brand-name}
-
-:installing-on-eks-book-url: https://docs.redhat.com/en/documentation/red_hat_developer_hub/{product-version}/html-single/installing_red_hat_developer_hub_on_amazon_elastic_kubernetes_service/index
+:installing-on-ocp-book-url: https://docs.redhat.com/en/documentation/red_hat_developer_hub/{product-version}/html-single/installing_red_hat_developer_hub_on_openshift_container_platform/index
 :installing-on-eks-book-title: Installing {product} on {eks-brand-name}
-
-:installing-on-aks-book-url: https://docs.redhat.com/en/documentation/red_hat_developer_hub/{product-version}/html-single/installing_red_hat_developer_hub_on_microsoft_azure_kubernetes_service/index
+:installing-on-eks-book-url: https://docs.redhat.com/en/documentation/red_hat_developer_hub/{product-version}/html-single/installing_red_hat_developer_hub_on_amazon_elastic_kubernetes_service/index
 :installing-on-aks-book-title: Installing {product} on {aks-brand-name}
-
-:installing-in-air-gap-book-url: https://docs.redhat.com/en/documentation/red_hat_developer_hub/{product-version}/html-single/installing_red_hat_developer_hub_in_an_air-gapped_environment/index
+:installing-on-aks-book-url: https://docs.redhat.com/en/documentation/red_hat_developer_hub/{product-version}/html-single/installing_red_hat_developer_hub_on_microsoft_azure_kubernetes_service/index
+:installing-on-osd-on-gcp-book-title: Installing {product} on {gcp-brand-name} on {gcp-brand-name}
+:installing-on-osd-on-gcp-book-url: https://docs.redhat.com/en/documentation/red_hat_developer_hub/{product-version}/html-single/installing_red_hat_developer_hub_on_openshift_dedicated_on_google_cloud_platform/index
+:installing-on-gke-book-title: Installing {product} on {gke-brand-name}
+:installing-on-gke-book-url: https://docs.redhat.com/en/documentation/red_hat_developer_hub/{product-version}/html-single/installing_red_hat_developer_hub_on_google_kubernetes_engine/index
 :installing-in-air-gap-book-title: Installing {product} in an air-gapped environment
+:installing-in-air-gap-book-url: https://docs.redhat.com/en/documentation/red_hat_developer_hub/{product-version}/html-single/installing_red_hat_developer_hub_in_an_air-gapped_environment/index
 
+:upgrade-category-url: https://docs.redhat.com/en/documentation/red_hat_developer_hub/{product-version}/#Upgrade
 :upgrading-book-url: https://docs.redhat.com/en/documentation/red_hat_developer_hub/{product-version}/html-single/upgrading_red_hat_developer_hub/index
 :upgrading-book-title: Upgrading {product}
 
+:configure-category-url: https://docs.redhat.com/en/documentation/red_hat_developer_hub/{product-version}/#Configure
+:configuring-book-url: https://docs.redhat.com/documentation/en-us/red_hat_developer_hub/{product-version}/html-single/configuring_red_hat_developer_hub/index
+:configuring-book-title: Configuring {product}
+:customizing-book-url: https://docs.redhat.com/documentation/en-us/red_hat_developer_hub/{product-version}/html-single/customizing_red_hat_developer_hub/index
+:customizing-book-title: Customizing {product}
+:techdocs-book-url: https://docs.redhat.com/documentation/en-us/red_hat_developer_hub/{product-version}/html-single/techdocs_for_red_hat_developer_hub/index
+:techdocs-book-title: TechDocs for {product}
+
+:control-access-category-url: https://docs.redhat.com/en/documentation/red_hat_developer_hub/{product-version}/#Control access
+:authentication-book-url: https://docs.redhat.com/documentation/en-us/red_hat_developer_hub/{product-version}/html-single/authentication_in_red_hat_developer_hub/index
+:authentication-book-title: Authentication in {product}
+:authorization-book-url: https://docs.redhat.com/documentation/en-us/red_hat_developer_hub/{product-version}/html-single/authorization_in_red_hat_developer_hub/index
+:authorization-book-title: Authorization in {product}
+
+:observability-category-url: https://docs.redhat.com/en/documentation/red_hat_developer_hub/{product-version}/#Observability
+:audit-log-book-url: https://docs.redhat.com/en/documentation/red_hat_developer_hub/{product-version}/html-single/audit_logs_in_red_hat_developer_hub/index
+:audit-log-book-title: Audit logs in {product}
+:monitoring-and-logging-book-url: https://docs.redhat.com/en/documentation/red_hat_developer_hub/{product-version}/html-single/monitoring_and_logging/index
+:monitoring-and-logging-book-title: Monitoring and logging
 :telemetry-data-collection-book-url: https://docs.redhat.com/en/documentation/red_hat_developer_hub/{product-version}/html-single/telemetry_data_collection/index
 :telemetry-data-collection-book-title: Telemetry data collection
 
-:audit-log-book-url: https://docs.redhat.com/en/documentation/red_hat_developer_hub/{product-version}/html-single/audit_log/index
-:audit-log-book-title: Audit log
+:extend-category-url: https://docs.redhat.com/en/documentation/red_hat_developer_hub/{product-version}/#Extend
+:introduction-to-plugins-book-url: https://docs.redhat.com/en/documentation/red_hat_developer_hub/{product-version}/html-single/introduction_to_plugins/index
+:introduction-to-plugins-book-title: Introduction to plugins
+:configuring-dynamic-plugins-book-url: https://docs.redhat.com/en/documentation/red_hat_developer_hub/{product-version}/html-single/introduction_to_plugins/index
+:configuring-dynamic-plugins-book-title: Configuring dynamic plugins
+:installing-and-viewing-plugins-book-url: https://docs.redhat.com/en/documentation/red_hat_developer_hub/{product-version}/html-single/installing_and_viewing_plugins_in_red_hat_developer_hub/index
+:installing-and-viewing-plugins-book-title: Installing and viewing plugins in {product}
+:using-dynamic-plugins-book-url: https://docs.redhat.com/en/documentation/red_hat_developer_hub/{product-version}/html-single/installing_and_viewing_plugins_in_red_hat_developer_hub/index
+:using-dynamic-plugins-book-title: Using dynamic plugins
+:dynamic-plugins-reference-book-url: https://docs.redhat.com/en/documentation/red_hat_developer_hub/{product-version}/html-single/dynamic_plugins_reference/index
+:dynamic-plugins-reference-book-title: Dynamic plugins reference
 
-:monitoring-and-logging-book-url: https://docs.redhat.com/en/documentation/red_hat_developer_hub/{product-version}/html-single/monitoring_and_logging/index
-:monitoring-and-logging-book-title: Monitoring and logging
 
-:plugins-configure-book-url: https://docs.redhat.com/en/documentation/red_hat_developer_hub/{product-version}/html-single/configuring_dynamic_plugins/index
-:plugins-configure-book-title: Configuring dynamic plugins
 

artifacts/rhdh-plugins-reference/argocd/argocd-plugin-admin.adoc

@@ -226,6 +226,6 @@ If using the label selector annotation (backstage.io/kubernetes-label-selector),
 [role="_additional-resources"]
 .Additional resources
 
-* The package path, scope, and name of the {company-name} ArgoCD plugin has changed since 1.2. For more information, see link:{release-notes-url}#removed-functionality-rhidp-4293[Breaking Changes] in the _{rn-product-title}_. 
+* The package path, scope, and name of the {company-name} ArgoCD plugin has changed since 1.2. For more information, see link:{release-notes-book-url}#removed-functionality-rhidp-4293[Breaking Changes] in the _{release-notes-book-title}_.
 
-* For more information on installing dynamic plugins, see link:{installing-and-viewing-dynamic-plugins-url}[{installing-and-viewing-dynamic-plugins-title}].
+* For more information on installing dynamic plugins, see link:{installing-and-viewing-plugins-book-url}[{installing-and-viewing-plugins-book-title}].

artifacts/rhdh-plugins-reference/argocd/argocd-plugin-readme.adoc

@@ -33,4 +33,4 @@ image::rhdh-plugins-reference/deployment_summary.png[Deployment summary]
 [role="_additional-resources"]
 .Additional resources
 
-* For more information on installing dynamic plugins, see link:{installing-and-viewing-dynamic-plugins-url}[{installing-and-viewing-dynamic-plugins-title}].
+* For more information on installing dynamic plugins, see link:{installing-and-viewing-plugins-book-url}[{installing-and-viewing-plugins-book-title}].

artifacts/rhdh-plugins-reference/argocd/argocd-plugin-user.adoc

@@ -31,4 +31,4 @@ image::rhdh-plugins-reference/deployment_summary.png[Deployment summary]
 [role="_additional-resources"]
 .Additional resources
 
-* For more information on installing dynamic plugins, see link:{installing-and-viewing-dynamic-plugins-url}[{installing-and-viewing-dynamic-plugins-title}].
+* For more information on installing dynamic plugins, see link:{installing-and-viewing-plugins-book-url}[{installing-and-viewing-plugins-book-title}].

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

@@ -0,0 +1,8 @@
+:_mod-docs-content-type: ASSEMBLY
+:context: configuring-a-floating-action-button
+[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.
+
+include::modules/configuring-a-floating-action-button/proc-configuring-floating-action-button-as-a-dynamic-plugin.adoc[leveloffset=+1]

assemblies/assembly-configuring-techdocs.adoc

@@ -17,7 +17,7 @@ After you configure {odf-name} to store the files that TechDocs generates, you c
 [role="_additional-resources"]
 .Additional resources
 
-* For more information, see link:{LinkPluginsGuide}[Configuring plugins in {product}].
+* For more information, see link:{configuring-dynamic-plugins-book-url}[{configuring-dynamic-plugins-book-title}].
 
 include::modules/customizing-techdocs/con-techdocs-configure-storage.adoc[leveloffset=+1]
 

assemblies/assembly-using-kubernetes-custom-actions.adoc

@@ -0,0 +1,22 @@
+[id='con-Kubernetes-custom-actions_{context}']
+= Kubernetes custom actions in {product}
+
+include::{docdir}/artifacts/snip-technology-preview.adoc[]
+
+With Kubernetes custom actions, you can create and manage Kubernetes resources.
+
+The Kubernetes custom actions plugin is preinstalled and disabled on a {product-short} instance by default. You can disable or enable the Kubernetes custom actions plugin, and change other parameters, by configuring the {product} Helm chart. 
+
+[NOTE]
+====
+Kubernetes scaffolder actions and Kubernetes custom actions refer to the same concept throughout this documentation.
+====
+
+
+include::modules/using-kubernetes-custom-actions/proc-enable-kubernetes-custom-actions-plugin.adoc[leveloffset=+1]
+
+include::modules/using-kubernetes-custom-actions/proc-using-kubernetes-custom-actions-plugin.adoc[leveloffset=+1]
+
+include::modules/using-kubernetes-custom-actions/ref-creating-a-template-using-kubernetes-custom-actions.adoc[leveloffset=+1]
+
+include::modules/using-kubernetes-custom-actions/ref-supported-kubernetes-custom-actions.adoc[leveloffset=+2]

assemblies/dynamic-plugins/assembly-configuring-rhdh-plugins.adoc

@@ -28,5 +28,7 @@ include::../assembly-bulk-importing-from-github.adoc[leveloffset=+1]
 
 include::../assembly-using-servicenow.adoc[leveloffset=+1]
 
+include::../assembly-using-kubernetes-custom-actions.adoc[leveloffset=+1]
+
 // Overriding Core Backend Service Configuration
 include::../modules/dynamic-plugins/con-overriding-core-backend-services.adoc[leveloffset=+1]

assemblies/dynamic-plugins/assembly-rhdh-installing-dynamic-plugins.adoc

@@ -15,7 +15,7 @@ include::../modules/dynamic-plugins/ref-rh-supported-plugins.adoc[leveloffset=+3
 
 [NOTE]
 ====
-* For more information about configuring KeyCloak, see link:{plugins-configure-book-url}[{plugins-configure-book-title}].
+* For more information about configuring KeyCloak, see link:{configuring-dynamic-plugins-book-url}[{configuring-dynamic-plugins-book-title}].
 
 * For more information about configuring TechDocs, see link:{customizing-book-url}#configuring-techdocs[Configuring TechDocs].
 ====
@@ -29,7 +29,7 @@ include::../modules/dynamic-plugins/ref-rh-tech-preview-plugins.adoc[leveloffset
 
 [NOTE]
 ====
-* A new Technology Preview plugin for Red Hat Ansible Automation Platform (RHAAP) is available, which replaces this older one. See link:{LinkPluginsGuide}#rhdh-compatible-plugins[Other installable plugins] in the _{NameOfPluginsGuide} guide_ for further details. See xref:rhdh-compatible-plugins[Dynamic plugins support matrix].
+* A new Technology Preview plugin for Red Hat Ansible Automation Platform (RHAAP) is available, which replaces this older one. See link:{configuring-dynamic-plugins-book-url}#rhdh-compatible-plugins[Other installable plugins] in _{configuring-dynamic-plugins-book-title}_ for further details. See xref:rhdh-compatible-plugins[Dynamic plugins support matrix].
 ====
 
 // Community plugins

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

@@ -51,7 +51,7 @@ TIP: If you plan to make changes using the GitHub API, ensure that `Read and wri
 * **Private key**
 * **Webhook secret**
 
-. To add your GitHub credentials to {product-short}, add the following key/value pairs to link:{plugins-configure-book-url}#provisioning-your-custom-configuration[your {product-short} secrets]:
+. To add your GitHub credentials to {product-short}, add the following key/value pairs to link:{configuring-dynamic-plugins-book-url}#provisioning-your-custom-configuration[your {product-short} secrets]:
 +
 `AUTH_GITHUB_APP_ID`:: Enter the saved **App ID**.
 `AUTH_GITHUB_CLIENT_ID`:: Enter the saved **Client ID**.
@@ -70,11 +70,11 @@ TIP: If you plan to make changes using the GitHub API, ensure that `Read and wri
 [source,yaml]
 ----
 auth:
-  environment: production
+  environment: production # <1>
   providers:
     github:
       production:
-        clientId: ${AUTH_GITHUB_CLIENT_ID}
+        clientId: ${AUTH_GITHUB_CLIENT_ID} # <2>
         clientSecret: ${AUTH_GITHUB_CLIENT_SECRET}
 integrations:
   github:
@@ -87,8 +87,11 @@ integrations:
           webhookSecret: ${GITHUB_WEBHOOK_SECRET}
           privateKey: |
             ${GITHUB_PRIVATE_KEY_FILE}
-signInPage: github
+signInPage: github # <3>
 ----
+<1> Mark the environment as `production` and disable the Guest login option in the {product-short} login page.
+<2> Apply the GitHub credentials configured in your {product-short} secrets.
+<3> To enable the GitHub 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.
@@ -161,6 +164,70 @@ auth:
 ----
 ////
 
+`sessionDuration`::
+Lifespan of the user session.
+Enter a duration in `ms` library format (such as '24h', '2 days'), ISO duration, or "human duration" as used in code.
++
+.`app-config-rhdh.yaml` fragment with optional `sessionDuration` field
+[source,yaml,subs="+quotes"]
+----
+auth:
+  providers:
+    github:
+      production:
+        sessionDuration: { hours: 24 }
+----
+
+`signIn` ::
+
+`resolvers`:::
+After successful authentication, the user signing in must be resolved to an existing user in the {product-short} catalog. To best match users securely for your use case, consider configuring a specific resolver. Enter the resolver list to override the default resolver: `usernameMatchingUserEntityName`.
++
+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. 
+
+`resolver`::::
+Enter the sign-in resolver name.
+Available resolvers:
+
+* `usernameMatchingUserEntityName`
+* `preferredUsernameMatchingUserEntityName`
+* `emailMatchingUserEntityProfileEmail`
+
+`dangerouslyAllowSignInWithoutUserInCatalog: true`::::
+Configure the sign-in resolver to bypass the user provisioning requirement in the {product-short} software catalog.
++
+WARNING: Use `dangerouslyAllowSignInWithoutUserInCatalog` to explore {product-short} features, but do not use it in production.
++
+.`app-config-rhdh.yaml` fragment with optional field to allow signing in users absent from the software catalog
+[source,yaml]
+----
+auth:
+  environment: production
+  providers:
+    github:
+      production:
+        clientId: ${AUTH_GITHUB_CLIENT_ID}
+        clientSecret: ${AUTH_GITHUB_CLIENT_SECRET}
+        signIn:
+          resolvers:
+            - resolver: usernameMatchingUserEntityName
+              dangerouslyAllowSignInWithoutUserInCatalog: true
+integrations:
+  github:
+    - host: ${GITHUB_HOST_DOMAIN}
+      apps:
+        - appId: ${AUTH_GITHUB_APP_ID}
+          clientId: ${AUTH_GITHUB_CLIENT_ID}
+          clientSecret: ${GITHUB_CLIENT_SECRET}
+          webhookUrl: ${GITHUB_WEBHOOK_URL}
+          webhookSecret: ${GITHUB_WEBHOOK_SECRET}
+          privateKey: |
+            ${GITHUB_PRIVATE_KEY_FILE}
+signInPage: github
+----
+
 [TIP]
 ====
 To enable GitHub integration with a different authentication provider, complete the following configurations:
@@ -194,8 +261,6 @@ signInPage: __<your_main_authentication_provider>__
 ----
 ====
 
---
-
 .Verification
 . Go to the {product-short} login page.
 . Your {product-short} sign-in page displays *Sign in using GitHub* and the Guest user sign-in is disabled.