From 3f23aced0acfe88e3093db33b9d562b1e02b861b Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Tom=C3=A1=C5=A1=20David?= Date: Mon, 25 Mar 2024 15:57:02 -0400 Subject: [PATCH] NO-ISSUE: Fix minor typos in getting started guides (#605) Fix minor typos in getting started guides --- ...-workflow-service-with-kn-cli-and-vscode.adoc | 14 +++++++------- .../getting-started/java-embedded-workflows.adoc | 16 ++++++++-------- .../getting-started/learning-environment.adoc | 2 +- .../getting-started/preparing-environment.adoc | 10 +++++----- .../getting-started/production-environment.adoc | 2 +- 5 files changed, 22 insertions(+), 22 deletions(-) diff --git a/serverlessworkflow/modules/ROOT/pages/getting-started/create-your-first-workflow-service-with-kn-cli-and-vscode.adoc b/serverlessworkflow/modules/ROOT/pages/getting-started/create-your-first-workflow-service-with-kn-cli-and-vscode.adoc index 350435eff..d5c2c75c0 100644 --- a/serverlessworkflow/modules/ROOT/pages/getting-started/create-your-first-workflow-service-with-kn-cli-and-vscode.adoc +++ b/serverlessworkflow/modules/ROOT/pages/getting-started/create-your-first-workflow-service-with-kn-cli-and-vscode.adoc @@ -3,15 +3,15 @@ This guide showcases using the Knative Workflow CLI plugin and Visual Studio code to create & run {product_name} projects. .Prerequisites -* You have setup your environment according xref:getting-started/preparing-environment.adoc#proc-minimal-local-environment-setup[minimal environment setup] guide. -* Install https://k9scli.io/[k9scli.io] for easier inspection of your application resources in cluster. This is optional, you can use any tool you are fimiliar with in this regard. +* You have set up your environment according to the xref:getting-started/preparing-environment.adoc#proc-minimal-local-environment-setup[minimal environment setup] guide. +* Install https://k9scli.io/[k9scli.io] for easier inspection of your application resources in the cluster. This is optional, you can use any tool you are familiar with in this regard. [[proc-creating-app-with-kn-cli]] == Creating a workflow project with Visual Studio Code and KN CLI Use the `create` command with kn workflow to scaffold a new SonataFlow project. -* Navigate to you development directory and create your project. +* Navigate to your development directory and create your project. [source,bash] ---- kn workflow create -n my-sonataflow-project @@ -21,7 +21,7 @@ kn workflow create -n my-sonataflow-project ---- cd ./my-sonataflow-project ---- -* Open the folder in Visual Studo Code and examine the created `workflow.sw.json` using our extension. +* Open the folder in Visual Studio Code and examine the created `workflow.sw.json` using our extension. Now you can run the project and execute the workflow. @@ -35,7 +35,7 @@ Use the `run` command with kn workflow to build and run the {product_name} proje ---- kn workflow run ---- -* The Development UI wil be accesible at `localhost:8080/q/dev` +* The Development UI will be accessible at `localhost:8080/q/dev` * You can now work on your project. Any changes will be picked up by the hot reload feature. * See xref:testing-and-troubleshooting/quarkus-dev-ui-extension/quarkus-dev-ui-workflow-instances-page.adoc[Workflow instances] guide on how to run workflows via Development UI. * Once you are done developing your project navigate to the terminal that is running the `kn workflow run` command and hit `Ctlr+C` to stop the development environment. @@ -86,7 +86,7 @@ kubectl port-forward service/hello :80 -n my-sf-application -- ==== -* To update the image run the `deploy` again, note that this may take some time. +* To update the image, run the `deploy` again, note that this may take some time. * To stop the deployment, use the `undeploy` command: [source,bash] ---- @@ -97,7 +97,7 @@ kn worklow undeploy --namespace my-sf-application [[proc-testing-application]] == Testing your workflow application -To test your workflow application you can use any capable REST client out there. All that is needeed is the URL of your deployed worklow project. +To test your workflow application you can use any capable REST client out there. All that is needed is the URL of your deployed workflow project. .Prerequisites * You have your workflow project deployed using <> and you have the URL where it is deployed handy. diff --git a/serverlessworkflow/modules/ROOT/pages/getting-started/java-embedded-workflows.adoc b/serverlessworkflow/modules/ROOT/pages/getting-started/java-embedded-workflows.adoc index 99dca3b66..c312a70e1 100644 --- a/serverlessworkflow/modules/ROOT/pages/getting-started/java-embedded-workflows.adoc +++ b/serverlessworkflow/modules/ROOT/pages/getting-started/java-embedded-workflows.adoc @@ -11,7 +11,7 @@ The workflow definition to be executed can be read from a `.json` or `.yaml` fil The first step is to set up an empty Maven project that includes link:{swf_executor_core_maven_repo_url}[Workflow executor core] dependency. -This guide also uses [slf4j dependency](https://mvnrepository.com/artifact/org.slf4j/slf4j-simple) to avoid using `System.out.println` +This guide also uses https://mvnrepository.com/artifact/org.slf4j/slf4j-simple[slf4j dependency] to avoid using `System.out.println` Let's assume you already have a workflow definition written in a JSON file in your project root directory. For example, link:{kogito_sw_examples_url}/serverless-workflow-hello-world/src/main/resources/hello.sw.json[Hello World] definition. To execute it, you must write the following main Java class (standard Java imports and package declaration are intentionally skipped for briefness) @@ -59,13 +59,13 @@ Therefore, you can modify the previous example to generate the same output when [source,java] ---- - try (StaticWorkflowApplication application = StaticWorkflowApplication.create()) { + try (StaticWorkflowApplication application = StaticWorkflowApplication.create()) { Workflow workflow = workflow("HelloWorld"). <1> - start( <2> - inject( <3> - jsonObject().put("greeting", "Hello World").put("mantra","Serverless Workflow is awesome!"))) <4> - .end() <5> - .build(); <6> + start( <2> + inject( <3> + jsonObject().put("greeting", "Hello World").put("mantra","Serverless Workflow is awesome!"))) <4> + .end() <5> + .build(); <6> logger.info("Workflow execution result is {}",application.execute(workflow, Collections.emptyMap()).getWorkflowdata()); <7> } ---- @@ -80,7 +80,7 @@ Therefore, you can modify the previous example to generate the same output when == Further reading -You can find additional and commented examples of fluent API usage (including jq expression evaluation and orchestration of rest services) link:{{kogito_sw_examples_url}/sonataflow-fluent[here] +You can find additional and commented examples of fluent API usage (including jq expression evaluation and orchestration of rest services) link:{kogito_sw_examples_url}/sonataflow-fluent[here] == Additional resources diff --git a/serverlessworkflow/modules/ROOT/pages/getting-started/learning-environment.adoc b/serverlessworkflow/modules/ROOT/pages/getting-started/learning-environment.adoc index 13c230eb2..cad3c1b92 100644 --- a/serverlessworkflow/modules/ROOT/pages/getting-started/learning-environment.adoc +++ b/serverlessworkflow/modules/ROOT/pages/getting-started/learning-environment.adoc @@ -9,7 +9,7 @@ If you are new to {product_name} we recommend a few starting points to get up to * Read the xref:core/cncf-serverless-workflow-specification-support.adoc[serverless workflow specification and what is supported]. * Try our link:{serverless_logic_web_tools_url}#/sample-catalog?category=serverless-workflow[{serverless_logic_web_tools_name} samples]. -Once familiar with the specification and samples, navigate to xref:getting-started/preparing-environment.adoc[] guide to complete the necesarry setup of your environment. After that, you should be ready to create your first {product_name} application. +Once familiar with the specification and samples, navigate to xref:getting-started/preparing-environment.adoc[] guide to complete the necessary setup of your environment. After that, you should be ready to create your first {product_name} application. == Additional resources diff --git a/serverlessworkflow/modules/ROOT/pages/getting-started/preparing-environment.adoc b/serverlessworkflow/modules/ROOT/pages/getting-started/preparing-environment.adoc index a4dd9a791..27fc7908f 100644 --- a/serverlessworkflow/modules/ROOT/pages/getting-started/preparing-environment.adoc +++ b/serverlessworkflow/modules/ROOT/pages/getting-started/preparing-environment.adoc @@ -13,10 +13,10 @@ start the development on your local machine using our guides. . Install https://docs.docker.com/engine/install/[Docker] or https://podman.io/docs/installation[Podman]. . Install https://minikube.sigs.k8s.io/docs/start/[minikube] or https://kind.sigs.k8s.io/docs/user/quick-start/#installation[kind]. . Install https://kubernetes.io/docs/tasks/tools/[Kubernetes CLI]. -. Install https://knative.dev/docs/install/quickstart-install/[Knative using quickstart]. This will also setup Knative Serving and Eventing for you and the cluster should be running. +. Install https://knative.dev/docs/install/quickstart-install/[Knative using quickstart]. This will also set up Knative Serving and Eventing for you and the cluster should be running. . xref:cloud/operator/install-serverless-operator.adoc[] . Install xref:testing-and-troubleshooting/kn-plugin-workflow-overview.adoc[Knative Workflow CLI]. -. Install https://code.visualstudio.com/[Visual Studio Code] with https://marketplace.visualstudio.com/items?itemName=kie-group.swf-vscode-extension[our extension] that simplifies development of workflows by provifing visual aids and auto-complete features. +. Install https://code.visualstudio.com/[Visual Studio Code] with https://marketplace.visualstudio.com/items?itemName=kie-group.swf-vscode-extension[our extension] that simplifies development of workflows by providing visual aids and auto-complete features. [[proc-starting-cluster-fo-local-development]] == Starting the cluster for local development @@ -69,14 +69,14 @@ If you are interested in our Java and Quarkus development path, consider complet <>. By completing these steps you are able to start the development of applications on your local machine using our xref:use-cases/advanced-developer-use-cases/index.adoc[advanced developer guides]. .Procedure -. Install https://openjdk.org/[OpenJDK] {java_min_version} and cofigure `JAVA_HOME` appropriately by adding it to the `PATH`. +. Install https://openjdk.org/[OpenJDK] {java_min_version} and configure `JAVA_HOME` appropriately by adding it to the `PATH`. . Install https://maven.apache.org/index.html[Apache Maven] {maven_min_version}. -. Install https://quarkus.io/guides/cli-tooling[Quarkus CLI] corresponding to currently supported version by {product_name}. Currently it is {quarkus_version}. +. Install https://quarkus.io/guides/cli-tooling[Quarkus CLI] corresponding to the currently supported version by {product_name}. Currently it is {quarkus_version}. [[proc-additional-options-for-local-environment]] == Additional options for local environment setup -Points listed in this section provide extra posibilties when working with our guides and are considered optional. +Points listed in this section provide extra possibilities when working with our guides and are considered optional. * Install https://www.graalvm.org/[GraalVM] {graalvm_min_version}. This will allow you to create https://www.graalvm.org/22.0/reference-manual/native-image/[native image] of your {product_name} application. * Install https://knative.dev/docs/install/yaml-install/serving/install-serving-with-yaml/[Knative Serving using YAML files] for advanced customizations or in cases where the quickstart procedure fails. diff --git a/serverlessworkflow/modules/ROOT/pages/getting-started/production-environment.adoc b/serverlessworkflow/modules/ROOT/pages/getting-started/production-environment.adoc index 56f4c3471..38edc9454 100644 --- a/serverlessworkflow/modules/ROOT/pages/getting-started/production-environment.adoc +++ b/serverlessworkflow/modules/ROOT/pages/getting-started/production-environment.adoc @@ -1,6 +1,6 @@ = Production environment -In thise guide, you can find {product_name} recommendations and best-practices for production environment. +In this guide, you can find {product_name} recommendations and best-practices for the production environment. `NOTE: Guide is not complete and under construction. For now, please explore the cloud chapters linked in the additional resources section.`