Skip to content

Commit

Permalink
updated readme files to be up to date and more useful
Browse files Browse the repository at this point in the history
  • Loading branch information
mswiderski committed Feb 28, 2023
1 parent cb1f7ec commit bce0652
Show file tree
Hide file tree
Showing 11 changed files with 16 additions and 14 deletions.
2 changes: 1 addition & 1 deletion document-processor/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@

this is an example showing batch processing use cases backed by workflow. It uses Automatiko project to build self described service.

See complete description of this example [here](https://automatikio.com/component-main/0.0.0/examples/batch.html)
See complete description of this example [here](https://docs.automatiko.io/main/0.0.0/examples/batch.html)

## Run it

Expand Down
8 changes: 5 additions & 3 deletions event-streams-orders/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,13 +4,15 @@

this is an example showing event stream use cases backed by workflow. It uses Automatiko project to build self described service that makes use of Apache Kafka as event source.

See complete description of this example [here](https://automatikio.com/component-main/0.0.0/examples/orders.html)
See complete description of this example [here](https://docs.automatiko.io/main/0.0.0/examples/orders.html)

## Run it

The only thing that is needed is Apache Kafka running that will be accessible. It needs to be given as part of run command via environment variable `KAFKA_SERVERS`
The only thing that is needed is Apache Kafka running that will be accessible.
Redpanda can be used as Kafka broker, see installation instructions [here](https://docs.redpanda.com/docs/get-started/quick-start/?quickstart=docker#deploy-redpanda).
Kafka broker needs to be given as part of run command via environment variable `KAFKA_BOOTSTRAP_SERVERS`

`docker run -e KAFKA_SERVERS=KAFKA_HOST:9092 -p 8080:8080 automatik/event-streams-orders`
`docker run -e KAFKA_BOOTSTRAP_SERVERS=KAFKA_HOST:9092 -p 8080:8080 automatiko/event-streams-orders`

once this is done you can see the fully described service at:

Expand Down
4 changes: 2 additions & 2 deletions event-streams-sensors/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,13 +4,13 @@

this is an example showing event stream use cases backed by workflow for IoT. It uses Automatiko project to build self described service that makes use of MQTT broker as event source.

See complete description of this example [here](https://automatikio.com/component-main/0.0.0/examples/leaks.html)
See complete description of this example [here](https://docs.automatiko.io/main/0.0.0/examples/leaks.html)

## Run it

The only thing that is needed is MQTT broker running that will be accessible. It needs to be given as part of run command via environment variable `MQTT_SERVER` and `MQTT_PORT`

`docker run -e MQTT_SERVER=MQTT_HOST -e MQTT_PORT=1883 -p 8080:8080 automatik/event-streams-sensors`
`docker run -e MQTT_SERVER=MQTT_HOST -e MQTT_PORT=1883 -p 8080:8080 automatiko/event-streams-sensors`

once this is done you can see the fully described service at:

Expand Down
2 changes: 1 addition & 1 deletion mysql-operator/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@

this is an example showing Kubernetes Operator use cases backed by workflow. It uses Automatiko project to build self described service.

See complete description of this example [here](https://automatikio.com/component-main/0.3.0/examples/operator.html)
See complete description of this example [here](https://docs.automatiko.io/main0.3.0/examples/operator.html)

## Run it

Expand Down
2 changes: 1 addition & 1 deletion user-registration-function/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ this is an example showing workflow as a function use case. It implements common
that performs various checks and registers users in the Swagger PetStore service.


See complete description of this example [here](https://automatikio.com/component-main/0.0.0/examples/userregistration-function.html)
See complete description of this example [here](https://docs.automatiko.io/main/0.0.0/examples/userregistration-function.html)

## Run it

Expand Down
2 changes: 1 addition & 1 deletion user-registration-gcp-cloudrun/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ This examples illustrates how a workflow is sliced into functions that are compo
the actual logic steered by the workflow definition. Yet each function can be invoked at anytime making the workflow to
act as a definition that can start at any place and continue according to defined flow of activities eka functions.

See complete description of this example [here](https://automatikio.com/component-main/0.0.0/examples/userregistration.html)
See complete description of this example [here](https://docs.automatiko.io/main/0.0.0/examples/userregistration.html)

## Run it

Expand Down
2 changes: 1 addition & 1 deletion user-registration-sw/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ This examples illustrates how a workflow is sliced into functions that are compo
the actual logic steered by the workflow definition. Yet each function can be invoked at anytime making the workflow to
act as a definition that can start at any place and continue according to defined flow of activities eka functions.

See complete description of this example [here](https://automatikio.com/component-main/0.0.0/examples/userregistration.html)
See complete description of this example [here](https://docs.automatiko.io/main/0.0.0/examples/userregistration.html)

## Run it

Expand Down
2 changes: 1 addition & 1 deletion user-registration/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ This examples illustrates how a workflow is sliced into functions that are compo
the actual logic steered by the workflow definition. Yet each function can be invoked at anytime making the workflow to
act as a definition that can start at any place and continue according to defined flow of activities eka functions.

See complete description of this example [here](https://automatikio.com/component-main/0.0.0/examples/userregistration.html)
See complete description of this example [here](https://docs.automatiko.io/main/0.0.0/examples/userregistration.html)

## Run it

Expand Down
2 changes: 1 addition & 1 deletion vacation-requests/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ emplyee requesting vacations. It takes advantage of workflow features such as
- tracking - all vacation requests submitted are tracked
- user interactions - tasks are assigned to individuals to take actions when needed

See complete description of this example [here](https://automatikio.com/component-main/0.0.0/examples/vacations.html)
See complete description of this example [here](https://docs.automatiko.io/main/0.0.0/examples/vacations.html)

## Run it

Expand Down
2 changes: 1 addition & 1 deletion weather-conditions/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
this is an example showing service orchestration use case. It implements common scenario for workflows -
that multiple services needs to be invoked and depending on the results another set of services might be called again.

See complete description of this example [here](https://automatikio.com/component-main/0.0.0/examples/weather.html)
See complete description of this example [here](https://docs.automatiko.io/main/0.0.0/examples/weather.html)

## Run it

Expand Down
2 changes: 1 addition & 1 deletion workflows-java-dsl/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@

This is a set of sample workflows illustrating use of Workflow Java DSL of Automatiko.

Take a look at the getting started with Workflow Java DSL [here](https://automatikio.com/component-main/0.0.0/getting-started-code.html)
Take a look at the getting started with Workflow Java DSL [here](https://docs.automatiko.io/main/0.0.0/getting-started-code.html)

Samples covered:

Expand Down

0 comments on commit bce0652

Please sign in to comment.