Skip to content

Commit

Permalink
NO-ISSUE: Fix minor typos in getting started guides (#605)
Browse files Browse the repository at this point in the history
Fix minor typos in getting started guides
  • Loading branch information
tomasdavidorg committed Mar 25, 2024
1 parent 6cebb78 commit 3f23ace
Show file tree
Hide file tree
Showing 5 changed files with 22 additions and 22 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -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.

Expand All @@ -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.
Expand Down Expand Up @@ -86,7 +86,7 @@ kubectl port-forward service/hello <RANDOM_PORT>: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]
----
Expand All @@ -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 <<proc-deploying-app-with-kn-cli>> and you have the URL where it is deployed handy.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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)

Expand Down Expand Up @@ -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>
}
----
Expand All @@ -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

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -69,14 +69,14 @@ If you are interested in our Java and Quarkus development path, consider complet
<<proc-minimal-local-environment-setup>>. 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.
Expand Down
Original file line number Diff line number Diff line change
@@ -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.`

Expand Down

0 comments on commit 3f23ace

Please sign in to comment.