From f70c2e412d1467536743764930c7c2ec8adaec0d Mon Sep 17 00:00:00 2001 From: gmunozfe Date: Tue, 2 Apr 2024 23:25:03 +0200 Subject: [PATCH] Issue-598 Holistic review of non-quarkus data index chapter --- .../data-index/data-index-core-concepts.adoc | 24 +++++++++---------- .../pages/data-index/data-index-service.adoc | 8 +++---- .../quarkus-dev-ui-overview.adoc | 12 +++++----- ...uarkus-dev-ui-workflow-instances-page.adoc | 12 +++++----- .../data-index-quarkus-extension.adoc | 4 ++-- .../_common_proc_deploy_kubectl_oc.adoc | 8 +++---- ...-produce-events-with-knative-eventing.adoc | 8 +++---- .../custom-functions-knative.adoc | 2 +- .../expose-metrics-to-prometheus.adoc | 6 ++--- ...erverless-dashboard-with-runtime-data.adoc | 6 ++--- .../job-service/quarkus-extensions.adoc | 8 +++---- .../integration-tests-with-postgresql.adoc | 4 ++-- .../persistence-with-postgresql.adoc | 4 ++-- .../kubernetes-service-discovery.adoc | 12 +++++----- 14 files changed, 59 insertions(+), 59 deletions(-) diff --git a/serverlessworkflow/modules/ROOT/pages/data-index/data-index-core-concepts.adoc b/serverlessworkflow/modules/ROOT/pages/data-index/data-index-core-concepts.adoc index 953e8c1db..6c0792942 100644 --- a/serverlessworkflow/modules/ROOT/pages/data-index/data-index-core-concepts.adoc +++ b/serverlessworkflow/modules/ROOT/pages/data-index/data-index-core-concepts.adoc @@ -47,7 +47,7 @@ The indexing functionality in the {data_index_ref} service is provided by choosi * link:{mongo_url}[MongoDB] ==== -The {data_index_ref} Service has been thought of as an application to store and query the existing workflow data. The data comes contained in events. The service allows multiple connection options as described in the <> section. +The {data_index_ref} Service has been thought of as an application to store and query the existing workflow data. The data comes within events. The service allows multiple connection options as described in the <> section. [#data-index-deployments] == {data_index_ref} scenarios @@ -67,11 +67,11 @@ This type of deployment requires to choose the right image depending on the pers [#data-index-dev-service] === {data_index_ref} service as Quarkus Development service It also can be deployed, transparently as a *Quarkus Development Service* when the Quarkus Dev mode is used in the {product_name} application. -When you use the {product_name} Process Quarkus extension, a temporary {data_index_ref} Service is automatically provisioned while the Quarkus application is running in development mode and the Dev Service is set up for immediate use. +When the {product_name} Process Quarkus extension is utilized, a temporary {data_index_ref} Service is automatically provisioned while the Quarkus application runs in development mode. The Quarkus Dev Service is immediately available for use. image::data-index/data-index-dev-service.png[Image of data-index deployment an Quarkus Dev Service] -More details are provided in the xref:data-index/data-index-service.adoc#data-index-dev-service-details[{data_index_ref} as a Quarkus Development service] section. +More details are provided in the xref:use-cases/advanced-developer-use-cases/data-index/data-index-as-quarkus-dev-service.adoc[{data_index_ref} as a Quarkus Development service] section. The {product_name} Process Quarkus extension sets up your Quarkus application to automatically replicate any {product_name} messaging events related to {workflow_instances} or jobs into the provisioned Data Index instance. @@ -96,7 +96,7 @@ More details are available in the xref:use-cases/advanced-developer-use-cases/da In order to store the indexed data, {data_index_ref} needs some specific tables to be created. {data_index_ref} is ready to use link:{flyway_quarkus_url}[Quarkus flyway] for that purpose. -It's necessary to activate the migrate-at-start option to migrate the {data_index_ref} schema automatically. +Activating the 'migrate-at-start' option enables automatic migration of the {data_index_ref} schema. For more details about Flyway migrations, see xref:use-cases/advanced-developer-use-cases/persistence/postgresql-flyway-migration.adoc[] section. @@ -104,7 +104,7 @@ For more details about Flyway migrations, see xref:use-cases/advanced-developer- == {data_index_ref} GraphQL endpoint {data_index_ref} provides GraphQL endpoint that allows users to interact with the stored data. -For more information about GraphQL see {graphql_url}[GraphQL] +For more information about GraphQL see {graphql_url}[GraphQL documentation] [#data-index-ext-queries] === GraphQL queries for {workflow_instances} and jobs @@ -445,12 +445,12 @@ mutation{ [NOTE] ==== -To enable described management operations on workflow instances, make sure your project is configured to have the `kogito-addons-quarkus-process-management` dependency on its `pom.xml` file to have this management operations enabled, like: +To enable described management operations on workflow instances, make sure your project is configured to have the `kie-addons-quarkus-process-management` dependency on its `pom.xml` file to have this management operations enabled, like: [source,xml] ---- - org.kie.kogito - kogito-addons-quarkus-process-management + org.kie + kie-addons-quarkus-process-management ---- ==== @@ -471,12 +471,12 @@ Retrieves the {workflow_instance} source file. When the `source` field of a {wor [NOTE] ==== -The workflow instance source field only will be available when `kogito-addons-quarkus-source-files` dependency is added on {product_name} runtime service `pom.xml` file. +The workflow instance source field only will be available when `kie-addons-quarkus-source-files` dependency is added on {product_name} runtime service `pom.xml` file. [source,xml] ---- - org.kie.kogito - kogito-addons-quarkus-source-files + org.kie + kie-addons-quarkus-source-files ---- ==== @@ -522,7 +522,7 @@ image::data-index/data-index-graphql-ui.png[Image of data-index GraphQL UI] When the {data_index_ref} is deployed as a standalone service, this UI will be available at `/graphiql/` endpoint (i.e: at http://localhost:8180/graphiql/) -To have the GraphQL UI available when the {data_index_ref} extension is deployed the property `quarkus.kogito.data-index.graphql.ui.always-include` needs to be enabled. +To enable the GraphQL UI when deploying the {data_index_ref} extension, the property `quarkus.kogito.data-index.graphql.ui.always-include` must be enabled. It will be accessible at: /graphql-ui/ (i.e: http://localhost:8080/q/graphql-ui/) diff --git a/serverlessworkflow/modules/ROOT/pages/data-index/data-index-service.adoc b/serverlessworkflow/modules/ROOT/pages/data-index/data-index-service.adoc index 3183a7506..66893ffca 100644 --- a/serverlessworkflow/modules/ROOT/pages/data-index/data-index-service.adoc +++ b/serverlessworkflow/modules/ROOT/pages/data-index/data-index-service.adoc @@ -40,12 +40,12 @@ For this purpose, it is important to make sure the following addons are included [source,xml] ---- - org.kie.kogito - kogito-addons-quarkus-events-process <1> + org.kie + kie-addons-quarkus-events-process <1> - org.kie.kogito - kogito-addons-quarkus-process-management <2> + org.kie + kie-addons-quarkus-process-management <2> ---- diff --git a/serverlessworkflow/modules/ROOT/pages/testing-and-troubleshooting/quarkus-dev-ui-extension/quarkus-dev-ui-overview.adoc b/serverlessworkflow/modules/ROOT/pages/testing-and-troubleshooting/quarkus-dev-ui-extension/quarkus-dev-ui-overview.adoc index 3a81c0c21..59df31fdb 100644 --- a/serverlessworkflow/modules/ROOT/pages/testing-and-troubleshooting/quarkus-dev-ui-extension/quarkus-dev-ui-overview.adoc +++ b/serverlessworkflow/modules/ROOT/pages/testing-and-troubleshooting/quarkus-dev-ui-extension/quarkus-dev-ui-overview.adoc @@ -34,19 +34,19 @@ Executing the previous command adds the following dependency to `pom.xml` file o [source,xml] ---- - org.kie.kogito - kogito-quarkus-serverless-workflow-devui + org.apache.kie.sonataflow + sonataflow-quarkus-devui ---- -- -. Enter the following command to add the `kogito-addons-quarkus-source-files` extension that provides the source code to generate the Serverless Workflow diagram in the consoles: +. Enter the following command to add the `kie-addons-quarkus-source-files` extension that provides the source code to generate the Serverless Workflow diagram in the consoles: + -- .Install Kogito source files add-on extension [source,shell] ---- -quarkus ext add org.kie.kogito:kogito-addons-quarkus-source-files +quarkus ext add org.kie.kogito:kie-addons-quarkus-source-files ---- Executing the previous command adds the following dependency to `pom.xml` file of your project: @@ -55,8 +55,8 @@ Executing the previous command adds the following dependency to `pom.xml` file o [source,xml] ---- - org.kie.kogito - kogito-addons-quarkus-source-files + org.kie + kie-addons-quarkus-source-files ---- -- diff --git a/serverlessworkflow/modules/ROOT/pages/testing-and-troubleshooting/quarkus-dev-ui-extension/quarkus-dev-ui-workflow-instances-page.adoc b/serverlessworkflow/modules/ROOT/pages/testing-and-troubleshooting/quarkus-dev-ui-extension/quarkus-dev-ui-workflow-instances-page.adoc index 5374a664d..29c022951 100644 --- a/serverlessworkflow/modules/ROOT/pages/testing-and-troubleshooting/quarkus-dev-ui-extension/quarkus-dev-ui-workflow-instances-page.adoc +++ b/serverlessworkflow/modules/ROOT/pages/testing-and-troubleshooting/quarkus-dev-ui-extension/quarkus-dev-ui-workflow-instances-page.adoc @@ -49,7 +49,7 @@ The Workflow Details page consists of the following panels: Serverless Workflow Diagram panel:: + -- -The Serverless Workflow Diagram panel enables you to explore the workflow diagram and execution path of the workflow instance. The workflow diagram and execution path are displayed by consuming the source which is exposed through the `kogito-addons-quarkus-source-files`. +The Serverless Workflow Diagram panel enables you to explore the workflow diagram and execution path of the workflow instance. The workflow diagram and execution path are displayed by consuming the source which is exposed through the `kie-addons-quarkus-source-files`. To add the source files add-on configuration, add the following dependency to `pom.xml` file of your project: @@ -57,8 +57,8 @@ To add the source files add-on configuration, add the following dependency to `p [source,xml] ---- - org.kie.kogito - kogito-addons-quarkus-source-files + org.kie + kie-addons-quarkus-source-files ---- @@ -130,13 +130,13 @@ image::testing-and-troubleshooting/quarkus-dev-ui-extension/kogito-swf-tools-wor [NOTE] ==== -To enable the actions kebab, make sure your project is configured to have the `kogito-addons-quarkus-process-management` +To enable the actions kebab, make sure your project is configured to have the `kie-addons-quarkus-process-management` dependency on its `pom.xml` file, like: [source,xml] ---- - org.kie.kogito - kogito-addons-quarkus-process-management + org.kie + kie-addons-quarkus-process-management ---- ==== diff --git a/serverlessworkflow/modules/ROOT/pages/use-cases/advanced-developer-use-cases/data-index/data-index-quarkus-extension.adoc b/serverlessworkflow/modules/ROOT/pages/use-cases/advanced-developer-use-cases/data-index/data-index-quarkus-extension.adoc index 9c6746af8..eab096f11 100644 --- a/serverlessworkflow/modules/ROOT/pages/use-cases/advanced-developer-use-cases/data-index/data-index-quarkus-extension.adoc +++ b/serverlessworkflow/modules/ROOT/pages/use-cases/advanced-developer-use-cases/data-index/data-index-quarkus-extension.adoc @@ -93,7 +93,7 @@ Manually to the POM.xml:: [source,xml] ---- - org.kie.kogito + org.kie kogito-addons-quarkus-data-index-postgresql ---- @@ -155,7 +155,7 @@ Manually to the POM.xml:: [source,xml] ---- - org.kie.kogito + org.kie kogito-addons-quarkus-data-index-persistence-postgresql ---- diff --git a/serverlessworkflow/modules/ROOT/pages/use-cases/advanced-developer-use-cases/deployments/common/_common_proc_deploy_kubectl_oc.adoc b/serverlessworkflow/modules/ROOT/pages/use-cases/advanced-developer-use-cases/deployments/common/_common_proc_deploy_kubectl_oc.adoc index 0dbd75e50..7d1548c88 100644 --- a/serverlessworkflow/modules/ROOT/pages/use-cases/advanced-developer-use-cases/deployments/common/_common_proc_deploy_kubectl_oc.adoc +++ b/serverlessworkflow/modules/ROOT/pages/use-cases/advanced-developer-use-cases/deployments/common/_common_proc_deploy_kubectl_oc.adoc @@ -22,8 +22,8 @@ pom.xml:: [source,xml,subs="attributes+"] ---- - org.kie.kogito - kogito-addons-quarkus-knative-eventing + org.kie + kie-addons-quarkus-knative-eventing io.quarkus @@ -35,13 +35,13 @@ Gradle:: [source,shell,subs="attributes+"] ---- quarkus-kubernetes 'io.quarkus:{quarkus-k8s-plugin}:{quarkus_version}' -quarkus-kubernetes 'org.kie.kogito:kogito-addons-quarkus-knative-eventing:{page-component-version}' +quarkus-kubernetes 'org.kie:kie-addons-quarkus-knative-eventing:{page-component-version}' ---- Quarkus CLI:: + [source,shell,subs="attributes+"] ---- -quarkus ext add org.kie.kogito:kogito-addons-quarkus-knative-eventing quarkus-openshift{page-component-version}' +quarkus ext add org.kie:kie-addons-quarkus-knative-eventing quarkus-openshift{page-component-version}' ---- ==== -- diff --git a/serverlessworkflow/modules/ROOT/pages/use-cases/advanced-developer-use-cases/event-orchestration/consume-produce-events-with-knative-eventing.adoc b/serverlessworkflow/modules/ROOT/pages/use-cases/advanced-developer-use-cases/event-orchestration/consume-produce-events-with-knative-eventing.adoc index a82fd5e41..8c3148b5c 100644 --- a/serverlessworkflow/modules/ROOT/pages/use-cases/advanced-developer-use-cases/event-orchestration/consume-produce-events-with-knative-eventing.adoc +++ b/serverlessworkflow/modules/ROOT/pages/use-cases/advanced-developer-use-cases/event-orchestration/consume-produce-events-with-knative-eventing.adoc @@ -22,21 +22,21 @@ Apache Maven:: + [source,shell] ---- -mvn quarkus:add-extension -Dextensions="kogito-addons-quarkus-knative-eventing" +mvn quarkus:add-extension -Dextensions="kie-addons-quarkus-knative-eventing" ---- Quarkus CLI:: + [source,shell] ---- -quarkus extension add kogito-addons-quarkus-knative-eventing +quarkus extension add kie-addons-quarkus-knative-eventing ---- Manually:: + [source,xml] ---- - org.kie.kogito - kogito-addons-quarkus-knative-eventing + org.kie + kie-addons-quarkus-knative-eventing ---- ==== diff --git a/serverlessworkflow/modules/ROOT/pages/use-cases/advanced-developer-use-cases/integrations/custom-functions-knative.adoc b/serverlessworkflow/modules/ROOT/pages/use-cases/advanced-developer-use-cases/integrations/custom-functions-knative.adoc index bb6843351..47687e0a5 100644 --- a/serverlessworkflow/modules/ROOT/pages/use-cases/advanced-developer-use-cases/integrations/custom-functions-knative.adoc +++ b/serverlessworkflow/modules/ROOT/pages/use-cases/advanced-developer-use-cases/integrations/custom-functions-knative.adoc @@ -26,7 +26,7 @@ include::../deployments/common/_prerequisites.adoc[] [source,xml] ---- - org.kie.kogito + org.kie kogito-addons-quarkus-knative-serving ---- diff --git a/serverlessworkflow/modules/ROOT/pages/use-cases/advanced-developer-use-cases/integrations/expose-metrics-to-prometheus.adoc b/serverlessworkflow/modules/ROOT/pages/use-cases/advanced-developer-use-cases/integrations/expose-metrics-to-prometheus.adoc index 46e2385ec..915dd318e 100644 --- a/serverlessworkflow/modules/ROOT/pages/use-cases/advanced-developer-use-cases/integrations/expose-metrics-to-prometheus.adoc +++ b/serverlessworkflow/modules/ROOT/pages/use-cases/advanced-developer-use-cases/integrations/expose-metrics-to-prometheus.adoc @@ -27,15 +27,15 @@ You can enable the metrics in your workflow application. For more information about creating a workflow, see xref:use-cases/advanced-developer-use-cases/getting-started/create-your-first-workflow-service.adoc[Creating your first workflow service]. .Procedure -. To add the metrics to your workflow application, add the `org.kie.kogito:kogito-addons-quarkus-monitoring-prometheus` dependency to the `pom.xml` file of your project: +. To add the metrics to your workflow application, add the `org.kie:kie-addons-quarkus-monitoring-prometheus` dependency to the `pom.xml` file of your project: + -- .Dependency to be added to the `pom.xml` file to enable metrics [source,xml] ---- - org.kie.kogito - kogito-addons-quarkus-monitoring-prometheus + org.kie + kie-addons-quarkus-monitoring-prometheus ---- -- diff --git a/serverlessworkflow/modules/ROOT/pages/use-cases/advanced-developer-use-cases/integrations/serverless-dashboard-with-runtime-data.adoc b/serverlessworkflow/modules/ROOT/pages/use-cases/advanced-developer-use-cases/integrations/serverless-dashboard-with-runtime-data.adoc index a583cbbd1..162db2448 100644 --- a/serverlessworkflow/modules/ROOT/pages/use-cases/advanced-developer-use-cases/integrations/serverless-dashboard-with-runtime-data.adoc +++ b/serverlessworkflow/modules/ROOT/pages/use-cases/advanced-developer-use-cases/integrations/serverless-dashboard-with-runtime-data.adoc @@ -39,15 +39,15 @@ You can build dashboards to monitor the data of your workflows using metrics. For more information about creating a workflow, see xref:use-cases/advanced-developer-use-cases/getting-started/create-your-first-workflow-service.adoc[Creating your first workflow service]. .Procedure -. To enable metrics for your workflows application add `org.kie.kogito:kogito-addons-quarkus-monitoring-prometheus` dependency in `pom.xml` file of your application: +. To enable metrics for your workflows application add `org.kie:kie-addons-quarkus-monitoring-prometheus` dependency in `pom.xml` file of your application: + -- .Add metrics dependency to `pom.xml` file [source,xml] ---- - org.kie.kogito - kogito-addons-quarkus-monitoring-prometheus + org.kie + kie-addons-quarkus-monitoring-prometheus ---- diff --git a/serverlessworkflow/modules/ROOT/pages/use-cases/advanced-developer-use-cases/job-service/quarkus-extensions.adoc b/serverlessworkflow/modules/ROOT/pages/use-cases/advanced-developer-use-cases/job-service/quarkus-extensions.adoc index 853a10792..23db402af 100644 --- a/serverlessworkflow/modules/ROOT/pages/use-cases/advanced-developer-use-cases/job-service/quarkus-extensions.adoc +++ b/serverlessworkflow/modules/ROOT/pages/use-cases/advanced-developer-use-cases/job-service/quarkus-extensions.adoc @@ -40,7 +40,7 @@ Manually:: [source,xml] ---- - org.kie.kogito + org.kie kogito-addons-quarkus-jobs-knative-eventing ---- @@ -115,7 +115,7 @@ Manually:: quarkus-smallrye-reactive-messaging-kafka - org.kie.kogito + org.kie kogito-addons-quarkus-jobs-messaging ---- @@ -162,7 +162,7 @@ Manually:: [source,xml] ---- - org.kie.kogito + org.kie kogito-addons-quarkus-jobs-management ---- @@ -212,7 +212,7 @@ Manually:: [source,xml] ---- - org.kie.kogito + org.kie kogito-addons-quarkus-jobs-service-embedded ---- diff --git a/serverlessworkflow/modules/ROOT/pages/use-cases/advanced-developer-use-cases/persistence/integration-tests-with-postgresql.adoc b/serverlessworkflow/modules/ROOT/pages/use-cases/advanced-developer-use-cases/persistence/integration-tests-with-postgresql.adoc index 7b1930b90..fdcf366b2 100644 --- a/serverlessworkflow/modules/ROOT/pages/use-cases/advanced-developer-use-cases/persistence/integration-tests-with-postgresql.adoc +++ b/serverlessworkflow/modules/ROOT/pages/use-cases/advanced-developer-use-cases/persistence/integration-tests-with-postgresql.adoc @@ -91,8 +91,8 @@ Ensure that the `pom.xml` file of your workflow application contains the require [source,xml] ---- - org.kie.kogito - kogito-addons-quarkus-persistence-jdbc + org.kie + kie-addons-quarkus-persistence-jdbc ---- diff --git a/serverlessworkflow/modules/ROOT/pages/use-cases/advanced-developer-use-cases/persistence/persistence-with-postgresql.adoc b/serverlessworkflow/modules/ROOT/pages/use-cases/advanced-developer-use-cases/persistence/persistence-with-postgresql.adoc index 009bbdbda..8cda100b6 100644 --- a/serverlessworkflow/modules/ROOT/pages/use-cases/advanced-developer-use-cases/persistence/persistence-with-postgresql.adoc +++ b/serverlessworkflow/modules/ROOT/pages/use-cases/advanced-developer-use-cases/persistence/persistence-with-postgresql.adoc @@ -48,8 +48,8 @@ This document relies on running PostgreSQL as a Docker service, however, if you [source,xml] ---- - org.kie.kogito - kogito-addons-quarkus-persistence-jdbc + org.kie + kie-addons-quarkus-persistence-jdbc ---- diff --git a/serverlessworkflow/modules/ROOT/pages/use-cases/advanced-developer-use-cases/service-discovery/kubernetes-service-discovery.adoc b/serverlessworkflow/modules/ROOT/pages/use-cases/advanced-developer-use-cases/service-discovery/kubernetes-service-discovery.adoc index a6b302fc5..21f0a1092 100644 --- a/serverlessworkflow/modules/ROOT/pages/use-cases/advanced-developer-use-cases/service-discovery/kubernetes-service-discovery.adoc +++ b/serverlessworkflow/modules/ROOT/pages/use-cases/advanced-developer-use-cases/service-discovery/kubernetes-service-discovery.adoc @@ -295,11 +295,11 @@ When activated, it leverages the Kubernetes Java API for service discovery, maki [source,xml] ---- - org.kie.kogito - kogito-addons-quarkus-kubernetes + org.kie + kie-addons-quarkus-kubernetes - org.kie.kogito + org.kie kogito-addons-quarkus-fabric8-kubernetes-service-catalog ---- @@ -312,11 +312,11 @@ This implementation retrieves information from the application's configuration, [source,xml] ---- - org.kie.kogito - kogito-addons-quarkus-kubernetes + org.kie + kie-addons-quarkus-kubernetes - org.kie.kogito + org.kie kogito-addons-quarkus-microprofile-config-service-catalog ----