[KOGITO-8818] Rearrange guides to add operator and quarkus cloud (#313)

* [KOGITO-8818] Rearrange guides to add operator and quarkus cloud Signed-off-by: Ricardo Zanini <[email protected]> * Refactoring navigation, installation and dev guide Signed-off-by: Ricardo Zanini <[email protected]> * Add dev, config, workflow status guides Signed-off-by: Ricardo Zanini <[email protected]> * Wrapping up first version before review Signed-off-by: Ricardo Zanini <[email protected]> * Fix typos and grammar Signed-off-by: Ricardo Zanini <[email protected]> * Apply krisv initial suggestions Co-authored-by: Kris Verlaenen <[email protected]> * Adding Swagger UI to verify the workflow, reviewing prod, add cards Signed-off-by: Ricardo Zanini <[email protected]> * Fixing typos Co-authored-by: Marián Macik <[email protected]> Co-authored-by: Filippe Spolti <[email protected]> * Incorporating Marian and spolti reviews Signed-off-by: Ricardo Zanini <[email protected]> * Feedback fixes * Feedback review * Apply suggestions from code review Co-authored-by: Tristan Radisson <[email protected]> * Apply feedback changes --------- Signed-off-by: Ricardo Zanini <[email protected]> Co-authored-by: Kris Verlaenen <[email protected]> Co-authored-by: Marián Macik <[email protected]> Co-authored-by: Filippe Spolti <[email protected]> Co-authored-by: Cristiano Nicolai <[email protected]> Co-authored-by: Tristan Radisson <[email protected]>
apache · Apr 19, 2023 · fe4ede4 · fe4ede4
1 parent 75fbcc2
commit fe4ede4
Show file tree

Hide file tree

Showing 59 changed files with 1,203 additions and 451 deletions.
diff --git a/serverlessworkflow/antora.yml b/serverlessworkflow/antora.yml
@@ -10,12 +10,12 @@ asciidoc:
   attributes:
     # for product names
     #in Downstream product_name: OpenShift Serverless Logic
-    product_name: Kogito
-    #in Downstream context: OpenShift Serverless Logic
-    context: Serverless Workflow
+    product_name: Kogito Serverless Workflow
     # upstream: empty
     #kogito_version_redhat: 1.24.0.Final-redhat-00001
     kogito_version_redhat: ""
+    # same for upstream and downstream while the operator is community only
+    operator_name: Kogito Serverless Workflow Operator
     # upstream: io.quarkus.platform
     #quarkus_platform: com.redhat.quarkus.platform
     quarkus_platform: io.quarkus.platform
@@ -52,6 +52,7 @@ asciidoc:
     quarkus_openapi_gen_url: https://github.com/quarkiverse/quarkus-openapi-generator
     kie_tools_releases_page_url: https://github.com/kiegroup/kie-tools/releases
     quarkus_guides_base_url: https://quarkus.io/guides
+    quarkus_url: https://quarkus.io/
     smallrye_messaging_url: https://smallrye.io/smallrye-reactive-messaging/smallrye-reactive-messaging/3.3
     quarkus_config_url: https://quarkus.io/guides/config
     quarkus_swagger_url: https://quarkus.io/guides/openapi-swaggerui
@@ -82,5 +83,6 @@ asciidoc:
     # must align this version
     camel_extensions_url: https://camel.apache.org/camel-quarkus/2.14.x/reference/extensions
     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/
+    docs_issues_url: https://github.com/kiegroup/kogito-docs/issues/new
diff --git a/serverlessworkflow/modules/ROOT/assets/images/cloud/swagger-ui-operator.png b/serverlessworkflow/modules/ROOT/assets/images/cloud/swagger-ui-operator.png
diff --git a/serverlessworkflow/modules/ROOT/nav.adoc b/serverlessworkflow/modules/ROOT/nav.adoc
@@ -1,18 +1,18 @@
 // * xref:index.adoc[Home]
-* xref:release_notes.adoc[Release notes for {context}]
+* xref:release_notes.adoc[Release notes]
 * Getting Started
 ** xref:getting-started/create-your-first-workflow-service.adoc[Creating your first workflow service]
 ** xref:getting-started/cncf-serverless-workflow-specification-support.adoc[CNCF Serverless Workflow specification]
-** xref:getting-started/getting-familiar-with-our-tooling.adoc[Getting familiar with {context} tooling]
+** xref:getting-started/getting-familiar-with-our-tooling.adoc[Getting familiar with tooling]
 * Core
-** xref:core/understanding-jq-expressions.adoc[jq expressions in {context}]
-** xref:core/understanding-workflow-error-handling.adoc[Error handling in {context}]
-** xref:core/working-with-parallelism.adoc[Parallelism in {context}]
-** xref:core/configuration-properties.adoc[Configuration properties in {context}]
+** xref:core/understanding-jq-expressions.adoc[jq expressions]
+** xref:core/understanding-workflow-error-handling.adoc[Error handling]
+** xref:core/working-with-parallelism.adoc[Parallelism]
+** xref:core/configuration-properties.adoc[Configuration properties]
 //** xref:core/accessing-workflow-metainformation-in-runtime.adoc[Accessing workflow metainformation in runtime]
-** xref:core/defining-an-input-schema-for-workflows.adoc[Input schema definition for {context}]
-** xref:core/custom-functions-support.adoc[Custom functions for your {context} service]
-** xref:core/timeouts-support.adoc[Timeouts in {context}]
+** xref:core/defining-an-input-schema-for-workflows.adoc[Input schema definition]
+** xref:core/custom-functions-support.adoc[Custom functions for your workflow service]
+** xref:core/timeouts-support.adoc[Timeouts Support]
 * Tooling
 ** xref:tooling/serverless-workflow-editor/swf-editor-overview.adoc[Serverless Workflow editor]
 ** xref:tooling/serverless-workflow-editor/swf-editor-vscode-extension.adoc[VS Code extension for Serverless Workflow editor]
@@ -21,57 +21,64 @@
 *** xref:tooling/quarkus-dev-ui-extension/quarkus-dev-ui-workflow-instances-page.adoc[Workflow Instances in Kogito Serverless Workflow Tools extension]
 *** xref:tooling/quarkus-dev-ui-extension/quarkus-dev-ui-workflow-definition-page.adoc[Workflow Definitions in Kogito Serverless Workflow Tools extension]
 *** xref:tooling/quarkus-dev-ui-extension/quarkus-dev-ui-custom-dashboard-page.adoc[Dashboards in Kogito Serverless Workflow Tools extension]
-** xref:tooling/kn-plugin-workflow-overview.adoc[{context} plug-in for Knative CLI]
+** xref:tooling/kn-plugin-workflow-overview.adoc[{product_name} plug-in for Knative CLI]
 ** xref:tooling/serverless-logic-web-tools/serverless-logic-web-tools-overview.adoc[{serverless_logic_web_tools_name}]
-*** xref:tooling/serverless-logic-web-tools/serverless-logic-web-tools-github-integration.adoc[Integrating your {context} project in GitHub using {serverless_logic_web_tools_name}]
-*** xref:tooling/serverless-logic-web-tools/serverless-logic-web-tools-openshift-integration.adoc[Integrating your {context} project with OpenShift using {serverless_logic_web_tools_name}]
+*** xref:tooling/serverless-logic-web-tools/serverless-logic-web-tools-github-integration.adoc[Integrating your workflow project in GitHub using {serverless_logic_web_tools_name}]
+*** xref:tooling/serverless-logic-web-tools/serverless-logic-web-tools-openshift-integration.adoc[Integrating your workflow project with OpenShift using {serverless_logic_web_tools_name}]
 *** xref:tooling/serverless-logic-web-tools/serverless-logic-web-tools-redhat-application-services-integration.adoc[Integrating with Red Hat OpenShift Application and Data Services]
-*** xref:tooling/serverless-logic-web-tools/serverless-logic-web-tools-deploy-projects.adoc[Deploying your {context} projects using {serverless_logic_web_tools_name}]
-*** xref:tooling/serverless-logic-web-tools/serverless-logic-web-tools-enable-kogito-swf-visualization.adoc[Enabling Kogito Serverless Workflow Visualization in {serverless_logic_web_tools_name}]
+*** xref:tooling/serverless-logic-web-tools/serverless-logic-web-tools-deploy-projects.adoc[Deploying your workflow projects using {serverless_logic_web_tools_name}]
+*** xref:tooling/serverless-logic-web-tools/serverless-logic-web-tools-enable-kogito-swf-visualization.adoc[Enabling Visualization in {serverless_logic_web_tools_name}]
 * Service Orchestration
 ** xref:service-orchestration/orchestration-of-openapi-based-services.adoc[Orchestrating the OpenAPI services]
 ** xref:service-orchestration/configuring-openapi-services-endpoints.adoc[Configuring the OpenAPI services endpoints]
 ** xref:service-orchestration/orchestration-of-asyncapi-based-services.adoc[Orchestrating the AsyncAPI services]
 ** xref:service-orchestration/orchestration-of-grpc-services.adoc[Orchestration of gRPC based services]
 * Eventing
-** xref:eventing/handling-events-on-workflows.adoc[Event state in {context}]
+** xref:eventing/handling-events-on-workflows.adoc[Event State]
 ** xref:eventing/consume-producing-events-with-kafka.adoc[Consuming and producing events using Apache Kafka]
 ** xref:eventing/consume-produce-events-with-knative-eventing.adoc[Consuming and producing events on Knative Eventing]
-** xref:eventing/event-correlation-with-workflows.adoc[Event correlation in {context}]
-** xref:eventing/working-with-callbacks.adoc[Callback state in {context}]
-** xref:eventing/working-with-openapi-callbacks.adoc[OpenAPI Callback in {context}]
+** xref:eventing/event-correlation-with-workflows.adoc[Event Correlation]
+** xref:eventing/working-with-callbacks.adoc[Callback State]
+** xref:eventing/working-with-openapi-callbacks.adoc[OpenAPI Callback]
 * Security
-** xref:security/authention-support-for-openapi-services.adoc[Authentication for OpenAPI services in {context}]
-** xref:security/orchestrating-third-party-services-with-oauth2.adoc[Orchestration of third-party services using OAuth 2.0 authentication in {context}]
+** xref:security/authention-support-for-openapi-services.adoc[Authentication for OpenAPI services]
+** xref:security/orchestrating-third-party-services-with-oauth2.adoc[Orchestration of third-party services using OAuth 2.0 authentication]
 * Testing and Troubleshooting
 ** xref:testing-and-troubleshooting/mocking-http-cloudevents-with-wiremock.adoc[Mocking HTTP CloudEvents sink using WireMock]
 ** xref:testing-and-troubleshooting/mocking-openapi-services-with-wiremock.adoc[Mocking OpenAPI services using WireMock]
-** xref:testing-and-troubleshooting/basic-integration-tests-with-restassured.adoc[Testing your workflow application using REST Assured]
+** xref:testing-and-troubleshooting/basic-integration-tests-with-restassured.adoc[Testing using REST Assured]
 //** xref:testing-and-troubleshooting/debugging-workflow-execution-runtime.adoc[Debugging the workflow execution in runtime]
-** xref:testing-and-troubleshooting/integration-tests-with-postgresql.adoc[{context} integration test using PostgreSQL]
+** xref:testing-and-troubleshooting/integration-tests-with-postgresql.adoc[Integration tests using PostgreSQL]
 //** xref:testing-and-troubleshooting/development-tools-for-troubleshooting.adoc[Development tools for troubleshooting]
 * Persistence
 ** xref:persistence/persistence-with-postgresql.adoc[Running a workflow service using PostgreSQL]
 ** xref:persistence/postgresql-flyway-migration.adoc[Migrate your PostgreSQL database]
 //** xref:persistence/workflow-database-for-db-admins.adoc[Workflows database for DB admins]
 // ** xref:persistence/data-consistency.adoc[Data consistency]
-* Cloud
-** xref:cloud/build-workflow-image-with-quarkus-cli.adoc[Building workflow images using Quarkus CLI]
-// ** xref:cloud/build-workflow-images-with-tekton.adoc[Building Workflow Images with Tekton Pipelines]
-** xref:cloud/deploying-on-minikube.adoc[Deploying your {context} application on Minikube]
-** xref:cloud/deploying-on-kubernetes.adoc[Deploying your {context} application on Kubernetes]
-// ** xref:cloud/versioning-workflows-in-knative.adoc[Versioning workflows in Knative]
-** xref:cloud/kubernetes-service-discovery.adoc[Kubernetes service discovery in {context}]
-** xref:cloud/build-and-deploy-with-serverless-operator-on-kubernetes.adoc[Buiding and deploying a  {context} application on Kubernetes using the {product_name} Serverless Operator]
+* xref:cloud/index.adoc[Cloud]
+** Operator
+*** xref:cloud/operator/install-serverless-operator.adoc[Installation]
+*** xref:cloud/operator/developing-workflows.adoc[Developing Workflows]
+*** xref:cloud/operator/configuring-workflows.adoc[Configuring Workflows]
+*** xref:cloud/operator/workflow-status-conditions.adoc[Workflows Status]
+*** xref:cloud/operator/build-and-deploy-workflows.adoc[Building and Deploying Workflows]
+*** xref:cloud/operator/known-issues.adoc[Known Issues]
+** Quarkus
+*** xref:cloud/quarkus/build-workflow-image-with-quarkus-cli.adoc[Building workflow images using Quarkus CLI]
+// *** xref:cloud/build-workflow-images-with-tekton.adoc[Building Workflow Images with Tekton Pipelines]
+*** xref:cloud/quarkus/deploying-on-minikube.adoc[Deploying Workflows on Minikube]
+*** xref:cloud/quarkus/deploying-on-kubernetes.adoc[Deploying Workflows on Kubernetes]
+// *** xref:cloud/versioning-workflows-in-knative.adoc[Versioning workflows in Knative]
+*** xref:cloud/quarkus/kubernetes-service-discovery.adoc[Kubernetes service discovery]
 * Integrations
 ** xref:integrations/camel-routes-integration.adoc[Integrating with Camel Routes]
-** xref:integrations/custom-functions-knative.adoc[Invoking Knative services from {context}]
+** xref:integrations/custom-functions-knative.adoc[Invoking Knative services]
 ** xref:integrations/expose-metrics-to-prometheus.adoc[Exposing workflow base metrics to Prometheus]
 // ** xref:integrations/camel-k-integration.adoc[Integrating with Camel-K]
  ** xref:integrations/serverless-dashboard-with-runtime-data.adoc[Displaying workflow data in dashboards]
 * Supporting Services
 ** xref:supporting-services/jobs-service.adoc[Job Service]
 * Use Cases
-** xref:use-cases/orchestration-based-saga-pattern.adoc[Saga orchestration example in {context}]
+** xref:use-cases/orchestration-based-saga-pattern.adoc[Saga Orchestration Example]
 // ** xref:use-cases/newsletter-subscription-example.adoc[Newsletter subscription example]
-** xref:use-cases/timeout-showcase-example.adoc[Timeout example in {context}]
+** xref:use-cases/timeout-showcase-example.adoc[Timeout Example]
diff --git a/...w/modules/ROOT/pages/_common-content/downstream-project-setup-instructions.adoc b/...w/modules/ROOT/pages/_common-content/downstream-project-setup-instructions.adoc
@@ -50,4 +50,4 @@ To use the Red Hat Build of Quarkus (RHBQ) libraries, you need to configure your
 </profile>
 ----
 +
-. Follow the instructions in the link:{redhat_registry_auth_url}[Red Hat Container Registry Authentication] article to log in to the registry and use the {context} images locally.
+. Follow the instructions in the link:{redhat_registry_auth_url}[Red Hat Container Registry Authentication] article to log in to the registry and use the {product_name} images locally.
diff --git a/serverlessworkflow/modules/ROOT/pages/_common-content/report-issue.adoc b/serverlessworkflow/modules/ROOT/pages/_common-content/report-issue.adoc
@@ -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 {new_issue}[here].
+If you find an issue or any misleading information, please feel free to report it link:{docs_issues_url}[here].
 We really appreciate it!