LuboTerifaj commented on code in PR #519:
URL:
https://github.com/apache/incubator-kie-kogito-docs/pull/519#discussion_r1419479262
##########
serverlessworkflow/modules/ROOT/pages/data-index/data-index-quarkus-extension.adoc:
##########
@@ -67,21 +83,39 @@ You can add the {data_index_ref} quarkus extension as an
addon:
.Prerequisites
* Your workflow is running and has persistence enabled.
+* {data_index_ref} is using the same datasource to store indexed data
Review Comment:
This could be elaborated or referenced. It is not clear what should be set
here in comparison with what.
##########
serverlessworkflow/modules/ROOT/pages/data-index/data-index-quarkus-extension.adoc:
##########
@@ -30,21 +32,32 @@ The example described in this document is based on the
link:{kogito_sw_timeouts_
The {data_index_ref} service has been designed to store and manage data from
different workflow instances.
Communication with the service is through events that contain the workflows
related data and the service is responsible for storing them and exposing a
GraphQL endpoint to allow queries and maintenance operations on the different
workflow instances.
+image::data-index/data-index-addon.png[Image of data-index as a Quarkus
Extension]
+
In specific use cases, to avoid deploying the service separately, it could be
useful to have the indexing functionality and the query capabilities embedded
in the same application.
-For this purpose, the Quarkus {data_index_ref} extension can be added to any
workflow application and incorporates the {data_index_ref} functionality into
the same application without needing an external {data_index_ref} service.
+For this purpose, the Quarkus {data_index_ref} extension can be added to any
workflow application and incorporates the full {data_index_ref} functionality
into the same application without needing an external {data_index_ref} service.
These extensions are distributed as addons ready to work with different types
of persistence:
* kogito-addons-quarkus-data-index-inmemory (inmemory PostgreSQL)
* kogito-addons-quarkus-data-index-postgresql
* kogito-addons-quarkus-data-index-infinispan
* kogito-addons-quarkus-data-index-mongodb
+With the same purpose, the Quarkus {data_index_ref} persistence extension can
be added to any workflow application and incorporates only the {data_index_ref}
indexation and data persistence functionality into the same application without
needing an external {data_index_ref} service to do that.
+These extensions are distributed as addons ready to work with different types
of persistence:
+
+* kogito-addons-quarkus-data-index-persistence-postgresql
+* kogito-addons-quarkus-data-index-persistence-infinispan
+* kogito-addons-quarkus-data-index-persistence-mongodb
Review Comment:
This section could be simplified and made more readable.
##########
serverlessworkflow/modules/ROOT/pages/data-index/data-index-quarkus-extension.adoc:
##########
@@ -54,11 +67,14 @@ The {data_index_ref} addon distribution added to the
workflow must match the wor
The addon will share the data source used by the workflow where it is added,
and it will create separate tables for that purpose.
====
-When any of the {data_index_ref} addons is added:
+When any of the `kogito-addons-quarkus-data-index` or
`kogito-addons-quarkus-data-index-persistence` addons is added:
* The communication with the workflow is direct, the workflow data is *not*
transmitted or consumed through events, they are stored directly in the
configured database.
There is no need to configure the events connection for this purpose.
-* A new GraphQL endpoint is added to perform queries and management operations
+
+Only when any of the `kogito-addons-quarkus-data-index` addons is added:
+
+* A new GraphQL endpoint is added to perform queries and management operations
when `kogito-addons-quarkus-data-index` is added
Review Comment:
The section contains duplicate information. It could be simplified.
##########
serverlessworkflow/modules/ROOT/pages/data-index/data-index-quarkus-extension.adoc:
##########
@@ -30,21 +32,32 @@ The example described in this document is based on the
link:{kogito_sw_timeouts_
The {data_index_ref} service has been designed to store and manage data from
different workflow instances.
Communication with the service is through events that contain the workflows
related data and the service is responsible for storing them and exposing a
GraphQL endpoint to allow queries and maintenance operations on the different
workflow instances.
+image::data-index/data-index-addon.png[Image of data-index as a Quarkus
Extension]
Review Comment:
The image is shown without describing it first. Is it what we want?
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: [email protected]
For queries about this service, please contact Infrastructure at:
[email protected]
---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]
