Skip to content

Commit

Permalink
Merge pull request #113 from domhanak/SRVLOGIC-261
Browse files Browse the repository at this point in the history
SRVLOGIC-261: Update Serverless Logic docs to latest
  • Loading branch information
ricardozanini authored Jul 31, 2024
2 parents 0b88ffd + 6d582e9 commit 87a954d
Show file tree
Hide file tree
Showing 89 changed files with 3,646 additions and 846 deletions.
206 changes: 145 additions & 61 deletions antora.yml

Large diffs are not rendered by default.

36 changes: 21 additions & 15 deletions modules/ROOT/nav.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -21,32 +21,32 @@
**** xref:serverless-logic:getting-started/preparing-environment.adoc[]
**** xref:serverless-logic:getting-started/production-environment.adoc[]
*** 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/getting-familiar-with-our-tooling.adoc[Getting familiar with tooling]
**** xref:serverless-logic:getting-started/create-your-first-workflow-service-with-kn-cli-and-vscode.adoc[]
**** xref:serverless-logic:getting-started/getting-familiar-with-our-tooling.adoc[]
*** Core
**** xref:serverless-logic:core/cncf-serverless-workflow-specification-support.adoc[CNCF Serverless Workflow specification]
**** xref:serverless-logic:core/cncf-serverless-workflow-specification-support.adoc[]
**** 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-jq-expressions.adoc[]
**** xref:serverless-logic:core/understanding-workflow-error-handling.adoc[Error handling]
**** xref:serverless-logic:core/configuration-properties.adoc[Configuration properties]
**** 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/configuration-properties.adoc[Configuration]
**** xref:serverless-logic:core/defining-an-input-schema-for-workflows.adoc[Input Schema]
**** xref:serverless-logic:core/custom-functions-support.adoc[Custom functions]
**** 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[Editor]
***** xref:serverless-logic:tooling/serverless-workflow-editor/swf-editor-vscode-extension.adoc[VS Code extension]
***** xref:serverless-logic:tooling/serverless-workflow-editor/swf-editor-chrome-extension.adoc[Chrome extension for GitHub]
**** 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]
***** xref:serverless-logic:tooling/serverless-logic-web-tools/serverless-logic-web-tools-github-integration.adoc[Integration with GitHub]
***** xref:serverless-logic:tooling/serverless-logic-web-tools/serverless-logic-web-tools-openshift-integration.adoc[Integration with OpenShift]
***** xref:serverless-logic:tooling/serverless-logic-web-tools/serverless-logic-web-tools-redhat-application-services-integration.adoc[Red Hat OpenShift Application and Data Services integration]
***** xref:serverless-logic:tooling/serverless-logic-web-tools/serverless-logic-web-tools-deploy-projects.adoc[Deploying projects]
***** xref:serverless-logic:tooling/serverless-logic-web-tools/serverless-logic-web-tools-deploy-projects.adoc[Deployment]
*** 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/working-with-openapi-callbacks.adoc[OpenAPI callback in {product_name}]
***** xref:serverless-logic:service-orchestration/working-with-openapi-callbacks.adoc[OpenAPI callbacks in {product_name}]
**** xref:serverless-logic:service-orchestration/troubleshooting.adoc[Troubleshooting]
*** Event Orchestration
**** xref:serverless-logic:eventing/orchestration-of-asyncapi-based-services.adoc[Orchestrating AsyncAPI Services]
Expand All @@ -65,31 +65,37 @@
*** Persistence
**** xref:serverless-logic:persistence/core-concepts.adoc[Core concepts]
*** xref:serverless-logic:cloud/index.adoc[Cloud]
**** xref:serverless-logic:cloud/custom-ingress-authz.adoc[Securing Workflows]
**** Operator
***** xref:serverless-logic:cloud/operator/install-serverless-operator.adoc[Installation]
***** xref:serverless-logic:cloud/operator/global-configuration.adoc[Admin Configuration]
***** 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/configuring-workflows.adoc[Workflow Configuration]
***** xref:serverless-logic:cloud/operator/build-and-deploy-workflows.adoc[Building and Deploying Workflow Images]
***** xref:serverless-logic:cloud/operator/supporting-services.adoc[Deploy Supporting Services]
***** xref:serverless-logic:cloud/operator/workflow-status-conditions.adoc[Custom Resource Status]
***** xref:serverless-logic:cloud/operator/building-custom-images.adoc[Building Custom Images]
***** xref:serverless-logic:cloud/operator/customize-podspec.adoc[Custom Workflow PodSpec]
***** xref:serverless-logic:cloud/operator/service-discovery.adoc[Service Discovery]
***** xref:serverless-logic:cloud/operator/using-persistence.adoc[Using persistence]
***** xref:serverless-logic:cloud/operator/configuring-knative-eventing-resources.adoc[Knative Eventing]
***** xref:cloud/operator/add-custom-ca-to-a-workflow-pod.adoc[Add Custom CA to Workflow Pod]
***** xref:serverless-logic:cloud/operator/known-issues.adoc[Roadmap and Known Issues]
*** Integrations
**** xref:serverless-logic:integrations/core-concepts.adoc[]
*** Supporting Services
**** Jobs Service
***** xref:serverless-logic:job-services/core-concepts.adoc[Core Concepts]
**** Data Index
***** xref:serverless-logic:data-index/data-index-core-concepts.adoc[Core Concepts]
***** xref:serverless-logic:data-index/data-index-core-concepts.adoc[Core Concepts]***
***** xref:serverless-logic:data-index/data-index-service.adoc[Data Index Standalone Service]
*** Use Cases
**** xref:serverless-logic:use-cases/advanced-developer-use-cases/index.adoc[Development of {product_name} applications using Quarkus and Java]
***** Getting Started
****** xref:serverless-logic:use-cases/advanced-developer-use-cases/getting-started/create-your-first-workflow-service.adoc[Creating your first workflow service]
****** xref:serverless-logic:use-cases/advanced-developer-use-cases/getting-started/create-your-first-workflow-service.adoc[]
****** xref:serverless-logic:use-cases/advanced-developer-use-cases/getting-started/create-your-first-workflow-project.adoc[]
****** xref:serverless-logic:use-cases/advanced-developer-use-cases/getting-started/build-workflow-image-with-quarkus-cli.adoc[]
****** xref:serverless-logic:use-cases/advanced-developer-use-cases/getting-started/working-with-serverless-workflow-quarkus-examples.adoc[]
****** xref:serverless-logic:use-cases/advanced-developer-use-cases/getting-started/test-serverless-workflow-quarkus-examples.adoc[]
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@
<dependency>
<groupId>io.quarkus.platform</groupId>
<artifactId>quarkus-kogito-bom</artifactId>
<version>{quarkus_platform_version}/version>
<version>{quarkus_platform_version}</version>
<type>pom</type>
<scope>import</scope>
</dependency>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -19,14 +19,14 @@ To use the Red Hat Build of Quarkus (RHBQ) libraries, you need to configure your
----
<!-- Configure the {product_name} Maven repository -->
<profile>
<id>red-hat-earlyaccess-maven-repository</id>
<id>red-hat-ga-maven-repository</id>
<activation>
<activeByDefault>true</activeByDefault>
</activation>
<repositories>
<repository>
<id>red-hat-earlyaccess-maven-repository</id>
<url>https://maven.repository.redhat.com/earlyaccess/all/</url>
<id>red-hat-ga-maven-repository</id>
<url>https://maven.repository.redhat.com/ga</url>
<releases>
<enabled>true</enabled>
</releases>
Expand All @@ -37,8 +37,8 @@ To use the Red Hat Build of Quarkus (RHBQ) libraries, you need to configure your
</repositories>
<pluginRepositories>
<pluginRepository>
<id>red-hat-earlyaccess-maven-repository</id>
<url>https://maven.repository.redhat.com/earlyaccess/all/</url>
<id>red-hat-ga-maven-repository</id>
<url>https://maven.repository.redhat.com/ga</url>
<releases>
<enabled>true</enabled>
</releases>
Expand Down
8 changes: 0 additions & 8 deletions modules/serverless-logic/pages/about.adoc
Original file line number Diff line number Diff line change
@@ -1,13 +1,5 @@
= About OpenShift Serverless Logic

[IMPORTANT]
====
{serverlessproductname} Logic is a Technology Preview feature only. Technology Preview features are not supported with Red Hat production service level agreements (SLAs) and might not be functionally complete. Red Hat does not recommend using them in production. These features provide early access to upcoming product features, enabling customers to test functionality and provide feedback during the development process.
For more information about the support scope of Red Hat Technology Preview
features, see https://access.redhat.com/support/offerings/techpreview/.
====

{serverlessproductname} Logic enables developers or architects to define declarative workflow models that orchestrate event-driven, serverless applications. Serverless Logic implements the link:https://github.com/serverlessworkflow/specification[CNCF Serverless Workflow specification], allowing developers and architects to define logical steps of execution declaratively (no code) for cloud-native services. The specification is hosted by the link:https://www.cncf.io/[Cloud Native Computing Foundation (CNCF)] and is currently a link:https://www.cncf.io/projects/serverless-workflow/[CNCF Sandbox project].

{serverlessproductname} Logic is also designed to write workflows in formats (JSON or YAML) that might be better suited for developing and deploying serverless applications in cloud or container environments.
Expand Down
Loading

0 comments on commit 87a954d

Please sign in to comment.