Doc updates (#1118)

* Doc updates

Author: andytael

docs-source/site/docs/deploy/buildpushapp.md

@@ -19,10 +19,10 @@ The image will be built using JKube and Maven. Add the following plugin into the
 
 The following needs to be updated to reflect your environment:
 
-- Image configuration, a mandatory, unique docker repository name. This can include registry and tag parts, but also placeholder parameters. example below has the following value `region/tenancy/repository/phonebook:${project.version}`
-- The base image which should be used for this image. In this example `ghcr.io/oracle/openjdk-image-obaas:21` is used.
-- assembly, mode how the assembled files should be collected. In this example files are simple copied, `dir`
-- cmd, A command to execute by default. in the example below `java -jar /deployments/${project.artifactId}-${project.version}.jar` will be executed.
+- Image configuration: a mandatory, unique Docker repository name. This can include registry and tag parts, but also placeholder parameters. The example below has the following value: `region/tenancy/repository/phonebook:${project.version}`
+- The base image which should be used for this image. In this example, `ghcr.io/oracle/openjdk-image-obaas:21` is used.
+- Assembly mode: how the assembled files should be collected. In this example, files are simply copied (`dir`).
+- Command: A command to execute by default. In the example below, `java -jar /deployments/${project.artifactId}-${project.version}.jar` will be executed.
 
 Refer to the [documentation for JKube](https://eclipse.dev/jkube/docs/kubernetes-maven-plugin/) for more configuration options.
 
@@ -57,7 +57,7 @@ To build and push the application execute the following command:
 mvn clean package k8s:build k8s:push
 ```
 
-If the build and push is successful then you shuould get a message similar to this:
+If the build and push is successful, you should get a message similar to this:
 
 ```log
 [INFO] k8s: Pushed sjc.ocir.io/maacloud/phonebook/phonebook:0.0.1-SNAPSHOT in 4 minutes and 2 seconds 

docs-source/site/docs/deploy/dbaccess.md

@@ -14,12 +14,12 @@ If your application needs database access, first obtain the database user creden
 
 Create a secret with database access information. This secret is used by the application configuration and is injected during deployment.
 
-For example if you have the following information:
+For example, if you have the following information:
 
-- `db.name:` Your database name. For example `helmdb`
-- `db.username:` Your database user name. For example `phonebook`
-- `db.password:` Your database user password. For example `Welcome-12345`
-- `db.service:` Your servicename. For example `helmdb_tp`
+- `db.name:` Your database name. For example, `helmdb`
+- `db.username:` Your database user name. For example, `phonebook`
+- `db.password:` Your database user password. For example, `Welcome-12345`
+- `db.service:` Your service name. For example, `helmdb_tp`
 - `db.lb_username` Your Liquibase username.
 - `db.lb_password` Your Liquibase user password.
 
@@ -74,7 +74,7 @@ args:
   sql $(DB_USER)/$(DB_PASSWORD)@$(TNS_ALIAS) @/tmp/run.sql
 ```
 
-Update the `env:` section to reference the correct secret and keys (here using `obaas-db-secrets`, this is not the same secret as been created above.):
+Update the `env:` section to reference the correct secret and keys (here using `obaas-db-secrets`; this is not the same secret as was created above):
 
 ```yaml
 env:

docs-source/site/docs/deploy/deployapp.md

@@ -24,38 +24,29 @@ Modify the `values.yaml` file to match your application’s requirements—for e
 The `obaas` section is unique for Oracle Backed for Microservices and AI. It has the following settings:
 
 ```yaml
+# Oracle Backend for Microservices and AI Settings.
 obaas:
-
-  # Framework selection: SPRING_BOOT or HELIDON
-  framework: SPRING_BOOT
-
-  namespace: obaas-dev
+  namespace: obaas-dev                      # Replace with your namespace 
   database:
-    credentialsSecret: phonebook-db-secrets
-    walletSecret: obaas-adb-tns-admin-1
-
-  # Opentelemetry monitoring
+    enabled: true                           # If true variables with DB secret content will be created
+    credentialsSecret: account-db-secrets   # Replace with your secret name
+    walletSecret: obaas-adb-tns-admin-1     # Replace with your wallet secret name
   otel:
-    enabled: true
-
+    enabled: true                           # Enable OpenTelemetry
   # MicroProfile LRA
   mp_lra:
-    enabled: false
-
+    enabled: true                          # Enable OTMM
   # Spring Boot applications
   springboot:
-    enabled: true
-
-  # Eureka discovery
+    enabled: true                           # Enable Spring Boot specific variables
   eureka:
-    enabled: true
+    enabled: true                           # Enable Eureka client
 ```
 
-- OBaaS supports both `SPRING_BOOT` or `HELIDON`. This is set via the `obaas.framework` parameter.
-- When `otel.enabled` is true, the `OTEL_EXPORTER_OTLP_ENDPOINT` environment variable is set to the appropriate value and injected into the deployment for application use. This is the URL of the OpenTelemetry (OTLP protocol) collector which can be used by your application to send observability data to the the SigNoz platform.
-- When `mp_lra.enabled` is true, the following environment variables are set to the appropriate value and injected into the deployment for application usee:
+- OBaaS supports both `SPRING_BOOT` and `HELIDON`. This is set via the `obaas.framework` parameter.
+- When `otel.enabled` is true, the `OTEL_EXPORTER_OTLP_ENDPOINT` environment variable is set to the appropriate value and injected into the deployment for application use. This is the URL of the OpenTelemetry (OTLP protocol) collector which can be used by your application to send observability data to the SigNoz platform.
+- When `mp_lra.enabled` is true, the following environment variables are set to the appropriate value and injected into the deployment for application use:
   - `MP_LRA_COORDINATOR_URL` This is the URL for the *transaction manager* which is required when using Eclipse Microprofile Long Running Actions in your application.
-  - `MP_LRA_PARTICIPANT_URL` This is the *participant* URL which is required when using Eclipse Microprofile Long Running Actions in your application.
 - When `springboot.enabled` is true, the following environment variables are set to the appropriate value and injected into the deployment for application use:
   - `SPRING_PROFILES_ACTIVE` This sets the Spring profiles that will be active in the application. The default value is `default`.
   - `SPRING_DATASOURCE_URL` This sets the data source URL for your application to use to connect to the database, for example `jdbc:oracle:thin:@$(DB_SERVICE)?TNS_ADMIN=/oracle/tnsadmin`.

docs-source/site/docs/deploy/introflow.md

@@ -8,15 +8,15 @@ sidebar_position: 1
 This content is TBD
 :::
 
-This guide explains how to deploy an application to OBaaS using Eclipse [Eclipse JKube](https://eclipse.dev/jkube/) to build and push a container image, and using Helm to install and configure the application on a Kubernetes cluster.
+This guide explains how to deploy an application to OBaaS using [Eclipse JKube](https://eclipse.dev/jkube/) to build and push a container image, and using Helm to install and configure the application on a Kubernetes cluster.
 
 ### Prerequisites
 
-- Access to a container image repository (e.g., OCIR or another approved registry).
+- Access to a container image repository (e.g., OCIR or another approved registry)
 - Docker running locally (and authenticated to your registry)
-- Kubernetes cluster access with the correct context set.
-- Helm installed locally.
-- Maven build configured for your project.
+- Kubernetes cluster access with the correct context set
+- Helm installed locally
+- Maven build configured for your project
 
 ### High Level Installation Flow
 

docs-source/site/docs/observability/configure.md

@@ -4,7 +4,7 @@ sidebar_position: 5
 ---
 ## Configure applications for SigNoz Observability
 
-In order for SigNoz to be able to collect logs, metrics and traces from applications, some configurations are required to be added.
+In order for SigNoz to collect logs, metrics, and traces from applications, some configurations must be added.
 
 ### Configure OpenTelemetry and Micrometer
 
@@ -199,7 +199,7 @@ signoz.io/port: "8080"
 signoz.io/scrape: "true"
 ```
 
-It also adds the `OTEL_EXPORTER_OTLP_ENDPOINT` to pod environment variables for the OpenTelemetry instrumentation libraries to access the the OpenTelemtry collector of SigNoz.
+It also adds the `OTEL_EXPORTER_OTLP_ENDPOINT` to pod environment variables for the OpenTelemetry instrumentation libraries to access the OpenTelemetry collector of SigNoz.
 
 ```yaml
 - name: OTEL_EXPORTER_OTLP_ENDPOINT

docs-source/site/docs/observability/dashboards.md

@@ -10,7 +10,6 @@ More details can be found in the [SigNoz Documentation](https://signoz.io/docs/i
 
 The following dashboards are pre-installed in SigNoz:
 
-- [Spring Boot Observability](#spring-boot-observability)
 - [Spring Boot Observability](#spring-boot-observability)
 - [Spring Boot Statistics](#spring-boot-statistics)
 - [Oracle Database Dashboard](#oracle-database-dashboard)
@@ -39,7 +38,7 @@ Here is an example of this dashboard displaying data for a simple application:
 
 This dashboard provides more in-depth information about services including the following:
 
-- JVM statistic like heap and non-heap memory usage, and details of garbage collection
+- JVM statistics like heap and non-heap memory usage, and details of garbage collection
 - Load average and open files
 - Database connection pool statistics (for HikariCP)
 - HTTP request statistics

docs-source/site/docs/observability/dbexporter.md

@@ -4,6 +4,6 @@ sidebar_position: 6
 ---
 ## Oracle Database Metrics Exporter
 
-Oracle Database Metrics Exporter aims to provide observability for the Oracle Database so that users can understand performance and diagnose issues easily across applications and database. Oracle Database Metrics Exporter deliver functionality to support both cloud and on-premises databases, including those running in Kubernetes and containers.
+Oracle Database Metrics Exporter aims to provide observability for the Oracle Database so that users can understand performance and diagnose issues easily across applications and the database. Oracle Database Metrics Exporter delivers functionality to support both cloud and on-premises databases, including those running in Kubernetes and containers.
 
 See the [documentation](https://oracle.github.io/oracle-db-appdev-monitoring/) for how to install and configure Oracle Database Metrics Exporter.

docs-source/site/docs/observability/metricslogstraces.md

@@ -12,7 +12,7 @@ To access metrics in SigNoz, click on _Services_ in the menu to see the list of
 
 ![Service List](images/service-list.png)
 
-Click on any of the services, to see its metrics in a dashboard.
+Click on any of the services to see its metrics in a dashboard.
 
 ![Service Metrics](images/service-metrics.png)
 

docs-source/site/docs/observability/overview.md

@@ -4,22 +4,22 @@ sidebar_position: 1
 ---
 ## Overview
 
-Oracle Backend for Microservices and AI includes SigNoz which is a observability platform to collect and provide access to logs. metrics and traces for the platform itself and for your applications.
+Oracle Backend for Microservices and AI includes SigNoz, which is an observability platform to collect and provide access to logs, metrics, and traces for the platform itself and for your applications.
 
-The diagram below provides an overview of the SigNoz:
+The diagram below provides an overview of SigNoz:
 
 ![Observability Overview](images/observability-overview.png)
 
 In the diagram above:
 
-- You may deploy applications into the platform and can either send the metrics, logs and traces to SigNoz OpenTelemetry collector or configure annotations on the application pod fo SigNoz to scrape metrics endpoints from the application pod directly. Similarly traces can be generated and sent to the SigNoz OpenTelemetry collector using the OpenTelemetry SDK. Please refer to [OpenTelemetry Collector - architecture and configuration guide](https://signoz.io/blog/opentelemetry-collector-complete-guide/) for details.
+- You may deploy applications into the platform and can either send the metrics, logs, and traces to the SigNoz OpenTelemetry collector or configure annotations on the application pod for SigNoz to scrape metrics endpoints from the application pod directly. Similarly, traces can be generated and sent to the SigNoz OpenTelemetry collector using the OpenTelemetry SDK. Please refer to the [OpenTelemetry Collector - architecture and configuration guide](https://signoz.io/blog/opentelemetry-collector-complete-guide/) for details.
 - The [Oracle Database Exporter](https://github.com/oracle/oracle-db-appdev-monitoring) and Kube State Metrics are pre-installed and SigNoz is configured to collect metrics from them.
-- SigNoz populated with a set of dashboards (some of them are described below).
+- SigNoz is populated with a set of dashboards (some of which are described below).
 
 :::note
 More details can be found in the [SigNoz Documentation](https://signoz.io/docs/introduction/).
 :::
 
 ### Oracle Database Monitoring Explorer
 
-With Oracle Backend for Microservices and AI you can choose to install [Oracle Database Monitoring Explorer](https://oracle.github.io/oracle-db-appdev-monitoring/). The tool provides observability for the Oracle Database so that users can understand performance and diagnose issues easily across applications and database. The project also provides dashboards for SigNoz.
+With Oracle Backend for Microservices and AI, you can choose to install [Oracle Database Monitoring Explorer](https://oracle.github.io/oracle-db-appdev-monitoring/). The tool provides observability for Oracle Database so that users can understand performance and diagnose issues easily across applications and the database. The project also provides dashboards for SigNoz.

docs-source/site/docs/platform/conductor.md

@@ -80,13 +80,13 @@ WORKFLOW_ID=$(curl -s -X POST 'http://localhost:8080/api/workflow/first_sample_w
 -d '{}' | tr -d '"')
 ```
 
-Check the Workflow IS, should return a string similar to this `46cbbaef-7133-451b-9334-2ccfc4e270c5`
+Check the Workflow ID; it should return a string similar to this: `46cbbaef-7133-451b-9334-2ccfc4e270c5`
 
 ```shell
 echo "Workflow ID: $WORKFLOW_ID"
 ```
 
-Check status of the Workflow, will return the data from https://restcountries.com/v3.1/name/united%20states?fields=name,population.
+Check the status of the workflow. This will return the data from https://restcountries.com/v3.1/name/united%20states?fields=name,population.
 
 ```shell
 curl -s -X GET "http://localhost:8080/api/workflow/$WORKFLOW_ID" | jq