diff --git a/artifacts/attributes.adoc b/artifacts/attributes.adoc index bdf292f1f5..689ba1f013 100644 --- a/artifacts/attributes.adoc +++ b/artifacts/attributes.adoc @@ -10,9 +10,9 @@ :product: Red Hat Developer Hub :product-short: Developer Hub :product-very-short: RHDH -:product-version: 1.3 -:product-bundle-version: 1.3.0 -:product-chart-version: 1.3.0 +:product-version: 1.4 +:product-bundle-version: 1.4.0 +:product-chart-version: 1.4.0 :product-backstage-version: 1.29.2 :rhdeveloper-name: Red Hat Developer :rhel: Red Hat Enterprise Linux diff --git a/assemblies/assembly-audit-log.adoc b/assemblies/assembly-audit-log.adoc index f70f4e64ec..e110113821 100644 --- a/assemblies/assembly-audit-log.adoc +++ b/assemblies/assembly-audit-log.adoc @@ -33,14 +33,14 @@ Audit logs are not forwarded to the internal log store by default because this d * For a complete list of fields that a {product-short} audit log can include, see xref:ref-audit-log-fields.adoc_{context}[] * For a list of scaffolder events that a {product-short} audit log can include, see xref:ref-audit-log-scaffolder-events.adoc_{context}[] -include::modules/getting-started/con-audit-log-config.adoc[leveloffset=+1] +include::modules/observe/con-audit-log-config.adoc[leveloffset=+1] -include::modules/getting-started/proc-audit-log-view.adoc[leveloffset=+1] +include::modules/observe/proc-audit-log-view.adoc[leveloffset=+1] -include::modules/getting-started/ref-audit-log-fields.adoc[leveloffset=+2] +include::modules/observe/ref-audit-log-fields.adoc[leveloffset=+2] -include::modules/getting-started/ref-audit-log-scaffolder-events.adoc[leveloffset=+2] +include::modules/observe/ref-audit-log-scaffolder-events.adoc[leveloffset=+2] -include::modules/getting-started/ref-audit-log-catalog-events.adoc[leveloffset=+2] +include::modules/observe/ref-audit-log-catalog-events.adoc[leveloffset=+2] -include::modules/getting-started/ref-audit-log-file-rotation-overview.adoc[leveloffset=+1] +include::modules/observe/ref-audit-log-file-rotation-overview.adoc[leveloffset=+1] diff --git a/assemblies/assembly-rhdh-integration-aks.adoc b/assemblies/assembly-rhdh-integration-aks.adoc index 8a59f377f7..7538f41d27 100644 --- a/assemblies/assembly-rhdh-integration-aks.adoc +++ b/assemblies/assembly-rhdh-integration-aks.adoc @@ -13,7 +13,4 @@ This integration requires the deployment of {product-short} on {aks-short} using * The Helm chart * The {product} Operator -.Additional resources -* link:{authentication-book-url}#assembly-authenticating-with-microsoft-azure[Authenticating with {azure-brand-name}] - -include::modules/admin/proc-rhdh-monitoring-logging-aks.adoc[leveloffset=+1] +//include::modules/admin/proc-rhdh-monitoring-logging-aks.adoc[leveloffset=+1] // moving observe category related content to new titles: RHIDP-4814 diff --git a/assemblies/assembly-rhdh-integration-aws.adoc b/assemblies/assembly-rhdh-integration-aws.adoc index 8d14b40046..4177ff7010 100644 --- a/assemblies/assembly-rhdh-integration-aws.adoc +++ b/assemblies/assembly-rhdh-integration-aws.adoc @@ -12,5 +12,5 @@ The integration with {aws-short} requires the deployment of {product-short} in { * The Helm chart * The {product} Operator -include::modules/admin/proc-rhdh-monitoring-logging-aws.adoc[leveloffset=+1] +//include::modules/admin/proc-rhdh-monitoring-logging-aws.adoc[leveloffset=+1]// moving observe category related content to new titles: RHIDP-4814 diff --git a/assemblies/assembly-rhdh-observability.adoc b/assemblies/assembly-rhdh-observability.adoc index a954ee8de9..79d9b799a8 100644 --- a/assemblies/assembly-rhdh-observability.adoc +++ b/assemblies/assembly-rhdh-observability.adoc @@ -3,15 +3,13 @@ = Enabling observability for {product} on {ocp-short} :context: assembly-rhdh-observability -toc::[] - // Metrics In {ocp-short}, metrics are exposed through an HTTP service endpoint under the `/metrics` canonical name. You can create a `ServiceMonitor` custom resource (CR) to scrape metrics from a service endpoint in a user-defined project. -include::modules/observability/proc-admin-enabling-metrics-ocp-helm.adoc[leveloffset=+1] -include::modules/observability/proc-admin-enabling-metrics-ocp-operator.adoc[leveloffset=+1] +include::modules/observe/proc-admin-enabling-metrics-ocp-operator.adoc[leveloffset=+1] +include::modules/observe/proc-admin-enabling-metrics-ocp-helm.adoc[leveloffset=+1] + [role="_additional-resources"] -[id="additional-resources_{context}"] -== Additional resources +.Additional resources * link:https://docs.openshift.com/container-platform/latest/observability/monitoring/managing-metrics.html[{ocp-short} - Managing metrics] diff --git a/assemblies/assembly-rhdh-telemetry.adoc b/assemblies/assembly-rhdh-telemetry.adoc index 435f52b0ab..f6093846fe 100644 --- a/assemblies/assembly-rhdh-telemetry.adoc +++ b/assemblies/assembly-rhdh-telemetry.adoc @@ -20,22 +20,22 @@ With {product-very-short}, you can customize the telemetry data collection featu // disabling telemetry -include::modules/admin/ref-disabling-telemetry.adoc[leveloffset=+1] +include::modules/observe/ref-disabling-telemetry.adoc[leveloffset=+1] -include::modules/admin/proc-disabling-telemetry-using-helm.adoc[leveloffset=+2] +include::modules/observe/proc-disabling-telemetry-using-operator.adoc[leveloffset=+2] -include::modules/admin/proc-disabling-telemetry-using-operator.adoc[leveloffset=+2] +include::modules/observe/proc-disabling-telemetry-using-helm.adoc[leveloffset=+2] // enabling telemetry -include::modules/admin/ref-enabling-telemetry.adoc[leveloffset=+1] +include::modules/observe/ref-enabling-telemetry.adoc[leveloffset=+1] -include::modules/admin/proc-enabling-telemetry-using-helm.adoc[leveloffset=+2] +include::modules/observe/proc-enabling-telemetry-using-operator.adoc[leveloffset=+2] -include::modules/admin/proc-enabling-telemetry-using-operator.adoc[leveloffset=+2] +include::modules/observe/proc-enabling-telemetry-using-helm.adoc[leveloffset=+2] // customizing telemetry segment source -include::modules/admin/ref-customizing-telemetry-segment.adoc[leveloffset=+1] +include::modules/observe/ref-customizing-telemetry-segment.adoc[leveloffset=+1] -include::modules/admin/proc-customizing-telemetry-segment-using-helm.adoc[leveloffset=+2] +include::modules/observe/proc-customizing-telemetry-segment-using-operator.adoc[leveloffset=+2] -include::modules/admin/proc-customizing-telemetry-segment-using-operator.adoc[leveloffset=+2] +include::modules/observe/proc-customizing-telemetry-segment-using-helm.adoc[leveloffset=+2] \ No newline at end of file diff --git a/modules/getting-started/con-audit-log-config.adoc b/modules/observe/con-audit-log-config.adoc similarity index 100% rename from modules/getting-started/con-audit-log-config.adoc rename to modules/observe/con-audit-log-config.adoc diff --git a/modules/getting-started/con-audit-log-track-changes-catalog.adoc b/modules/observe/con-audit-log-track-changes-catalog.adoc similarity index 100% rename from modules/getting-started/con-audit-log-track-changes-catalog.adoc rename to modules/observe/con-audit-log-track-changes-catalog.adoc diff --git a/modules/observability/proc-admin-enabling-metrics-ocp-helm.adoc b/modules/observe/proc-admin-enabling-metrics-ocp-helm.adoc similarity index 100% rename from modules/observability/proc-admin-enabling-metrics-ocp-helm.adoc rename to modules/observe/proc-admin-enabling-metrics-ocp-helm.adoc diff --git a/modules/observability/proc-admin-enabling-metrics-ocp-operator.adoc b/modules/observe/proc-admin-enabling-metrics-ocp-operator.adoc similarity index 100% rename from modules/observability/proc-admin-enabling-metrics-ocp-operator.adoc rename to modules/observe/proc-admin-enabling-metrics-ocp-operator.adoc diff --git a/modules/getting-started/proc-audit-log-view.adoc b/modules/observe/proc-audit-log-view.adoc similarity index 100% rename from modules/getting-started/proc-audit-log-view.adoc rename to modules/observe/proc-audit-log-view.adoc diff --git a/modules/admin/proc-customizing-telemetry-segment-using-helm.adoc b/modules/observe/proc-customizing-telemetry-segment-using-helm.adoc similarity index 100% rename from modules/admin/proc-customizing-telemetry-segment-using-helm.adoc rename to modules/observe/proc-customizing-telemetry-segment-using-helm.adoc diff --git a/modules/admin/proc-customizing-telemetry-segment-using-operator.adoc b/modules/observe/proc-customizing-telemetry-segment-using-operator.adoc similarity index 100% rename from modules/admin/proc-customizing-telemetry-segment-using-operator.adoc rename to modules/observe/proc-customizing-telemetry-segment-using-operator.adoc diff --git a/modules/admin/proc-disabling-telemetry-using-helm.adoc b/modules/observe/proc-disabling-telemetry-using-helm.adoc similarity index 100% rename from modules/admin/proc-disabling-telemetry-using-helm.adoc rename to modules/observe/proc-disabling-telemetry-using-helm.adoc diff --git a/modules/admin/proc-disabling-telemetry-using-operator.adoc b/modules/observe/proc-disabling-telemetry-using-operator.adoc similarity index 100% rename from modules/admin/proc-disabling-telemetry-using-operator.adoc rename to modules/observe/proc-disabling-telemetry-using-operator.adoc diff --git a/modules/admin/proc-enabling-telemetry-using-helm.adoc b/modules/observe/proc-enabling-telemetry-using-helm.adoc similarity index 100% rename from modules/admin/proc-enabling-telemetry-using-helm.adoc rename to modules/observe/proc-enabling-telemetry-using-helm.adoc diff --git a/modules/admin/proc-enabling-telemetry-using-operator.adoc b/modules/observe/proc-enabling-telemetry-using-operator.adoc similarity index 100% rename from modules/admin/proc-enabling-telemetry-using-operator.adoc rename to modules/observe/proc-enabling-telemetry-using-operator.adoc diff --git a/modules/admin/proc-rhdh-monitoring-logging-aks.adoc b/modules/observe/proc-rhdh-monitoring-logging-aks.adoc similarity index 100% rename from modules/admin/proc-rhdh-monitoring-logging-aks.adoc rename to modules/observe/proc-rhdh-monitoring-logging-aks.adoc diff --git a/modules/admin/proc-rhdh-monitoring-logging-aws.adoc b/modules/observe/proc-rhdh-monitoring-logging-aws.adoc similarity index 100% rename from modules/admin/proc-rhdh-monitoring-logging-aws.adoc rename to modules/observe/proc-rhdh-monitoring-logging-aws.adoc diff --git a/modules/getting-started/ref-audit-log-catalog-events.adoc b/modules/observe/ref-audit-log-catalog-events.adoc similarity index 100% rename from modules/getting-started/ref-audit-log-catalog-events.adoc rename to modules/observe/ref-audit-log-catalog-events.adoc diff --git a/modules/getting-started/ref-audit-log-fields.adoc b/modules/observe/ref-audit-log-fields.adoc similarity index 100% rename from modules/getting-started/ref-audit-log-fields.adoc rename to modules/observe/ref-audit-log-fields.adoc diff --git a/modules/getting-started/ref-audit-log-file-rotation-overview.adoc b/modules/observe/ref-audit-log-file-rotation-overview.adoc similarity index 100% rename from modules/getting-started/ref-audit-log-file-rotation-overview.adoc rename to modules/observe/ref-audit-log-file-rotation-overview.adoc diff --git a/modules/getting-started/ref-audit-log-scaffolder-events.adoc b/modules/observe/ref-audit-log-scaffolder-events.adoc similarity index 100% rename from modules/getting-started/ref-audit-log-scaffolder-events.adoc rename to modules/observe/ref-audit-log-scaffolder-events.adoc diff --git a/modules/admin/ref-customizing-telemetry-segment.adoc b/modules/observe/ref-customizing-telemetry-segment.adoc similarity index 100% rename from modules/admin/ref-customizing-telemetry-segment.adoc rename to modules/observe/ref-customizing-telemetry-segment.adoc diff --git a/modules/admin/ref-disabling-telemetry.adoc b/modules/observe/ref-disabling-telemetry.adoc similarity index 100% rename from modules/admin/ref-disabling-telemetry.adoc rename to modules/observe/ref-disabling-telemetry.adoc diff --git a/modules/admin/ref-enabling-telemetry.adoc b/modules/observe/ref-enabling-telemetry.adoc similarity index 100% rename from modules/admin/ref-enabling-telemetry.adoc rename to modules/observe/ref-enabling-telemetry.adoc diff --git a/titles/admin-rhdh/title-admin.adoc b/titles/admin-rhdh/title-admin.adoc index aeada5a085..4e70d669f1 100644 --- a/titles/admin-rhdh/title-admin.adoc +++ b/titles/admin-rhdh/title-admin.adoc @@ -23,10 +23,10 @@ include::modules/installation/proc-configuring-an-rhdh-instance-with-tls-in-kube // include::modules/installation/proc-config-dynamic-plugins-rhdh-operator.adoc[leveloffset=+1] //Telemetry data collection -include::assemblies/assembly-rhdh-telemetry.adoc[leveloffset=+1] +//include::assemblies/assembly-rhdh-telemetry.adoc[leveloffset=+1] // moving observe category related content to new titles: RHIDP-4814 // Observability -include::assemblies/assembly-rhdh-observability.adoc[leveloffset=+1] +//include::assemblies/assembly-rhdh-observability.adoc[leveloffset=+1] // moving observe category related content to new titles: RHIDP-4814 // Running RHDH behind a proxy include::assemblies/assembly-running-rhdh-behind-a-proxy.adoc[leveloffset=+1] @@ -35,7 +35,7 @@ include::assemblies/assembly-running-rhdh-behind-a-proxy.adoc[leveloffset=+1] include::assemblies/assembly-rhdh-integration-aws.adoc[leveloffset=+1] //aks integration -include::assemblies/assembly-rhdh-integration-aks.adoc[leveloffset=+1] +//include::assemblies/assembly-rhdh-integration-aks.adoc[leveloffset=+1] // Removing assembly since the all of the content does not exist in admin guide // Managing templates include::assemblies/assembly-admin-templates.adoc[leveloffset=+1] diff --git a/titles/audit-log/artifacts b/titles/audit-log/artifacts new file mode 120000 index 0000000000..f30b6dea60 --- /dev/null +++ b/titles/audit-log/artifacts @@ -0,0 +1 @@ +../../artifacts \ No newline at end of file diff --git a/titles/audit-log/assemblies b/titles/audit-log/assemblies new file mode 120000 index 0000000000..91646274db --- /dev/null +++ b/titles/audit-log/assemblies @@ -0,0 +1 @@ +../../assemblies \ No newline at end of file diff --git a/titles/audit-log/docinfo.xml b/titles/audit-log/docinfo.xml new file mode 100644 index 0000000000..5f7fe2ebac --- /dev/null +++ b/titles/audit-log/docinfo.xml @@ -0,0 +1,11 @@ +{title} +{product} +{product-version} +{subtitle} + + {abstract} + + + {company-name} Customer Content Services + + diff --git a/titles/audit-log/images b/titles/audit-log/images new file mode 120000 index 0000000000..5fa6987088 --- /dev/null +++ b/titles/audit-log/images @@ -0,0 +1 @@ +../../images \ No newline at end of file diff --git a/titles/audit-log/master.adoc b/titles/audit-log/master.adoc new file mode 100644 index 0000000000..f13644ae75 --- /dev/null +++ b/titles/audit-log/master.adoc @@ -0,0 +1,12 @@ +include::artifacts/attributes.adoc[] +:context: title-audit-log +:doctype: book +:imagesdir: images +:title: Audit log +:subtitle: Tracking user activities, system events, and data changes with {product} audit logs +:abstract: As a {product} administrator, you can track user activities, system events, and data changes with {product-short} audit logs. + += {title} + +// Audit logging +include::assemblies/assembly-audit-log.adoc[leveloffset=+1] \ No newline at end of file diff --git a/titles/audit-log/modules b/titles/audit-log/modules new file mode 120000 index 0000000000..36719b9de7 --- /dev/null +++ b/titles/audit-log/modules @@ -0,0 +1 @@ +../../modules/ \ No newline at end of file diff --git a/titles/getting-started-rhdh/title-getting-started.adoc b/titles/getting-started-rhdh/title-getting-started.adoc index b583a77e42..a9dd8c7c93 100644 --- a/titles/getting-started-rhdh/title-getting-started.adoc +++ b/titles/getting-started-rhdh/title-getting-started.adoc @@ -33,4 +33,4 @@ include::modules/getting-started/proc-enable-servicenow-custom-actions-plugin.ad include::modules/getting-started/ref-supported-servicenow-custom-actions.adoc[leveloffset=+2] // Audit logging -include::assemblies/assembly-audit-log.adoc[leveloffset=+1] +//include::assemblies/assembly-audit-log.adoc[leveloffset=+1] // moving observe category related content to new titles: RHIDP-4814 diff --git a/titles/monitoring-and-logging/artifacts b/titles/monitoring-and-logging/artifacts new file mode 120000 index 0000000000..f30b6dea60 --- /dev/null +++ b/titles/monitoring-and-logging/artifacts @@ -0,0 +1 @@ +../../artifacts \ No newline at end of file diff --git a/titles/monitoring-and-logging/assemblies b/titles/monitoring-and-logging/assemblies new file mode 120000 index 0000000000..91646274db --- /dev/null +++ b/titles/monitoring-and-logging/assemblies @@ -0,0 +1 @@ +../../assemblies \ No newline at end of file diff --git a/titles/monitoring-and-logging/docinfo.xml b/titles/monitoring-and-logging/docinfo.xml new file mode 100644 index 0000000000..5f7fe2ebac --- /dev/null +++ b/titles/monitoring-and-logging/docinfo.xml @@ -0,0 +1,11 @@ +{title} +{product} +{product-version} +{subtitle} + + {abstract} + + + {company-name} Customer Content Services + + diff --git a/titles/monitoring-and-logging/images b/titles/monitoring-and-logging/images new file mode 120000 index 0000000000..5fa6987088 --- /dev/null +++ b/titles/monitoring-and-logging/images @@ -0,0 +1 @@ +../../images \ No newline at end of file diff --git a/titles/monitoring-and-logging/master.adoc b/titles/monitoring-and-logging/master.adoc new file mode 100644 index 0000000000..e907100edd --- /dev/null +++ b/titles/monitoring-and-logging/master.adoc @@ -0,0 +1,19 @@ +include::artifacts/attributes.adoc[] +:context: title-monitoring-logging +:doctype: book +:imagesdir: images +:title: Monitoring and logging +:subtitle: Tracking performance and capturing insights with monitoring and logging tools in {product} +:abstract: As a {product} Operations or Project Manager, you can monitor performance and gather insights using {product}'s monitoring and logging tools. + += {title} + +//metrics +include::assemblies/assembly-rhdh-observability.adoc[leveloffset=+1] + +//AWS +include::modules/observe/proc-rhdh-monitoring-logging-aws.adoc[leveloffset=+1] + +//AKS +include::modules/observe/proc-rhdh-monitoring-logging-aks.adoc[leveloffset=+1] + diff --git a/titles/monitoring-and-logging/modules b/titles/monitoring-and-logging/modules new file mode 120000 index 0000000000..36719b9de7 --- /dev/null +++ b/titles/monitoring-and-logging/modules @@ -0,0 +1 @@ +../../modules/ \ No newline at end of file diff --git a/titles/telemetry/artifacts b/titles/telemetry/artifacts new file mode 120000 index 0000000000..f30b6dea60 --- /dev/null +++ b/titles/telemetry/artifacts @@ -0,0 +1 @@ +../../artifacts \ No newline at end of file diff --git a/titles/telemetry/assemblies b/titles/telemetry/assemblies new file mode 120000 index 0000000000..91646274db --- /dev/null +++ b/titles/telemetry/assemblies @@ -0,0 +1 @@ +../../assemblies \ No newline at end of file diff --git a/titles/telemetry/docinfo.xml b/titles/telemetry/docinfo.xml new file mode 100644 index 0000000000..5f7fe2ebac --- /dev/null +++ b/titles/telemetry/docinfo.xml @@ -0,0 +1,11 @@ +{title} +{product} +{product-version} +{subtitle} + + {abstract} + + + {company-name} Customer Content Services + + diff --git a/titles/telemetry/images b/titles/telemetry/images new file mode 120000 index 0000000000..5fa6987088 --- /dev/null +++ b/titles/telemetry/images @@ -0,0 +1 @@ +../../images \ No newline at end of file diff --git a/titles/telemetry/master.adoc b/titles/telemetry/master.adoc new file mode 100644 index 0000000000..3d1a90e160 --- /dev/null +++ b/titles/telemetry/master.adoc @@ -0,0 +1,12 @@ +include::artifacts/attributes.adoc[] +:context: title-telemetry +:doctype: book +:imagesdir: images +:title: Telemetry data collection +:subtitle: Collecting and analyzing telemetry data to enhance {product} experience +:abstract: As a {product} administrator, you can collect and analyze telemetry data to enhance your {product} experience. + += {title} + +//Telemetry data collection +include::assemblies/assembly-rhdh-telemetry.adoc[leveloffset=+1] \ No newline at end of file diff --git a/titles/telemetry/modules b/titles/telemetry/modules new file mode 120000 index 0000000000..36719b9de7 --- /dev/null +++ b/titles/telemetry/modules @@ -0,0 +1 @@ +../../modules/ \ No newline at end of file