Skip to content

Commit

Permalink
Merge pull request #105 from domhanak/SRVLOGIC-184
Browse files Browse the repository at this point in the history
SRVLOGIC-184: Review documentation for TP2
  • Loading branch information
ricardozanini authored Dec 18, 2023
2 parents b21c641 + 57ae35c commit 0d8c6e2
Show file tree
Hide file tree
Showing 124 changed files with 5,799 additions and 1,850 deletions.
19 changes: 10 additions & 9 deletions antora.yml
Original file line number Diff line number Diff line change
Expand Up @@ -13,24 +13,25 @@ asciidoc:
serverlessoperatorname: OpenShift Serverless Operator
serverlessproductname: OpenShift Serverless
product_name: OpenShift Serverless Logic
kogito_version_redhat: 1.38.0.Final-redhat-00002
operator_name: Kogito Serverless Workflow Operator
kogito_version_redhat: 1.44.0.Final-redhat-00005
operator_name: Serverless Logic Operator
quarkus_platform: com.redhat.quarkus.platform
kogito_sw_ga: >-
org.kie.kogito:kogito-quarkus-serverless-workflow
quarkus_version: 2.13.7.Final-redhat-00003
quarkus_platform_version: 2.13.7.Final-redhat-00003
quarkus_version: 2.13.8.SP3-redhat-00001
quarkus_platform_version: 2.13.8.SP3-redhat-00001
java_min_version: 11+
maven_min_version: 3.8.6
graalvm_min_version: 22.3.0
spec_version: 0.8
vscode_version: 1.66.0
kn_cli_version: 0.28.0
vscode_version: 1.84.0
kn_cli_version: 0.32.0
docker_min_version: 20.10.7
docker_compose_min_version: 1.27.2
operator_version: v1.38.0
operator_version: 1.31
kogito_examples_repository_url: 'https://github.com/kiegroup/kogito-examples'
kogito_sw_examples_url: https://github.com/kiegroup/kogito-examples/tree/1.38.x/serverless-workflow-examples
kogito_sw_operator_examples_url: https://github.com/apache/incubator-kie-kogito-examples/tree/1.44.x/serverless-operator-examples
kogito_sw_examples_url: https://github.com/kiegroup/kogito-examples/tree/1.44.x/serverless-workflow-examples
kogito_examples_url: 'https://github.com/kiegroup/kogito-examples.git'
kogito_apps_url: https://github.com/kiegroup/kogito-apps/tree/main
quarkus_cli_url: 'https://quarkus.io/guides/cli-tooling'
Expand Down Expand Up @@ -79,5 +80,5 @@ asciidoc:
kaoto_url: https://marketplace.visualstudio.com/items?itemName=redhat.vscode-kaoto

minikube_url: https://minikube.sigs.k8s.io
kogito_serverless_operator_url: https://github.com/kiegroup/kogito-serverless-operator/
kogito_serverless_operator_url: https://github.com/apache/incubator-kie-kogito-serverless-operator/
docs_issues_url: https://github.com/kiegroup/kogito-docs/issues/new
86 changes: 48 additions & 38 deletions modules/ROOT/nav.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -12,27 +12,24 @@
** xref:serverless-logic:about.adoc[About OpenShift Serverless Logic]
** User Guides
*** Getting Started
**** xref:serverless-logic:getting-started/create-your-first-workflow-service-with-kn-cli-and-vscode.adoc[Creating your first workflow service with KN CLI and VS Code]
**** xref:serverless-logic:getting-started/create-your-first-workflow-service.adoc[Creating your first workflow service]
**** xref:serverless-logic:getting-started/cncf-serverless-workflow-specification-support.adoc[CNCF Serverless Workflow specification]
**** xref:serverless-logic:getting-started/getting-familiar-with-our-tooling.adoc[Getting familiar with tooling]
*** Core
**** xref:serverless-logic:core/cncf-serverless-workflow-specification-support.adoc[CNCF Serverless Workflow specification]
**** xref:serverless-logic:core/handling-events-on-workflows.adoc[Events]
**** xref:serverless-logic:core/working-with-callbacks.adoc[Callbacks]
**** xref:serverless-logic:core/understanding-jq-expressions.adoc[jq expressions]
**** xref:serverless-logic:core/understanding-workflow-error-handling.adoc[Error handling]
**** xref:serverless-logic:core/working-with-parallelism.adoc[Parallelism]
**** xref:serverless-logic:core/configuration-properties.adoc[Configuration properties]
//**** xref:serverless-logic:core/accessing-workflow-metainformation-in-runtime.adoc[Accessing workflow metainformation in runtime]
**** xref:serverless-logic:core/defining-an-input-schema-for-workflows.adoc[Defining an input schema for your workflows]
**** xref:serverless-logic:core/custom-functions-support.adoc[Custom functions for your service]
**** xref:serverless-logic:core/timeouts-support.adoc[Timeouts]
**** xref:serverless-logic:core/working-with-parallelism.adoc[Parallelism]
*** Tooling
**** xref:serverless-logic:tooling/serverless-workflow-editor/swf-editor-overview.adoc[Serverless Workflow editor]
***** xref:serverless-logic:tooling/serverless-workflow-editor/swf-editor-vscode-extension.adoc[VS Code extension for Serverless Workflow editor]
***** xref:serverless-logic:tooling/serverless-workflow-editor/swf-editor-chrome-extension.adoc[Chrome GitHub extension for Serverless Workflow editor]
**** xref:serverless-logic:tooling/quarkus-dev-ui-extension/quarkus-dev-ui-overview.adoc[Kogito Serverless Workflow Tools extension in Quarkus Dev UI]
***** xref:serverless-logic:tooling/quarkus-dev-ui-extension/quarkus-dev-ui-workflow-instances-page.adoc[Workflow Instances in Kogito Serverless Workflow Tools extension]
***** xref:serverless-logic:tooling/quarkus-dev-ui-extension/quarkus-dev-ui-workflow-definition-page.adoc[Workflow Definitions in Kogito Serverless Workflow Tools extension]
***** xref:serverless-logic:tooling/quarkus-dev-ui-extension/quarkus-dev-ui-custom-dashboard-page.adoc[Dashboards in Kogito Serverless Workflow Tools extension]
**** xref:serverless-logic:tooling/kn-plugin-workflow-overview.adoc[{product_name} plug-in for Knative CLI]
**** xref:serverless-logic:tooling/serverless-logic-web-tools/serverless-logic-web-tools-overview.adoc[{serverless_logic_web_tools_name}]
***** xref:serverless-logic:tooling/serverless-logic-web-tools/serverless-logic-web-tools-github-integration.adoc[GitHub integration]
***** xref:serverless-logic:tooling/serverless-logic-web-tools/serverless-logic-web-tools-openshift-integration.adoc[OpenShift integration]
Expand All @@ -41,64 +38,77 @@
***** xref:serverless-logic:tooling/serverless-logic-web-tools/serverless-logic-web-tools-enable-kogito-swf-visualization.adoc[Kogito Serverless Workflow Visualization]
*** Service Orchestration
**** xref:serverless-logic:service-orchestration/orchestration-of-openapi-based-services.adoc[Orchestrating the OpenAPI services]
**** xref:serverless-logic:service-orchestration/configuring-openapi-services-endpoints.adoc[Configuring the OpenAPI services endpoints]
**** xref:serverless-logic:service-orchestration/orchestration-of-asyncapi-based-services.adoc[Orchestrating the AsyncAPI services]
***** xref:serverless-logic:service-orchestration/configuring-openapi-services-endpoints.adoc[Configuring the OpenAPI services endpoints]
***** xref:serverless-logic:service-orchestration/working-with-openapi-callbacks.adoc.adoc[OpenAPI callback in {product_name}]
**** xref:serverless-logic:service-orchestration/orchestration-of-grpc-services.adoc[Orchestration of gRPC based services]
*** Eventing
**** xref:serverless-logic:eventing/handling-events-on-workflows.adoc[Event State]
**** xref:serverless-logic:eventing/consume-producing-events-with-kafka.adoc[Consuming and producing events using Apache Kafka]
**** xref:serverless-logic:eventing/consume-produce-events-with-knative-eventing.adoc[Consuming and producing events on Knative Eventing]
*** Event Orchestration
**** xref:serverless-logic:eventing/orchestration-of-asyncapi-callbacks.adoc[Orchestrating AsyncAPI Services]
**** xref:serverless-logic:eventing/event-correlation-with-workflows.adoc[Event Correlation]
**** xref:serverless-logic:eventing/working-with-callbacks.adoc[Callback State]
**** xref:serverless-logic:eventing/working-with-openapi-callbacks.adoc[OpenAPI Callback]
**** Quarkus
***** xref:serverless-logic:eventing/consume-producing-events-with-kafka.adoc[Consuming and producing events using Apache Kafka]
**** xref:serverless-logic:eventing/consume-produce-events-with-knative-eventing.adoc[Consuming and producing events on Knative Eventing]
*** Security
**** xref:serverless-logic:security/authention-support-for-openapi-services.adoc[Authentication for OpenAPI services]
**** xref:serverless-logic:security/orchestrating-third-party-services-with-oauth2.adoc[Orchestration of third-party services using OAuth 2.0 authentication]
*** Testing and Troubleshooting
**** xref:serverless-logic:testing-and-troubleshooting/mocking-http-cloudevents-with-wiremock.adoc[Mocking HTTP CloudEvents sink using WireMock]
**** xref:serverless-logic:testing-and-troubleshooting/mocking-openapi-services-with-wiremock.adoc[Mocking OpenAPI services using WireMock]
**** xref:serverless-logic:testing-and-troubleshooting/basic-integration-tests-with-restassured.adoc[Testing using REST Assured]
//**** xref:serverless-logic:testing-and-troubleshooting/debugging-workflow-execution-runtime.adoc[Debugging the workflow execution in runtime]
**** xref:serverless-logic:testing-and-troubleshooting/integration-tests-with-postgresql.adoc[Integration tests using PostgreSQL]
//**** xref:serverless-logic:testing-and-troubleshooting/development-tools-for-troubleshooting.adoc[Development tools for troubleshooting]
*** Executing, Testing and Troubleshooting
**** Executing and Testing Workflows
***** xref:serverless-logic:testing-and-troubleshooting/quarkus-dev-ui-extension/quarkus-dev-ui-overview.adoc[Developer UI]
****** xref:serverless-logic:testing-and-troubleshooting/quarkus-dev-ui-extension/quarkus-dev-ui-workflow-instances-page.adoc[Workflow Instances]
****** xref:serverless-logic:testing-and-troubleshooting/quarkus-dev-ui-extension/quarkus-dev-ui-workflow-definition-page.adoc[Workflow Definitions]
****** xref:serverless-logic:testing-and-troubleshooting/quarkus-dev-ui-extension/quarkus-dev-ui-monitoring-page.adoc[Monitoring]
****** xref:serverless-logic:testing-and-troubleshooting/quarkus-dev-ui-extension/quarkus-dev-ui-custom-dashboard-page.adoc[Dashboards]
***** xref:serverless-logic:testing-and-troubleshooting/kn-plugin-workflow-overview.adoc[Command Line]
**** Quarkus
***** xref:serverless-logic:testing-and-troubleshooting/mocking-http-cloudevents-with-wiremock.adoc[Mocking HTTP CloudEvents sink using WireMock]
***** xref:serverless-logic:testing-and-troubleshooting/mocking-openapi-services-with-wiremock.adoc[Mocking OpenAPI services using WireMock]
***** xref:serverless-logic:testing-and-troubleshooting/basic-integration-tests-with-restassured.adoc[Testing using REST Assured]
*** Persistence
**** xref:serverless-logic:persistence/persistence-with-postgresql.adoc[Running a workflow service using PostgreSQL]
**** xref:serverless-logic:persistence/postgresql-flyway-migration.adoc[Migrate your PostgreSQL database]
//**** xref:serverless-logic:persistence/workflow-database-for-db-admins.adoc[Workflows database for DB admins]
// **** xref:serverless-logic:persistence/data-consistency.adoc[Data consistency]
**** Quarkus
***** xref:serverless-logic:persistence/persistence-with-postgresql.adoc[Running a workflow service using PostgreSQL]
***** xref:serverless-logic:persistence/postgresql-flyway-migration.adoc[Migrate your PostgreSQL database]
***** xref:serverless-logic:persistence/integration-tests-with-postgresql.adoc[Integration Tests with PostgreSQL]
*** xref:serverless-logic:cloud/index.adoc[Cloud]
**** Operator
***** xref:serverless-logic:cloud/operator/install-serverless-operator.adoc[Installation]
***** xref:serverless-logic:cloud/operator/developing-workflows.adoc[Developing Workflows]
***** xref:serverless-logic:cloud/operator/configuring-workflows.adoc[Configuring Workflows]
***** xref:serverless-logic:cloud/operator/workflow-status-conditions.adoc[Workflows Status]
***** xref:serverless-logic:cloud/operator/developing-workflows.adoc[Development Mode]
***** xref:serverless-logic:cloud/operator/referencing-resource-files.adoc[Referencing Workflow Resources]
***** xref:serverless-logic:cloud/operator/configuring-workflows.adoc[Configuration]
***** xref:serverless-logic:cloud/operator/build-and-deploy-workflows.adoc[Building and Deploying Workflows]
***** xref:serverless-logic:cloud/operator/workflow-status-conditions.adoc[Custom Resource Status]
***** xref:serverless-logic:cloud/operator/known-issues.adoc[Known Issues]
**** Quarkus
***** xref:serverless-logic:cloud/quarkus/build-workflow-image-with-quarkus-cli.adoc[Building workflow images using Quarkus CLI]
// *** xref:serverless-logic:cloud/build-workflow-images-with-tekton.adoc[Building Workflow Images with Tekton Pipelines]
***** xref:serverless-logic:cloud/quarkus/build-workflow-image-with-quarkus-cli.adoc[Building workflow images]
***** xref:serverless-logic:cloud/quarkus/deploying-on-minikube.adoc[Deploying Workflows on Minikube]
***** xref:serverless-logic:cloud/quarkus/deploying-on-kubernetes.adoc[Deploying Workflows on Kubernetes]
// *** xref:serverless-logic:cloud/versioning-workflows-in-knative.adoc[Versioning workflows in Knative]
***** xref:serverless-logic:cloud/deploying-on-openshift.adoc[Deploying Workflows on Openshift]
***** xref:serverless-logic:cloud/quarkus/kubernetes-service-discovery.adoc[Kubernetes service discovery]
//**** xref:serverless-logic:cloud/build-and-deploy-with-serverless-operator-on-kubernetes.adoc[Buiding and deploying a {product_name} application on Kubernetes using the {product_name} Serverless Operator]

*** Integrations
**** xref:serverless-logic:integrations/camel-routes-integration.adoc[Integrating with Camel Routes]
**** xref:serverless-logic:integrations/custom-functions-knative.adoc[Invoking Knative services]
**** xref:serverless-logic:integrations/expose-metrics-to-prometheus.adoc[Exposing the workflow base metrics to Prometheus]
// **** xref:serverless-logic:integrations/camel-k-integration.adoc[Integrating with Camel-K]
**** xref:serverless-logic:integrations/serverless-dashboard-with-runtime-data.adoc[Displaying workflow data in dashboards]

*** Supporting Services
**** xref:serverless-logic:supporting-services/jobs-service.adoc[Job Service]
**** Data Index
***** xref:serverless-logic:supporting-services/data-index/data-index-concepts.adoc[Data Index Core Concepts]
***** xref:serverless-logic:supporting-services/data-index/data-index-service.adoc[Data Index Standalone Service]
***** xref:serverless-logic:supporting-services/data-index/data-index-quarkus-extensions.adoc[Data Index Quarkus Extensions]
***** Operator
****** xref:serverless-logic:supporting-services/data-index/operator/data-index-usecase-singleton.adoc[Deploying Data Index and {product_name} application]
****** xref:serverless-logic:supporting-services/data-index/operator/data-index-usecase-multi.adoc[Deploying Data Index and multiple {product_name} application]
**** Job Service
***** xref:serverless-logic:supporting-services/jobs-service/core-concepts.adoc[Job Service Introduction]
***** xref:serverless-logic:supporting-services/jobs-service/quarkus-extensions.adoc[Job Service Quarkus Extensions]

*** Use Cases
**** xref:serverless-logic:use-cases/orchestration-based-saga-pattern.adoc[Saga Orchestration Example]
// **** xref:serverless-logic:use-cases/newsletter-subscription-example.adoc[Newsletter subscription example]
**** xref:serverless-logic:use-cases/timeout-showcase-example.adoc[Timeout Example]

** xref:serverless-logic:release-notes.adoc[Release notes for Serverless Logic]

* Buildpacks for Serverless Functions
** xref:functions/serverless-functions-about.adoc[About buildpacks for OpenShift Serverless Functions]
** xref:functions/serverless-functions-buildpacks.adoc[Building and deploying functions on the cluster]
** xref:functions/serverless-developing-go-functions.adoc[Developing Go functions]
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Original file line number Diff line number Diff line change
Expand Up @@ -45,25 +45,3 @@
...
</project>
----
+
// Needed only for Developer Preview 3
. *[Optional]* If you want to use Binary CloudEvents (where the event data is stored in the message body, and event attributes are stored as part of message metadata), you need to upgrade the version of the `quarkus-reactive-messaging-http` dependency:
+
.Override of `quarkus-reactive-messaging-http` in `pom.xml` file
[source,xml,subs="attributes+"]
----
<project>
...
<dependencyManagement>
<dependencies>
...
<dependency>
<groupId>io.quarkiverse.reactivemessaging.http</groupId>
<artifactId>quarkus-reactive-messaging-http</artifactId>
<version>1.0.8</version>
</dependency>
</dependencies>
</dependencyManagement>
...
</project>
----
Original file line number Diff line number Diff line change
@@ -1,5 +1,4 @@
== _**Found an issue?**_
:new_issue: https://github.com/kiegroup/kogito-docs/issues/new

If you find an issue or any misleading information, please feel free to report it link:{docs_issues_url}[here].
We really appreciate it!
Loading

0 comments on commit 0d8c6e2

Please sign in to comment.