Merge branch 'main' into RHIDP-5421

Author: Gerry-Forde

artifacts/attributes.adoc

@@ -10,10 +10,12 @@
 :product: Red Hat Developer Hub
 :product-short: Developer Hub
 :product-very-short: RHDH
-:product-version: 1.5
-:product-bundle-version: 1.5.0
-:product-chart-version: 1.5.0
-:product-backstage-version: 1.35.0
+:product-local: Red Hat Developer Hub Local
+:product-local-very-short: RHDH Local
+:product-version: 1.6
+:product-bundle-version: 1.6.0
+:product-chart-version: 1.6.0
+:product-backstage-version: 1.36.1
 :product-custom-resource-type: Backstage
 :rhdeveloper-name: Red Hat Developer
 :rhel: Red Hat Enterprise Linux

assemblies/assembly-configuring-authorization-in-rhdh.adoc

@@ -1,26 +1,18 @@
 [id='configuring-authorization-in-rhdh']
 = Configuring authorization in {product}
 
-In link:{authorization-book-url}[{authentication-book-title}], you learnt how to authenticate users to {product}.
-{product-short} knowns who the users are.
+Administrators can authorize users to perform actions and define what users can do in {product-short}.
 
-In this book, learn how to authorize users to perform actions in {product-short}.
-Define what users can do in {product-short}.
+Role-based access control (RBAC) is a security concept that defines how to control access to resources in a system by specifying a mapping between users of the system and the actions that those users can perform on resources in the system.
+You can use RBAC to define roles with specific permissions and then assign the roles to users and groups.
 
-Role-Based Access Control (RBAC) is a security concept that controls access to resources in a system, and specifies a mapping between users of the system, and the actions they can perform on resources in the system.
-You define roles with specific permissions, and then assign the roles to users and groups.
+RBAC on {product-short} is built on top of the Permissions framework, which defines RBAC policies in code. Rather than defining policies in code, you can use the {product-short} RBAC feature to define policies in a declarative fashion by using a simple CSV based format. You can define the policies by using {product-short} web interface or REST API instead of editing the CSV directly.
 
-RBAC on {product-short} is built on top of the Permissions framework, which defines RBAC policies in code.
-Rather than defining policies in code,
-the {product-short} RBAC feature allows you
-to define policies in a declarative fashion using a simple CSV based format.
-You can define the policies by using {product-short} web interface or REST API, rather than editing the CSV directly.
+An administrator can define authorizations in {product-short} by taking the following steps:
 
-To define authorizations in {product-short}:
+. Enable the RBAC feature and give authorized users access to the feature.
 
-. The {product-short} administrator enables and gives access to the RBAC feature.
-
-. You define your roles and policies by combining the following methods:
+. Define roles and policies by combining the following methods:
 
 * The {product-short} policy administrator uses the {product-short} web interface or REST API.
 * The {product-short} administrator edits the main {product-short} configuration file.
@@ -59,4 +51,3 @@ include::modules/authorization/con-user-stats-rhdh.adoc[leveloffset=+1]
 
 
 include::modules/authorization/proc-download-user-stats-rhdh.adoc[leveloffset=+2]
-

assemblies/assembly-customizing-segment-source.adoc

@@ -0,0 +1,17 @@
+:_mod-docs-content-type: ASSEMBLY
+[id="customizing-segment-source_{context}"]
+= Customizing Segment source
+
+The `analytics-provider-segment` plugin sends the collected web analytics data to {company-name} by default. However, you can configure a new Segment source that receives web analytics data based on your needs. For configuration, you need a unique Segment write key that points to the Segment source.
+
+[NOTE]
+====
+Create your own web analytics data collection notice for your application users.
+====
+
+include::modules/analytics/proc-customizing-segment-source-using-the-operator.adoc[leveloffset=+1]
+
+include::modules/analytics/proc-customizing-segment-source-using-helm-the-helm-chart.adoc[leveloffset=+1]
+
+.Additional resources
+* To learn how to collect and analyze the same set of data, see link:{telemetry-data-collection-book-url}[{telemetry-data-collection-book-title}].

assemblies/assembly-disabling-telemetry-data-collection.adoc

@@ -0,0 +1,11 @@
+:_mod-docs-content-type: ASSEMBLY
+[id="disabling-telemetry-data-collection_{context}"]
+= Disabling telemetry data collection in {product-very-short}
+
+To disable telemetry data collection, you must disable the `analytics-provider-segment` plugin either using the Helm Chart or the {product} Operator configuration.
+
+As an administrator, you can disable the telemetry data collection feature based on your needs. For example, in an air-gapped environment, you can disable this feature to avoid needless outbound requests affecting the responsiveness of the {product-very-short} application. For more details, see the link:{telemetry-data-collection-book-url}#proc-disabling-telemetry-using-operator_title-telemetry[Disabling telemetry data collection in {product-very-short}] section.
+
+include::modules/analytics/proc-disabling-telemetry-using-operator.adoc[leveloffset=+1]
+
+include::modules/analytics/proc-disabling-telemetry-using-helm.adoc[leveloffset=+1]

modules/observe/ref-enabling-telemetry.adoc renamed to assemblies/assembly-enabling-telemetry-data-collection.adoc

@@ -1,5 +1,9 @@
+:_mod-docs-content-type: ASSEMBLY
 [id="enabling-telemetry-data-collection_{context}"]
 = Enabling telemetry data collection in {product-very-short}
 
 The telemetry data collection feature is enabled by default. However, if you have disabled the feature and want to re-enable it, you must enable the `analytics-provider-segment` plugin either by using the Helm Chart or the {product} Operator configuration.
 
+include::modules/analytics/proc-enabling-telemetry-using-operator.adoc[leveloffset=+1]
+
+include::modules/analytics/proc-enabling-telemetry-using-helm.adoc[leveloffset=+1]

assemblies/assembly-install-rhdh-eks-operator.adoc

@@ -0,0 +1,10 @@
+:_mod-docs-content-type: ASSEMBLY
+[id="assembly-install-rhdh-eks-operator"]
+= Installing {product-short} on {eks-short} with the Operator
+
+The {product} Operator installation requires the Operator Lifecycle Manager (OLM) framework.
+
+.Additional resources
+* For information about the OLM, see link:https://olm.operatorframework.io/docs/[Operator Lifecycle Manager(OLM)] documentation.
+
+include::modules/installation/proc-rhdh-deploy-eks-operator.adoc[leveloffset=+1]

assemblies/assembly-rhdh-telemetry.adoc

@@ -0,0 +1,8 @@
+:_mod-docs-content-type: ASSEMBLY
+:context: assembly-techdocs-add-docs
+[id="{context}"]
+= Adding documentation to TechDocs
+
+After an administrator configures the TechDocs plugin, a developer can add documentation to TechDocs by importing it from a remote repository. Any authorized user or group can access the documentation that is imported into the TechDocs plugin.
+
+include::modules/techdocs/proc-techdocs-add-docs-from-remote-repo.adoc[leveloffset=+1]

assemblies/assembly-techdocs-add-docs.adoc

@@ -0,0 +1,14 @@
+:_mod-docs-content-type: ASSEMBLY
+:context: assembly-using-techdocs
+[id="{context}"]
+= Using TechDocs
+
+The TechDocs plugin is installed and enabled on your {product} instance by default. After an administrator configures the TechDocs plugin, an authorized developer can use the TechDocs plugin to add, view, or manage documentation.
+
+include::assembly-techdocs-add-docs.adoc[leveloffset=+1]
+
+include::modules/techdocs/proc-techdocs-find-docs.adoc[leveloffset=+1]
+
+include::modules/techdocs/proc-techdocs-view-docs.adoc[leveloffset=+1]
+
+include::modules/techdocs/proc-techdocs-edit-docs.adoc[leveloffset=+1]

assemblies/assembly-using-techdocs.adoc

@@ -0,0 +1,28 @@
+[id="telemetry-data-collection-and-analysis_{context}"]
+= Telemetry data collection and analysis
+
+The telemetry data collection feature helps in collecting and analyzing the telemetry data to improve your experience with {product}. This feature is enabled by default.
+
+{company-name} collects and analyzes the following data:
+
+Web Analytics::
+Web Analytics use the Segment tool.
+It is the tracking of user behavior and interactions with {product}.
+Specifically, it tracks the following:
+
+* Events of page visits and clicks on links or buttons.
+* System-related information, for example, locale, time zone, user agent including browser and operating system details.
+* Page-related information, for example, title, category, extension name, URL, path, referrer, and search parameters.
+* Anonymized IP addresses, recorded as `0.0.0.0`.
+* Anonymized username hashes, which are unique identifiers used solely to identify the number of unique users of the {product-very-short} application.
+
+System Observability::
+System Observability uses the OpenTelemetry tool.
+It is the tracking of the performance of the {product-very-short}.
+Specifically, it tracks the following metrics:
+
+* Key system metrics such as CPU usage, memory usage, and other performance indicators.
+* Information about system components, such as the locale, time zone, and user agent (including details of the browser and operating system).
+* Traces and logs monitor system processes, allowing you to troubleshoot potential issues impacting the performance of {product-very-short}.
+
+With {product-very-short}, you can customize the _Web Analytics_ and _System Observability_ configuration based on your needs.