From 5fa2379bfc3ae9fe4c3740f1c339339d8c697e6f Mon Sep 17 00:00:00 2001 From: Heena Manwani Date: Fri, 8 Nov 2024 15:17:53 +0530 Subject: [PATCH 01/12] RHIDP-4814: Move observe related content in new titles --- assemblies/assembly-rhdh-integration-aks.adoc | 5 +---- assemblies/assembly-rhdh-integration-aws.adoc | 2 +- assemblies/assembly-rhdh-observability.adoc | 7 +++---- .../proc-admin-enabling-metrics-ocp-helm.adoc | 0 ...proc-admin-enabling-metrics-ocp-operator.adoc | 0 titles/admin-rhdh/title-admin.adoc | 6 +++--- titles/audit-log/artifacts | 1 + titles/audit-log/assemblies | 1 + titles/audit-log/docinfo.xml | 11 +++++++++++ titles/audit-log/images | 1 + titles/audit-log/master.adoc | 10 ++++++++++ titles/audit-log/modules | 1 + .../title-getting-started.adoc | 2 +- titles/monitoring-and-logging/artifacts | 1 + titles/monitoring-and-logging/assemblies | 1 + titles/monitoring-and-logging/docinfo.xml | 11 +++++++++++ titles/monitoring-and-logging/images | 1 + titles/monitoring-and-logging/master.adoc | 16 ++++++++++++++++ titles/monitoring-and-logging/modules | 1 + titles/telemetry/artifacts | 1 + titles/telemetry/assemblies | 1 + titles/telemetry/docinfo.xml | 11 +++++++++++ titles/telemetry/images | 1 + titles/telemetry/master.adoc | 10 ++++++++++ titles/telemetry/modules | 1 + 25 files changed, 90 insertions(+), 13 deletions(-) rename modules/{observability => observe}/proc-admin-enabling-metrics-ocp-helm.adoc (100%) rename modules/{observability => observe}/proc-admin-enabling-metrics-ocp-operator.adoc (100%) create mode 120000 titles/audit-log/artifacts create mode 120000 titles/audit-log/assemblies create mode 100644 titles/audit-log/docinfo.xml create mode 120000 titles/audit-log/images create mode 100644 titles/audit-log/master.adoc create mode 120000 titles/audit-log/modules create mode 120000 titles/monitoring-and-logging/artifacts create mode 120000 titles/monitoring-and-logging/assemblies create mode 100644 titles/monitoring-and-logging/docinfo.xml create mode 120000 titles/monitoring-and-logging/images create mode 100644 titles/monitoring-and-logging/master.adoc create mode 120000 titles/monitoring-and-logging/modules create mode 120000 titles/telemetry/artifacts create mode 120000 titles/telemetry/assemblies create mode 100644 titles/telemetry/docinfo.xml create mode 120000 titles/telemetry/images create mode 100644 titles/telemetry/master.adoc create mode 120000 titles/telemetry/modules 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..92032bc34d 100644 --- a/assemblies/assembly-rhdh-observability.adoc +++ b/assemblies/assembly-rhdh-observability.adoc @@ -8,10 +8,9 @@ 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-helm.adoc[leveloffset=+1] +include::modules/observe/proc-admin-enabling-metrics-ocp-operator.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/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/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..a086d9d6d8 --- /dev/null +++ b/titles/audit-log/master.adoc @@ -0,0 +1,10 @@ +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. + +// 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..40764f882f --- /dev/null +++ b/titles/monitoring-and-logging/master.adoc @@ -0,0 +1,16 @@ +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. + +//AWS +include::modules/admin/proc-rhdh-monitoring-logging-aws.adoc[leveloffset=+1] + +//AKS +include::modules/admin/proc-rhdh-monitoring-logging-aks.adoc[leveloffset=+1] + +//metrics +include::assemblies/assembly-rhdh-observability.adoc[leveloffset=+1] \ No newline at end of file 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..e69f249c54 --- /dev/null +++ b/titles/telemetry/master.adoc @@ -0,0 +1,10 @@ +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. + +//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 From ef2f6831a7a069e68b327c67387a68837974b69e Mon Sep 17 00:00:00 2001 From: Heena Manwani Date: Fri, 8 Nov 2024 16:25:01 +0530 Subject: [PATCH 02/12] fixing issues --- titles/audit-log/master.adoc | 1 + 1 file changed, 1 insertion(+) diff --git a/titles/audit-log/master.adoc b/titles/audit-log/master.adoc index a086d9d6d8..df1b447da6 100644 --- a/titles/audit-log/master.adoc +++ b/titles/audit-log/master.adoc @@ -2,6 +2,7 @@ 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. From a5e80b0dfae26b60a3b659b89f24bdcd8c2028bf Mon Sep 17 00:00:00 2001 From: Heena Manwani Date: Fri, 8 Nov 2024 17:14:49 +0530 Subject: [PATCH 03/12] Fixing issues --- titles/audit-log/master.adoc | 2 +- titles/telemetry/master.adoc | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/titles/audit-log/master.adoc b/titles/audit-log/master.adoc index df1b447da6..df697c3fce 100644 --- a/titles/audit-log/master.adoc +++ b/titles/audit-log/master.adoc @@ -8,4 +8,4 @@ include::artifacts/attributes.adoc[] :abstract: As a {product} administrator, you can track user activities, system events, and data changes with {product-short} audit logs. // Audit logging -include::assemblies/assembly-audit-log.adoc[leveloffset=+1] \ No newline at end of file +include::assemblies/assembly-audit-log.adoc[] \ No newline at end of file diff --git a/titles/telemetry/master.adoc b/titles/telemetry/master.adoc index e69f249c54..27bf6d2408 100644 --- a/titles/telemetry/master.adoc +++ b/titles/telemetry/master.adoc @@ -7,4 +7,4 @@ include::artifacts/attributes.adoc[] :abstract: As a {product} administrator, you can collect and analyze telemetry data to enhance your {product} experience. //Telemetry data collection -include::assemblies/assembly-rhdh-telemetry.adoc[leveloffset=+1] \ No newline at end of file +include::assemblies/assembly-rhdh-telemetry.adoc[] \ No newline at end of file From 535789780c0f54774ab7eaedec2ad5ea36c7f463 Mon Sep 17 00:00:00 2001 From: Heena Manwani Date: Fri, 8 Nov 2024 17:21:48 +0530 Subject: [PATCH 04/12] Fix issues --- titles/monitoring-and-logging/master.adoc | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/titles/monitoring-and-logging/master.adoc b/titles/monitoring-and-logging/master.adoc index 40764f882f..35eb15a70e 100644 --- a/titles/monitoring-and-logging/master.adoc +++ b/titles/monitoring-and-logging/master.adoc @@ -13,4 +13,4 @@ include::modules/admin/proc-rhdh-monitoring-logging-aws.adoc[leveloffset=+1] include::modules/admin/proc-rhdh-monitoring-logging-aks.adoc[leveloffset=+1] //metrics -include::assemblies/assembly-rhdh-observability.adoc[leveloffset=+1] \ No newline at end of file +include::assemblies/assembly-rhdh-observability.adoc[] \ No newline at end of file From 1f0641a1461d7139206c4f29741981f9db25170f Mon Sep 17 00:00:00 2001 From: Heena Manwani Date: Fri, 8 Nov 2024 17:24:39 +0530 Subject: [PATCH 05/12] Removing offset --- titles/monitoring-and-logging/master.adoc | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/titles/monitoring-and-logging/master.adoc b/titles/monitoring-and-logging/master.adoc index 35eb15a70e..4cf0f3c382 100644 --- a/titles/monitoring-and-logging/master.adoc +++ b/titles/monitoring-and-logging/master.adoc @@ -7,10 +7,10 @@ include::artifacts/attributes.adoc[] :abstract: As a {product} Operations or Project Manager, you can monitor performance and gather insights using {product}'s monitoring and logging tools. //AWS -include::modules/admin/proc-rhdh-monitoring-logging-aws.adoc[leveloffset=+1] +include::modules/admin/proc-rhdh-monitoring-logging-aws.adoc[] //AKS -include::modules/admin/proc-rhdh-monitoring-logging-aks.adoc[leveloffset=+1] +include::modules/admin/proc-rhdh-monitoring-logging-aks.adoc[] //metrics include::assemblies/assembly-rhdh-observability.adoc[] \ No newline at end of file From 668d6226e6fe1684332a6db4c10e8a1de6549a72 Mon Sep 17 00:00:00 2001 From: Heena Manwani Date: Fri, 8 Nov 2024 18:31:32 +0530 Subject: [PATCH 06/12] test --- titles/audit-log/master.adoc | 1 + 1 file changed, 1 insertion(+) diff --git a/titles/audit-log/master.adoc b/titles/audit-log/master.adoc index df697c3fce..a2547dbfcd 100644 --- a/titles/audit-log/master.adoc +++ b/titles/audit-log/master.adoc @@ -1,4 +1,5 @@ include::artifacts/attributes.adoc[] += Audit logs in {product} :context: title-audit-log :doctype: book :imagesdir: images From e4842b823a8d6ce0459463a44ca4f01f115fceb6 Mon Sep 17 00:00:00 2001 From: Heena Manwani Date: Fri, 8 Nov 2024 18:38:25 +0530 Subject: [PATCH 07/12] testing titles --- titles/audit-log/docinfo.xml | 6 +++--- titles/audit-log/master.adoc | 7 +------ 2 files changed, 4 insertions(+), 9 deletions(-) diff --git a/titles/audit-log/docinfo.xml b/titles/audit-log/docinfo.xml index 5f7fe2ebac..1cfb9fd79e 100644 --- a/titles/audit-log/docinfo.xml +++ b/titles/audit-log/docinfo.xml @@ -1,9 +1,9 @@ -{title} +Audit logs {product} {product-version} -{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. {company-name} Customer Content Services diff --git a/titles/audit-log/master.adoc b/titles/audit-log/master.adoc index a2547dbfcd..0029a42447 100644 --- a/titles/audit-log/master.adoc +++ b/titles/audit-log/master.adoc @@ -1,12 +1,7 @@ include::artifacts/attributes.adoc[] -= Audit logs in {product} :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. - // Audit logging -include::assemblies/assembly-audit-log.adoc[] \ No newline at end of file +include::assemblies/assembly-audit-log.adoc[leveloffset+1] \ No newline at end of file From a8690cc2f3c82c11888ebea5e9a0a06396190b7b Mon Sep 17 00:00:00 2001 From: Heena Manwani Date: Fri, 8 Nov 2024 18:48:20 +0530 Subject: [PATCH 08/12] test --- titles/audit-log/master.adoc | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/titles/audit-log/master.adoc b/titles/audit-log/master.adoc index 0029a42447..a4ce559e17 100644 --- a/titles/audit-log/master.adoc +++ b/titles/audit-log/master.adoc @@ -4,4 +4,4 @@ include::artifacts/attributes.adoc[] :imagesdir: images // Audit logging -include::assemblies/assembly-audit-log.adoc[leveloffset+1] \ No newline at end of file +include::assemblies/assembly-audit-log.adoc[] \ No newline at end of file From 7d0fe0e6994f22332d9e0c05919d9e78a118f7f8 Mon Sep 17 00:00:00 2001 From: Heena Manwani Date: Tue, 12 Nov 2024 16:55:02 +0530 Subject: [PATCH 09/12] fixing structure --- titles/audit-log/docinfo.xml | 6 +++--- titles/audit-log/master.adoc | 5 +++++ titles/monitoring-and-logging/master.adoc | 7 +++++-- titles/telemetry/master.adoc | 2 ++ 4 files changed, 15 insertions(+), 5 deletions(-) diff --git a/titles/audit-log/docinfo.xml b/titles/audit-log/docinfo.xml index 1cfb9fd79e..5f7fe2ebac 100644 --- a/titles/audit-log/docinfo.xml +++ b/titles/audit-log/docinfo.xml @@ -1,9 +1,9 @@ -Audit logs +{title} {product} {product-version} -Tracking user activities, system events, and data changes with {product} audit logs +{subtitle} - As a {product} administrator, you can track user activities, system events, and data changes with {product-short} audit logs. + {abstract} {company-name} Customer Content Services diff --git a/titles/audit-log/master.adoc b/titles/audit-log/master.adoc index a4ce559e17..8729aea3e0 100644 --- a/titles/audit-log/master.adoc +++ b/titles/audit-log/master.adoc @@ -2,6 +2,11 @@ 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[] \ No newline at end of file diff --git a/titles/monitoring-and-logging/master.adoc b/titles/monitoring-and-logging/master.adoc index 4cf0f3c382..616e991488 100644 --- a/titles/monitoring-and-logging/master.adoc +++ b/titles/monitoring-and-logging/master.adoc @@ -6,11 +6,14 @@ include::artifacts/attributes.adoc[] :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[] + //AWS include::modules/admin/proc-rhdh-monitoring-logging-aws.adoc[] //AKS include::modules/admin/proc-rhdh-monitoring-logging-aks.adoc[] -//metrics -include::assemblies/assembly-rhdh-observability.adoc[] \ No newline at end of file diff --git a/titles/telemetry/master.adoc b/titles/telemetry/master.adoc index 27bf6d2408..6bdc6f3983 100644 --- a/titles/telemetry/master.adoc +++ b/titles/telemetry/master.adoc @@ -6,5 +6,7 @@ include::artifacts/attributes.adoc[] :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[] \ No newline at end of file From 5dc4b407696b3c6cc77d6d5109a21b6f0ff528ba Mon Sep 17 00:00:00 2001 From: Heena Manwani Date: Tue, 12 Nov 2024 17:10:58 +0530 Subject: [PATCH 10/12] Changed order and updated version attribute --- artifacts/attributes.adoc | 6 +++--- assemblies/assembly-rhdh-observability.adoc | 5 ++--- assemblies/assembly-rhdh-telemetry.adoc | 12 ++++++------ 3 files changed, 11 insertions(+), 12 deletions(-) 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-rhdh-observability.adoc b/assemblies/assembly-rhdh-observability.adoc index 92032bc34d..79d9b799a8 100644 --- a/assemblies/assembly-rhdh-observability.adoc +++ b/assemblies/assembly-rhdh-observability.adoc @@ -3,13 +3,12 @@ = 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/observe/proc-admin-enabling-metrics-ocp-helm.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"] .Additional resources diff --git a/assemblies/assembly-rhdh-telemetry.adoc b/assemblies/assembly-rhdh-telemetry.adoc index 435f52b0ab..fb8b8a76f9 100644 --- a/assemblies/assembly-rhdh-telemetry.adoc +++ b/assemblies/assembly-rhdh-telemetry.adoc @@ -22,20 +22,20 @@ 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/admin/proc-disabling-telemetry-using-helm.adoc[leveloffset=+2] - include::modules/admin/proc-disabling-telemetry-using-operator.adoc[leveloffset=+2] +include::modules/admin/proc-disabling-telemetry-using-helm.adoc[leveloffset=+2]= + // enabling telemetry include::modules/admin/ref-enabling-telemetry.adoc[leveloffset=+1] -include::modules/admin/proc-enabling-telemetry-using-helm.adoc[leveloffset=+2] - include::modules/admin/proc-enabling-telemetry-using-operator.adoc[leveloffset=+2] +include::modules/admin/proc-enabling-telemetry-using-helm.adoc[leveloffset=+2] + // customizing telemetry segment source include::modules/admin/ref-customizing-telemetry-segment.adoc[leveloffset=+1] -include::modules/admin/proc-customizing-telemetry-segment-using-helm.adoc[leveloffset=+2] - include::modules/admin/proc-customizing-telemetry-segment-using-operator.adoc[leveloffset=+2] + +include::modules/admin/proc-customizing-telemetry-segment-using-helm.adoc[leveloffset=+2] \ No newline at end of file From fa3db6659f7770eb6c3a2786d8eb02cf6a9ba2a4 Mon Sep 17 00:00:00 2001 From: Heena Manwani Date: Tue, 12 Nov 2024 17:21:53 +0530 Subject: [PATCH 11/12] Fixing issue --- assemblies/assembly-rhdh-telemetry.adoc | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/assemblies/assembly-rhdh-telemetry.adoc b/assemblies/assembly-rhdh-telemetry.adoc index fb8b8a76f9..ec35980d64 100644 --- a/assemblies/assembly-rhdh-telemetry.adoc +++ b/assemblies/assembly-rhdh-telemetry.adoc @@ -24,7 +24,7 @@ include::modules/admin/ref-disabling-telemetry.adoc[leveloffset=+1] include::modules/admin/proc-disabling-telemetry-using-operator.adoc[leveloffset=+2] -include::modules/admin/proc-disabling-telemetry-using-helm.adoc[leveloffset=+2]= +include::modules/admin/proc-disabling-telemetry-using-helm.adoc[leveloffset=+2] // enabling telemetry include::modules/admin/ref-enabling-telemetry.adoc[leveloffset=+1] From 06c7c9a6756386211d7264b0c6740a09f31e6eea Mon Sep 17 00:00:00 2001 From: Heena Manwani Date: Wed, 13 Nov 2024 20:33:27 +0530 Subject: [PATCH 12/12] Moved files and chapter numbering reset --- assemblies/assembly-audit-log.adoc | 12 ++++++------ assemblies/assembly-rhdh-telemetry.adoc | 18 +++++++++--------- .../con-audit-log-config.adoc | 0 .../con-audit-log-track-changes-catalog.adoc | 0 .../proc-audit-log-view.adoc | 0 ...stomizing-telemetry-segment-using-helm.adoc | 0 ...izing-telemetry-segment-using-operator.adoc | 0 .../proc-disabling-telemetry-using-helm.adoc | 0 ...roc-disabling-telemetry-using-operator.adoc | 0 .../proc-enabling-telemetry-using-helm.adoc | 0 ...proc-enabling-telemetry-using-operator.adoc | 0 .../proc-rhdh-monitoring-logging-aks.adoc | 0 .../proc-rhdh-monitoring-logging-aws.adoc | 0 .../ref-audit-log-catalog-events.adoc | 0 .../ref-audit-log-fields.adoc | 0 .../ref-audit-log-file-rotation-overview.adoc | 0 .../ref-audit-log-scaffolder-events.adoc | 0 .../ref-customizing-telemetry-segment.adoc | 0 .../ref-disabling-telemetry.adoc | 0 .../ref-enabling-telemetry.adoc | 0 titles/audit-log/master.adoc | 2 +- titles/monitoring-and-logging/master.adoc | 6 +++--- titles/telemetry/master.adoc | 2 +- 23 files changed, 20 insertions(+), 20 deletions(-) rename modules/{getting-started => observe}/con-audit-log-config.adoc (100%) rename modules/{getting-started => observe}/con-audit-log-track-changes-catalog.adoc (100%) rename modules/{getting-started => observe}/proc-audit-log-view.adoc (100%) rename modules/{admin => observe}/proc-customizing-telemetry-segment-using-helm.adoc (100%) rename modules/{admin => observe}/proc-customizing-telemetry-segment-using-operator.adoc (100%) rename modules/{admin => observe}/proc-disabling-telemetry-using-helm.adoc (100%) rename modules/{admin => observe}/proc-disabling-telemetry-using-operator.adoc (100%) rename modules/{admin => observe}/proc-enabling-telemetry-using-helm.adoc (100%) rename modules/{admin => observe}/proc-enabling-telemetry-using-operator.adoc (100%) rename modules/{admin => observe}/proc-rhdh-monitoring-logging-aks.adoc (100%) rename modules/{admin => observe}/proc-rhdh-monitoring-logging-aws.adoc (100%) rename modules/{getting-started => observe}/ref-audit-log-catalog-events.adoc (100%) rename modules/{getting-started => observe}/ref-audit-log-fields.adoc (100%) rename modules/{getting-started => observe}/ref-audit-log-file-rotation-overview.adoc (100%) rename modules/{getting-started => observe}/ref-audit-log-scaffolder-events.adoc (100%) rename modules/{admin => observe}/ref-customizing-telemetry-segment.adoc (100%) rename modules/{admin => observe}/ref-disabling-telemetry.adoc (100%) rename modules/{admin => observe}/ref-enabling-telemetry.adoc (100%) 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-telemetry.adoc b/assemblies/assembly-rhdh-telemetry.adoc index ec35980d64..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-operator.adoc[leveloffset=+2] +include::modules/observe/proc-disabling-telemetry-using-operator.adoc[leveloffset=+2] -include::modules/admin/proc-disabling-telemetry-using-helm.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-operator.adoc[leveloffset=+2] +include::modules/observe/proc-enabling-telemetry-using-operator.adoc[leveloffset=+2] -include::modules/admin/proc-enabling-telemetry-using-helm.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-operator.adoc[leveloffset=+2] +include::modules/observe/proc-customizing-telemetry-segment-using-operator.adoc[leveloffset=+2] -include::modules/admin/proc-customizing-telemetry-segment-using-helm.adoc[leveloffset=+2] \ No newline at end of file +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/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/audit-log/master.adoc b/titles/audit-log/master.adoc index 8729aea3e0..f13644ae75 100644 --- a/titles/audit-log/master.adoc +++ b/titles/audit-log/master.adoc @@ -9,4 +9,4 @@ include::artifacts/attributes.adoc[] = {title} // Audit logging -include::assemblies/assembly-audit-log.adoc[] \ No newline at end of file +include::assemblies/assembly-audit-log.adoc[leveloffset=+1] \ No newline at end of file diff --git a/titles/monitoring-and-logging/master.adoc b/titles/monitoring-and-logging/master.adoc index 616e991488..e907100edd 100644 --- a/titles/monitoring-and-logging/master.adoc +++ b/titles/monitoring-and-logging/master.adoc @@ -9,11 +9,11 @@ include::artifacts/attributes.adoc[] = {title} //metrics -include::assemblies/assembly-rhdh-observability.adoc[] +include::assemblies/assembly-rhdh-observability.adoc[leveloffset=+1] //AWS -include::modules/admin/proc-rhdh-monitoring-logging-aws.adoc[] +include::modules/observe/proc-rhdh-monitoring-logging-aws.adoc[leveloffset=+1] //AKS -include::modules/admin/proc-rhdh-monitoring-logging-aks.adoc[] +include::modules/observe/proc-rhdh-monitoring-logging-aks.adoc[leveloffset=+1] diff --git a/titles/telemetry/master.adoc b/titles/telemetry/master.adoc index 6bdc6f3983..3d1a90e160 100644 --- a/titles/telemetry/master.adoc +++ b/titles/telemetry/master.adoc @@ -9,4 +9,4 @@ include::artifacts/attributes.adoc[] = {title} //Telemetry data collection -include::assemblies/assembly-rhdh-telemetry.adoc[] \ No newline at end of file +include::assemblies/assembly-rhdh-telemetry.adoc[leveloffset=+1] \ No newline at end of file