Issue-598 Holistic review of non-quarkus data index chapter

apache · Apr 2, 2024 · a59687e · a59687e
1 parent cae59fa
commit a59687e
Show file tree

Hide file tree

Showing 18 changed files with 64 additions and 64 deletions.
diff --git a/...rlessworkflow/modules/ROOT/pages/cloud/operator/build-and-deploy-workflows.adoc b/...rlessworkflow/modules/ROOT/pages/cloud/operator/build-and-deploy-workflows.adoc
@@ -205,7 +205,7 @@ The table below lists the Dockerfile arguments available in the default {operato
 |===
 | Argument | Description | Example
 
-|QUARKUS_EXTENSIONS | List of link:{quarkus_extensions_url}[Quarkus Extensions] separated by comma that the builder should add to the workflow. | org.kie.kogito:kogito-addons-quarkus-persistence-jdbc:999-SNAPSHOT
+|QUARKUS_EXTENSIONS | List of link:{quarkus_extensions_url}[Quarkus Extensions] separated by comma that the builder should add to the workflow. | org.kie:kie-addons-quarkus-persistence-jdbc:999-SNAPSHOT
 |QUARKUS_ADD_EXTENSION_ARGS | Arguments passed to the Quarkus CLI when adding extensions. Enabled only when `QUARKUS_EXTENSIONS` is not empty. | See the link:{quarkus_cli_url}#using-the-cli[Quarkus CLI documentation]
 |MAVEN_ARGS_APPEND | Arguments passed to the maven build when the workflow build is produced. | -Dkogito.persistence.type=jdbc -Dquarkus.datasource.db-kind=postgresql
 |===

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
@@ -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 <<data-index-service-communication, {data_index_ref} service communication configuration>> 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 <<data-index-service-communication, {data_index_ref} service communication configuration>> 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,15 +96,15 @@ 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.
 
 [#data-index-graphql]
 == {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]
 ----
 <dependency>
-  <groupId>org.kie.kogito</groupId>
-  <artifactId>kogito-addons-quarkus-process-management</artifactId>
+  <groupId>org.kie</groupId>
+  <artifactId>kie-addons-quarkus-process-management</artifactId>
 </dependency>
 ----
 ====
@@ -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]
 ----
     <dependency>
-      <groupId>org.kie.kogito</groupId>
-      <artifactId>kogito-addons-quarkus-source-files</artifactId>
+      <groupId>org.kie</groupId>
+      <artifactId>kie-addons-quarkus-source-files</artifactId>
     </dependency>
 ----
 ====
@@ -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: <quarkus.http.root-path><quarkus.http.non-application-root-path>/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
@@ -40,12 +40,12 @@ For this purpose, it is important to make sure the following addons are included
 [source,xml]
 ----
 <dependency>
-  <groupId>org.kie.kogito</groupId>
-  <artifactId>kogito-addons-quarkus-events-process</artifactId> <1>
+  <groupId>org.kie</groupId>
+  <artifactId>kie-addons-quarkus-events-process</artifactId> <1>
 </dependency>
 <dependency>
-  <groupId>org.kie.kogito</groupId>
-  <artifactId>kogito-addons-quarkus-process-management</artifactId> <2>
+  <groupId>org.kie</groupId>
+  <artifactId>kie-addons-quarkus-process-management</artifactId> <2>
 </dependency>
 ----
 

diff --git a/...rlessworkflow/modules/ROOT/pages/eventing/event-correlation-with-workflows.adoc b/...rlessworkflow/modules/ROOT/pages/eventing/event-correlation-with-workflows.adoc
@@ -198,7 +198,7 @@ The engine stores the correlation information in the same persistence mechanism
 
 [NOTE]
 ====
-Currently, only `kogito-addons-quarkus-persistence-jdbc` persistence add-on supports correlation. The `kogito-addons-quarkus-persistence-jdbc`  add-on is configured for PostgreSQL. Other persistence add-ons will be supported in a future release.
+Currently, only `kie-addons-quarkus-persistence-jdbc` persistence add-on supports correlation. The `kie-addons-quarkus-persistence-jdbc`  add-on is configured for PostgreSQL. Other persistence add-ons will be supported in a future release.
 ====
 
 == Additional resources

diff --git a/...sting-and-troubleshooting/quarkus-dev-ui-extension/quarkus-dev-ui-overview.adoc b/...sting-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]
 ----
 <dependency>
-  <groupId>org.kie.kogito</groupId>
-  <artifactId>kogito-quarkus-serverless-workflow-devui</artifactId>
+  <groupId>org.apache.kie.sonataflow</groupId>
+  <artifactId>sonataflow-quarkus-devui</artifactId>
 </dependency>
 ----
 --
 
-. 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]
 ----
 <dependency>
-  <groupId>org.kie.kogito</groupId>
-  <artifactId>kogito-addons-quarkus-source-files</artifactId>
+  <groupId>org.kie</groupId>
+  <artifactId>kie-addons-quarkus-source-files</artifactId>
 </dependency>
 ----
 --

diff --git a/...leshooting/quarkus-dev-ui-extension/quarkus-dev-ui-workflow-instances-page.adoc b/...leshooting/quarkus-dev-ui-extension/quarkus-dev-ui-workflow-instances-page.adoc
@@ -49,16 +49,16 @@ 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:
 
 .source-files add-on dependency in `pom.xml` file
 [source,xml]
 ----
 <dependency>
-  <groupId>org.kie.kogito</groupId>
-  <artifactId>kogito-addons-quarkus-source-files</artifactId>
+  <groupId>org.kie</groupId>
+  <artifactId>kie-addons-quarkus-source-files</artifactId>
 </dependency>
 ----
 
@@ -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]
 ----
 <dependency>
-  <groupId>org.kie.kogito</groupId>
-  <artifactId>kogito-addons-quarkus-process-management</artifactId>
+  <groupId>org.kie</groupId>
+  <artifactId>kie-addons-quarkus-process-management</artifactId>
 </dependency>
 ----
 ====

diff --git a/...cases/advanced-developer-use-cases/data-index/data-index-quarkus-extension.adoc b/...cases/advanced-developer-use-cases/data-index/data-index-quarkus-extension.adoc
@@ -93,7 +93,7 @@ Manually to the POM.xml::
 [source,xml]
 ----
 <dependency>
-    <groupId>org.kie.kogito</groupId>
+    <groupId>org.kie</groupId>
     <artifactId>kogito-addons-quarkus-data-index-postgresql</artifactId>
 </dependency>
 ----
@@ -155,7 +155,7 @@ Manually to the POM.xml::
 [source,xml]
 ----
 <dependency>
-    <groupId>org.kie.kogito</groupId>
+    <groupId>org.kie</groupId>
     <artifactId>kogito-addons-quarkus-data-index-persistence-postgresql</artifactId>
 </dependency>
 ----

diff --git a/...nced-developer-use-cases/deployments/common/_common_proc_deploy_kubectl_oc.adoc b/...nced-developer-use-cases/deployments/common/_common_proc_deploy_kubectl_oc.adoc
@@ -22,8 +22,8 @@ pom.xml::
 [source,xml,subs="attributes+"]
 ----
 <dependency>
-  <groupId>org.kie.kogito</groupId>
-  <artifactId>kogito-addons-quarkus-knative-eventing</artifactId>
+  <groupId>org.kie</groupId>
+  <artifactId>kie-addons-quarkus-knative-eventing</artifactId>
 </dependency>
 <dependency>
   <groupId>io.quarkus</groupId>
@@ -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/...dvanced-developer-use-cases/deployments/common/_proc_deploy_sw_quarkus_cli.adoc b/...dvanced-developer-use-cases/deployments/common/_proc_deploy_sw_quarkus_cli.adoc
@@ -16,7 +16,7 @@ You can add the {platform} and the Kogito Knative extensions to your project wit
 .Add {platform} and Kogito Knative extensions to the project with Quarkus CLI
 [source,shell,subs="attributes+"]
 ----
-quarkus ext add {quarkus-k8s-plugin} kogito-addons-quarkus-knative-eventing
+quarkus ext add {quarkus-k8s-plugin} kie-addons-quarkus-knative-eventing
 ----
 --
 . To deploy the workflow application using Quarkus CLI, set the following system properties in `application.properties` file:

diff --git a/...use-cases/event-orchestration/consume-produce-events-with-knative-eventing.adoc b/...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]
 ----
 <dependency>
-    <groupId>org.kie.kogito</groupId>
-    <artifactId>kogito-addons-quarkus-knative-eventing</artifactId>
+    <groupId>org.kie</groupId>
+    <artifactId>kie-addons-quarkus-knative-eventing</artifactId>
 </dependency>
 ----
 ====

diff --git a/...e-cases/advanced-developer-use-cases/integrations/custom-functions-knative.adoc b/...e-cases/advanced-developer-use-cases/integrations/custom-functions-knative.adoc
@@ -26,7 +26,7 @@ include::../deployments/common/_prerequisites.adoc[]
 [source,xml]
 ----
 <dependency>
-    <groupId>org.kie.kogito</groupId>
+    <groupId>org.kie</groupId>
     <artifactId>kogito-addons-quarkus-knative-serving</artifactId>
 </dependency>
 ----

diff --git a/...ses/advanced-developer-use-cases/integrations/expose-metrics-to-prometheus.adoc b/...ses/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]
 ----
 <dependency>
-    <groupId>org.kie.kogito</groupId>
-    <artifactId>kogito-addons-quarkus-monitoring-prometheus</artifactId>
+    <groupId>org.kie</groupId>
+    <artifactId>kie-addons-quarkus-monitoring-prometheus</artifactId>
 </dependency>
 ----
 --

diff --git a/...ed-developer-use-cases/integrations/serverless-dashboard-with-runtime-data.adoc b/...ed-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]
 ----
     <dependency>
-      <groupId>org.kie.kogito</groupId>
-      <artifactId>kogito-addons-quarkus-monitoring-prometheus</artifactId>
+      <groupId>org.kie</groupId>
+      <artifactId>kie-addons-quarkus-monitoring-prometheus</artifactId>
     </dependency>
 ----
 

diff --git a/...ages/use-cases/advanced-developer-use-cases/job-service/quarkus-extensions.adoc b/...ages/use-cases/advanced-developer-use-cases/job-service/quarkus-extensions.adoc
@@ -40,7 +40,7 @@ Manually::
 [source,xml]
 ----
 <dependency>
-    <groupId>org.kie.kogito</groupId>
+    <groupId>org.kie</groupId>
     <artifactId>kogito-addons-quarkus-jobs-knative-eventing</artifactId>
 </dependency>
 ----
@@ -115,7 +115,7 @@ Manually::
     <artifactId>quarkus-smallrye-reactive-messaging-kafka</artifactId>
 </dependency>
 <dependency>
-    <groupId>org.kie.kogito</groupId>
+    <groupId>org.kie</groupId>
     <artifactId>kogito-addons-quarkus-jobs-messaging</artifactId>
 </dependency>
 ----
@@ -162,7 +162,7 @@ Manually::
 [source,xml]
 ----
 <dependency>
-    <groupId>org.kie.kogito</groupId>
+    <groupId>org.kie</groupId>
     <artifactId>kogito-addons-quarkus-jobs-management</artifactId>
 </dependency>
 ----
@@ -212,7 +212,7 @@ Manually::
 [source,xml]
 ----
 <dependency>
-    <groupId>org.kie.kogito</groupId>
+    <groupId>org.kie</groupId>
     <artifactId>kogito-addons-quarkus-jobs-service-embedded</artifactId>
 </dependency>
 ----

diff --git a/...advanced-developer-use-cases/persistence/integration-tests-with-postgresql.adoc b/...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]
 ----
 <dependency>
-  <groupId>org.kie.kogito</groupId>
-  <artifactId>kogito-addons-quarkus-persistence-jdbc</artifactId>
+  <groupId>org.kie</groupId>
+  <artifactId>kie-addons-quarkus-persistence-jdbc</artifactId>
 </dependency>
 ----
 

diff --git a/...cases/advanced-developer-use-cases/persistence/persistence-with-postgresql.adoc b/...cases/advanced-developer-use-cases/persistence/persistence-with-postgresql.adoc
@@ -14,7 +14,7 @@
 :postgresql_doc_url: https://www.postgresql.org/docs/current/
 :flyway_url: https://flywaydb.org/
 
-The {product_name} PostgreSQL persistence is provided by the `kogito-addons-quarkus-persistence-jdbc` add-on, which is based on the Java Database Connectivity (JDBC).
+The {product_name} PostgreSQL persistence is provided by the `kie-addons-quarkus-persistence-jdbc` add-on, which is based on the Java Database Connectivity (JDBC).
 Additionally, it uses the Quarkus JDBC for PostgreSQL and Argoal Datasource extensions to connect with the database. And thus, it automatically inherits all the features of these extensions.
 For more information about Quarkus and JDBC, see link:{quarkus_datasource_guide}[Quarkus Datasources].
 
@@ -48,8 +48,8 @@ This document relies on running PostgreSQL as a Docker service, however, if you
 [source,xml]
 ----
 <dependency>
-  <groupId>org.kie.kogito</groupId>
-  <artifactId>kogito-addons-quarkus-persistence-jdbc</artifactId>
+  <groupId>org.kie</groupId>
+  <artifactId>kie-addons-quarkus-persistence-jdbc</artifactId>
 </dependency>
 ----
 

diff --git a/...cases/advanced-developer-use-cases/persistence/postgresql-flyway-migration.adoc b/...cases/advanced-developer-use-cases/persistence/postgresql-flyway-migration.adoc
@@ -25,7 +25,7 @@ quarkus.datasource.db-kind=postgresql
 --
 This will create a schema history table `flyway_schema_history` in your database to track the version of each database, recording in it every versioned migration file applied to build that version.
 
-NOTE: When using `kogito-addons-persistence-jdbc`, it is mandatory to set the `quarkus.datasource.db-kind` property, so that Flyway can locate the appropriate scripts for the database.
+NOTE: When using `kie-addons-persistence-jdbc`, it is mandatory to set the `quarkus.datasource.db-kind` property, so that Flyway can locate the appropriate scripts for the database.
 
 === Migrate using Flyway CLI
 If you want to migrate manually you can use the Flyway migration CLI tool.