This is an automated email from the ASF dual-hosted git repository.
dhanak pushed a commit to branch main
in repository
https://gitbox.apache.org/repos/asf/incubator-kie-kogito-examples.git
The following commit(s) were added to refs/heads/main by this push:
new 1456a9b14 kie-kogito-examples#2050: Follow-up fixes on README at main
branch (#2065)
1456a9b14 is described below
commit 1456a9b14e2b07903ec52603b2995b85afce0788
Author: Dominik Hanák <[email protected]>
AuthorDate: Wed Feb 5 11:17:18 2025 +0100
kie-kogito-examples#2050: Follow-up fixes on README at main branch (#2065)
* Cleanup README on main to accomodate 10.0.0
* Update README.md
Co-authored-by: Gonzalo Muñoz <[email protected]>
* Update README.md 2
Co-authored-by: Gonzalo Muñoz <[email protected]>
---------
Co-authored-by: Gonzalo Muñoz <[email protected]>
---
README.md | 173 ++++++++++++--------------------------------------------------
1 file changed, 32 insertions(+), 141 deletions(-)
diff --git a/README.md b/README.md
index 0ac337716..adf02ba50 100644
--- a/README.md
+++ b/README.md
@@ -1,168 +1,59 @@
-# Kogito Examples
+# Apache KIE Examples
-This module contains a number of examples that you can take a look at and try
out yourself. Please take a look at the readme of each individual example for
more details on how the example works and how to run it yourself (either
locally or on Kubernetes).
+This repository contains a number of examples for
[Drools](https://github.com/apache/incubator-kie-drools),
[jBPM](https://www.jbpm.org),
[Kogito](https://github.com/apache/incubator-kie-kogito-runtimes) and
[Sonataflow](https://sonataflow.org) that you can take a look at and try out
yourself. Please take a look at the readme of each individual example for more
details on how the example works and how to run it yourself.
-Since Kogito aims at supporting both Quarkus and Spring Boot each example
usually provides both type of projects.
+Apache KIE Examples showcase use cases, features, applications, know-how's of
everything our community's technology has to offer.
-- Default branch is `stable`, pointing to the latest released version.
-- **[You can also check all versions by looking at
releases.](https://github.com/apache/incubator-kie-kogito-examples/releases/latest)**
+Apache KIE Examples are currently updated after a stable release.
-## Use alternative Quarkus platforms
+## Branches
-The Quarkus quickstarts by default currently use the Quarkus core BOM.
+Current stable branch is `10.0.x`, pointing to the latest released `10.0.0`
version.
-If you want to use an alternative BOM when building the Quarkus quickstarts
you can override the `quarkus.platform.*` properties. The following example
shows how to set `quarkus.platform.artifact-id` to use the quarkus-universe-bom.
+Current development branch is `main`.
+
+## Use alternative Quarkus platforms with examples
+
+The examples that use Quarkus use the Quarkus core BOM by default.
+
+If you want to use an alternative BOM when building the Apache KIE Quarkus
quickstarts you can override the `quarkus.platform.*` properties. The following
example shows how to set `quarkus.platform.artifact-id` to use the
quarkus-universe-bom.
```
mvn -Dquarkus.platform.artifact-id=quarkus-universe-bom clean install
```
+Currently, only [Drools](https://github.com/apache/incubator-kie-drools) is
part of the Quarkus Platform.
+> Note: Integration of Kogito and Sonataflow are in progress.
-Because the Kogito project is part of the Quarkus Platform, the same applies
also to Kogito BOM being used.
+## Getting started with the examples
-By default `org.kie.kogito:kogito-bom` is used, but, when needed, this can be
overridden using Maven properties:
-* `kogito.bom.*` for Kogito BOM overrides
+1. Clone this repository
+```
+git clone [email protected]:apache/incubator-kie-kogito-examples.git
+```
+2. Navigate to the root of the example's directory
+```
+cd
./incubator-kie-kogito-examples/serverless-workflow-examples/serverless-workflow-funqy
+```
+3. Open the README.md and follow its instructions
-The properties defined in each of the modules and can be overridden as follows:
-* Kogito BOM
- ```
- mvn -Dkogito.bom.group-id=io.quarkus.platform
-Dkogito.bom.artifact-id=quarkus-kogito-bom -Dkogito.bom.version=2.2.3.Final
- ```
-> Note: It's important to keep BOM versions aligned when overriding. In case
of Quarkus Platform this means using a single
-> version value for all two (`quarkus.platform.version`, `kogito.bom.version`)
properties.
+> Found an issue? Please report it
[here](https://github.com/apache/incubator-kie-kogito-examples/issues/new?template=bug_report.yml)
and we will take a look.
## Contribution
-Everyone is encouraged to contribute to these examples by
+Everyone is encouraged to contribute to these examples by:
* trying it out and providing feedback and ideas for improvement
-* create new examples -- **in this case, make sure your PR is against the
`main` branch!**
+* creating new examples by sending a
[pull-request](https://github.com/apache/incubator-kie-kogito-examples/compare/main...main)
against main branch
* blogging about it
* using it on conferences and workshops
-
-## Process hello world with scripts
-
-shows most basic use of processes to build up a hello world example
-
-* [on Quarkus](kogito-quarkus-examples/process-scripts-quarkus)
-* [on Spring Boot](kogito-springboot-examples/process-scripts-springboot)
-
-
-## Process with business rules
-
-shows integration between processes and rules.
-
-* [on Quarkus](kogito-quarkus-examples/process-business-rules-quarkus)
-* [on Spring
Boot](kogito-springboot-examples/process-business-rules-springboot)
-
-
-## Process with Kafka
-
-shows how message start and end events can be easily used to integrate with
Apache Kafka to consume where
-message name is the Kafka topic and the payload is mapped to process variable.
Uses custom types
-that are serialized into JSON.
-
-* [on Quarkus](kogito-quarkus-examples/process-kafka-quickstart-quarkus)
-* [on Spring
Boot](kogito-springboot-examples/process-kafka-quickstart-springboot)
-
-## Process with Infinispan persistence
-
-shows long running processes with Infinispan persistence so the state of
process instances can
-be preserved across service restarts.
-
-* [on Quarkus](kogito-quarkus-examples/process-infinispan-persistence-quarkus)
-* [on Spring
Boot](kogito-springboot-examples/process-infinispan-persistence-springboot)
-
-## Process with service invocation
-
-shows how easy it is to use local services to be invoked from within process.
Allows easy and readable
-service invocation use cases to be covered.
-
-* [on Quarkus](kogito-quarkus-examples/process-service-calls-quarkus)
-* [on Spring Boot](kogito-springboot-examples/process-service-calls-springboot)
-
-## Process with REST call
-
-shows REST service invocation and parsing data back to an object instance used
as process variable.
-
-* [on Quarkus](kogito-quarkus-examples/process-rest-service-call-quarkus)
-* [on Spring
Boot](kogito-springboot-examples/process-rest-service-call-springboot)
-
-## Process with user tasks
-
-shows user task interactions with four eye principle applied
-
-* [on Quarkus](kogito-quarkus-examples/process-usertasks-quarkus)
-* [on Spring Boot](kogito-springboot-examples/process-usertasks-springboot)
-
-## Process with user tasks based on custom life cycle
-
-shows user task interactions with four eye principle applied that supports
custom life cycle that allows to
-add additional phases to user tasks to indicate other states.
-
-* [on
Quarkus](kogito-quarkus-examples/process-usertasks-custom-lifecycle-quarkus)
-* [on Spring
Boot](kogito-springboot-examples/process-usertasks-custom-lifecycle-springboot)
-
-## Process with user tasks with security on REST api
-
-shows user task interactions with four eye principle applied with security
restrictions on REST api.
-
-* [on Quarkus](kogito-quarkus-examples/process-usertasks-with-security-quarkus)
-* [on Spring
Boot](kogito-springboot-examples/process-usertasks-with-security-springboot)
-
-## Process with timers
-
-shows timers (intermediate and boundary) that allows to introduce delays in
process execution
-
-* [on Quarkus](kogito-quarkus-examples/process-timer-quarkus)
-* [on Spring Boot](kogito-springboot-examples/process-timer-springboot)
-
-## Serverless Workflow Getting Started
-
-A Serverless Workflow greeting service with both JSON and YAML workflow
definitions
-
-* [on
Quarkus](serverless-workflow-examples/serverless-workflow-greeting-quarkus)
-
-## Serverless Workflow with events
-
-A Serverless Workflow service for processing job applicant approvals and that
showcases event-driven services.
-
-* [on Quarkus](serverless-workflow-examples/serverless-workflow-events-quarkus)
-
-## Serverless Workflow with service calls
-
-A Serverless Workflow service for returning country information
-
-* [on
Quarkus](serverless-workflow-examples/serverless-workflow-service-calls-quarkus)
-
-## Serverless Workflow GitHub showcase
-
-A Serverless Workflow service that works as a Github bot application, which
reacts upon a new PR being opened in a given GitHub project.
-
-* [on
Quarkus](serverless-workflow-examples/serverless-workflow-github-showcase)
-
-## Serverless Workflow Correlation
-
-* [on Quarkus
(JDBC)](serverless-workflow-examples/serverless-workflow-correlation-quarkus)
-* [on Quarkus
(MongoDB)](serverless-workflow-examples/serverless-workflow-correlation-mongodb-quarkus)
-
-
-## Other Misc Examples
-
-- Onboarding example combining 1 process and two decision services: see
[README.md](kogito-quarkus-examples/onboarding-example/README.md)
-- Rules on Quarkus: see
[README.md](kogito-quarkus-examples/rules-quarkus-helloworld/README.md)
-- Rules on Quarkus with Unit: see
[README.md](kogito-quarkus-examples/ruleunit-quarkus-example/README.md)
-- Process on Quarkus: see
[README.md](kogito-quarkus-examples/process-quarkus-example/README.md)
-- Process on Spring Boot: see
[README.md](kogito-springboot-examples/process-springboot-example/README.md)
-- Trusty on Quarkus: see
[README.md](kogito-quarkus-examples/trusty-tracing-devservices/README.md)
-
## Getting Help
### Issues
-- Do you have a [minimal, reproducible
example](https://stackoverflow.com/help/minimal-reproducible-example) for your
issue?
- - If so, please open a Jira for it in the [Kogito
project](https://issues.redhat.com/projects/KOGITO/summary) with the details of
your issue and example.
+- Do you have a
[reproducer](https://stackoverflow.com/help/minimal-reproducible-example) for
your issue?
+ - If so, please open a new issue in
[Github](https://github.com/apache/incubator-kie-kogito-examples/issues)
repository with the details of your issue and affected example.
- Are you encountering an issue but unsure of what is going on?
- - Start a new conversation in the Kogito [Google
Group](https://groups.google.com/g/kogito-development), or open a new thread in
the [Kogito stream](https://kie.zulipchat.com/#narrow/stream/232676-kogito) of
the KIE Zulip chat.
- - Please provide as much relevant information as you can as to what could be
causing the issue, and our developers will help you figure out what's going
wrong.
+ - Start a new thread in our [Apache KIE Zulip
chat](https://kie.zulipchat.com/). Please use the channel which the example is
related to.
+ - Please provide as much relevant information as you can as to what could be
causing the issue and a reproducer. Our developers will help you figure out
what's going wrong.
### Requests
- Do you have a feature/enhancement request?
---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]
