Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Broken Link Fixes #168

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open

Broken Link Fixes #168

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
02e35c3
updates
RizaFarheen Jul 24, 2024
3bbab68
Update README.md
RizaFarheen Jul 24, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 7 additions & 9 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -196,7 +196,7 @@ http://localhost:8080/api/metadata/workflow -d @workflow.json
```

> [!note]
> To use the Conductor API, the Conductor server must be up and running (see [Running over Conductor standalone (installed locally)](#running-over-conductor-standalone-installed-locally))
> To use the Conductor API, the Conductor server must be up and running (see [Running over Conductor standalone (installed locally)](https://github.com/orkes-io/orkes-conductor-client?tab=readme-ov-file#running-workflows-on-conductor-standalone-installed-locally))

### Step 2: Write Worker

Expand Down Expand Up @@ -294,7 +294,8 @@ public class Main {
}
}
```
Add the [ApiUtil.java](examples/java/io/orkes/conductor/sdk/ApiUtil.java) file to set the environment variables.
Add the [ApiUtil.java](https://github.com/orkes-io/orkes-conductor-client/blob/main/examples/java/io/orkes/conductor/sdk/examples/ApiUtil.java) file to set the environment variables.

## Running Workflows on Conductor Standalone (Installed Locally)

### Conductor Server Settings
Expand Down Expand Up @@ -630,11 +631,11 @@ public class ConductorWorkers {
}
```

See [DynamicWorkflow](../../examples/java/io/orkes/conductor/sdk/DynamicWorkflow) for a fully functional example.
See [DynamicWorkflow](https://github.com/orkes-io/orkes-conductor-client/tree/main/examples/java/io/orkes/conductor/sdk/examples/dynamicworkflow) for a fully functional example.

#### Kitchen-Sink Workflow

For a more complex workflow example with all the supported features, see [KitchenSink.java](../../examples/java/io/orkes/conductor/sdk/KitchenSink.java)
For a more complex workflow example with all the supported features, see [KitchenSink.java](https://github.com/orkes-io/orkes-conductor-client/blob/main/examples/java/io/orkes/conductor/sdk/examples/KitchenSink.java)

### Executing Workflows

Expand Down Expand Up @@ -667,7 +668,7 @@ Workflow workflowRun = workflowExecution.get(10, TimeUnit.SECONDS);
### Managing Workflow Executions

> [!note]
> See [WorkflowOps.java](../../examples/java/io/orkes/conductor/sdk/WorkflowOps.java) for a fully working application that demonstrates working with the workflow executions and sending signals to the workflow to manage its state.
> See [WorkflowOps.java](https://github.com/orkes-io/orkes-conductor-client/blob/main/examples/java/io/orkes/conductor/sdk/examples/WorkflowOps.java) for a fully working application that demonstrates working with the workflow executions and sending signals to the workflow to manage its state.

Workflows represent the application state. With Conductor, you can query the workflow execution state anytime during its lifecycle. You can also send signals to the workflow that determines the outcome of the workflow state.

Expand Down Expand Up @@ -864,7 +865,7 @@ public class TaskDefinitionTest {
POST /api/metadata/taskdef -d @task_def.json
```

See [TaskConfigure.java](../../examples/java/io/orkes/conductor/sdk/TaskConfigure.java) for a detailed working app.
See [TaskConfigure.java](https://github.com/orkes-io/orkes-conductor-client/blob/main/examples/java/io/orkes/conductor/sdk/examples/TaskConfigure.java) for a detailed working app.

## Using Conductor in Your Application

Expand Down Expand Up @@ -943,9 +944,6 @@ For Maven-based projects, modify the `pom.xml` file in the project directory by
>[!note]
>Workflow workers are your regular Java functions and can be tested with any available testing framework.

#### Example Unit Testing Application

See [WorkflowTest.java](../examples/java/io/orkes/conductor/sdk/WorkflowTest.java) for a fully functional example of how to test a moderately complex workflow with branches.

### Workflow Deployments Using CI/CD

Expand Down
3 changes: 0 additions & 3 deletions docs/conductor_apps.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -92,9 +92,6 @@ For Maven-based projects, modify the `pom.xml` file in the project directory by
>[!note]
>Workflow workers are your regular Java functions and can be tested with any available testing framework.

### Example Unit Testing Application

See [WorkflowTest.java](../examples/java/io/orkes/conductor/sdk/WorkflowTest.java) for a fully functional example of how to test a moderately complex workflow with branches.

## Workflow Deployments Using CI/CD

Expand Down
8 changes: 4 additions & 4 deletions docs/workflow/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -110,11 +110,11 @@ public class ConductorWorkers {
}
```

See [DynamicWorkflow](../../examples/java/io/orkes/conductor/sdk/dynamicworkflow) for a fully functional example.
See [DynamicWorkflow](https://github.com/orkes-io/orkes-conductor-client/tree/main/examples/java/io/orkes/conductor/sdk/examples/dynamicworkflow) for a fully functional example.

### Kitchen-Sink Workflow

For a more complex workflow example with all the supported features, see [KitchenSink.java](../../examples/java/io/orkes/conductor/sdk/KitchenSink.java)
For a more complex workflow example with all the supported features, see [KitchenSink.java](https://github.com/orkes-io/orkes-conductor-client/blob/main/examples/java/io/orkes/conductor/sdk/examples/KitchenSink.java)

## Executing Workflows

Expand Down Expand Up @@ -147,7 +147,7 @@ Workflow workflowRun = workflowExecution.get(10, TimeUnit.SECONDS);
## Managing Workflow Executions

> [!note]
> See [WorkflowOps.java](../../examples/java/io/orkes/conductor/sdk/WorkflowOps.java) for a fully working application that demonstrates working with the workflow executions and sending signals to the workflow to manage its state.
> See [WorkflowOps.java](https://github.com/orkes-io/orkes-conductor-client/blob/main/examples/java/io/orkes/conductor/sdk/examples/WorkflowOps.java) for a fully working application that demonstrates working with the workflow executions and sending signals to the workflow to manage its state.

Workflows represent the application state. With Conductor, you can query the workflow execution state anytime during its lifecycle. You can also send signals to the workflow that determines the outcome of the workflow state.

Expand Down Expand Up @@ -344,4 +344,4 @@ public class TaskDefinitionTest {
POST /api/metadata/taskdef -d @task_def.json
```

See [TaskConfigure.java](../../examples/java/io/orkes/conductor/sdk/TaskConfigure.java) for a detailed working app.
See [TaskConfigure.java](https://github.com/orkes-io/orkes-conductor-client/blob/main/examples/java/io/orkes/conductor/sdk/examples/TaskConfigure.java) for a detailed working app.
Loading