Skip to content

Commit

Permalink
574 - improve the getting-started guide based on new additions
Browse files Browse the repository at this point in the history
  • Loading branch information
domhanak committed Mar 12, 2024
1 parent 90ba79f commit acf8f8f
Show file tree
Hide file tree
Showing 4 changed files with 13 additions and 10 deletions.
1 change: 1 addition & 0 deletions serverlessworkflow/antora.yml
Original file line number Diff line number Diff line change
Expand Up @@ -131,3 +131,4 @@ asciidoc:
data_index_ref: Data Index
workflow_instance: workflow instance
workflow_instances: workflow instances
sonataflow_devmode_devui_url: /q/dev/org.kie.kogito.kogito-quarkus-serverless-workflow-devui/
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@ This guide showcases using the Knative Workflow CLI plugin and Visual Studio cod

.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.
[[proc-creating-app-with-kn-cli]]
== Creating a workflow project with Visual Studio Code and KN CLI
Expand Down Expand Up @@ -46,25 +47,25 @@ To deploy the finished project to a local cluster, proceed to the next section.

Use the `deploy` command with kn workflow to deploy the {product_name} project into your local cluster.

* Deploy to minikube
* Deploy to cluster
[source,bash]
----
kn workflow deploy
kn workflow deploy --namespace my-sonataflow-application
----
* Using k9s cli you can examine your deployment.
* In a different bash instance, create a port mapping:
[source,bash]
----
minikube service hello --namespace default --url
minikube service hello --namespace my-sonataflow-application --url
----
* Use this URL to access your workflow instances using the Developer UI
// TODO: Parametrize the devui name
** <RETURNED_URL>/q/dev/org.kie.kogito.kogito-quarkus-serverless-workflow-devui/workflowInstances
** <RETURNED_URL>{sonataflow_devmode_devui_url}{workflow_instances}
* 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]
----
kn worklow undeploy
kn worklow undeploy --namespace my-sonataflow-application
----
* You can validate your pod is terminating using k9s cli.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,14 +2,15 @@

If you are new to {product_name} we recommend a few starting points to get up to speed with the technology and what it has to offer.

* Read the link:xref:core/cncf-serverless-workflow-specification-support.adoc[serverless workflow specification and what is supported]
* Read the link: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 will 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 necesarry setup of your environment. After that, you should be ready to create your first {product_name} application.

== Additional resources

* xref:getting-started/preparing-environment.adoc[]
* xref:getting-started/production-environment.adoc[]


include::../../pages/_common-content/report-issue.adoc[]
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ If you are new, start with the minimal one.
== Minimal local environment setup

Recomennded steps to setup your local development environment. By completing these steps you are able to
start the development of applications on your local machine using our guides.
start the development on your local machine using our guides.

.Procedure
. Install https://docs.docker.com/engine/install/[Docker] or https://podman.io/docs/installation[Podman].
Expand All @@ -22,7 +22,7 @@ start the development of applications on your local machine using our guides.
== Advanced local environment setup

If you are interested in our Java and Quarkus development path, consider completing this procedure in addition to the
<<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-case/advanced-developer-use-cases/index.adoc[advanced developer guides].
<<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`.
Expand Down

0 comments on commit acf8f8f

Please sign in to comment.