Skip to content

Commit

Permalink
Merge pull request #772 from RizaFarheen/main
Browse files Browse the repository at this point in the history
Update sidebars.js
  • Loading branch information
RizaFarheen authored Oct 21, 2024
2 parents d0589eb + e0171e6 commit 1b2853b
Show file tree
Hide file tree
Showing 7 changed files with 29 additions and 32 deletions.
10 changes: 5 additions & 5 deletions docs/getting-started/adding-custom-code-worker.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,8 @@ import CodeBlock from '@theme/CodeBlock';

# Step 3: Adding Custom Code Worker

[Continuing from Step 2](/getting-started/running-workflows-from-code)

Continuing the use case from the previous step, we now have a requirement to add a fraud check for all deposit transactions >= $10,000.

<Tabs>
Expand Down Expand Up @@ -198,8 +200,6 @@ We can run similar workflows in production, too, workers could live in **any app
Conductor. All of this without worrying about creating inbound connections or exposing unwanted API endpoints.
:::

## Related Topics

- Passing [inputs into workflow for tasks](/content/developer-guides/passing-inputs-to-task-in-conductor)
- Passing the [output of one task to the input of another](/content/developer-guides/passing-inputs-to-task-in-conductor)
- [Client SDKs](/content/category/sdks)
* **[Step 4: Running an Inline Function](/getting-started/running-an-inline-function)**
* **[Step 5: Adding Wait Conditions](/getting-started/adding-wait-conditions)**
* **[Step 6: Executing Tasks in Parallel](/getting-started/executing-tasks-in-parallel)**
7 changes: 3 additions & 4 deletions docs/getting-started/adding-wait-conditions.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,8 @@ import Install from '@site/src/components/install.mdx';

# Step 5: Adding Wait Conditions

[Continuing from Step 4](/getting-started/running-an-inline-function)

The wait task in Conductor is used if the workflow is to be paused for external signals. The signals can be manual human interventions or an event from external sources such as Kafka, SQS, etc. Let’s learn how to pause your workflows using wait tasks.

#### Use case: What if we want to send the SMS only after a fixed time?
Expand Down Expand Up @@ -45,7 +47,4 @@ Since you have configured the wait task to wait for 10 seconds, once the workflo
Try to configure a wait for longer - perhaps 2 days, set a reminder to check back after two days to see if that task is executed. Magic!
:::

## Related Topics

* [API Reference for Wait](/content/reference-docs/operators/wait)
* [Scheduling workflows](/content/developer-guides/scheduling-workflows)
* **[Step 6: Executing Tasks in Parallel](/getting-started/executing-tasks-in-parallel)**
9 changes: 3 additions & 6 deletions docs/getting-started/executing-tasks-in-parallel.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,8 @@ import CodeBlock from '@theme/CodeBlock';

# Step 6: Executing Tasks in Parallel

[Continuing from Step 5](/getting-started/adding-wait-conditions)

Another exciting feature of Conductor is executing tasks in parallel. A common scenario is to run a specific task based on an array of values. Let's try this out on our workflow.

To do this, we will use the payment deposit workflow we created so far as a [sub-workflow](/content/reference-docs/operators/sub-workflow). In a new workflow, we will run a task that will return a given number of deposit transactions. For each transaction, we will trigger this sub-workflow - which will all run in parallel.
Expand Down Expand Up @@ -52,9 +54,4 @@ cluster, you can run parallel tasks into the thousands or tens of thousands depe

:::note Try out a larger batch
Try configuring a larger batch using the input called __`batchCount`__ to the task `retrieve-deposit-batch` task - we can observe the tasks running in parallel by looking at the timeline view or task list view.
:::

## Related Topics

* [API Reference for Dynamic Fork](/content/reference-docs/operators/dynamic-fork)
* [API Reference for Sub Workflows](/content/reference-docs/operators/sub-workflow)
:::
13 changes: 5 additions & 8 deletions docs/getting-started/first-workflow-application.md
Original file line number Diff line number Diff line change
Expand Up @@ -75,11 +75,8 @@ webkitallowfullscreen="webkitallowfullscreen"></iframe>
</TabItem>
</Tabs>

## Related Topics

- Passing [inputs into workflow for tasks](/content/developer-guides/passing-inputs-to-task-in-conductor).
- Passing the [output of one task to the input of another](/content/developer-guides/passing-inputs-to-task-in-conductor).
- Running [custom worker code](/content/getting-started/adding-custom-code-worker) (instead of HTTP endpoints)
- [Conditional task executions](/content/reference-docs/operators/switch)
- Running a [dynamic set of tasks in parallel](/content/reference-docs/operators/dynamic-fork)
- Configuring [retries for your task](/content/error-handling)
* **[Step 2: Running Workflows from Code](/getting-started/running-workflows-from-code)**
* **[Step 3: Adding Custom Code Worker](/getting-started/adding-custom-code-worker)**
* **[Step 4: Running an Inline Function](/getting-started/running-an-inline-function)**
* **[Step 5: Adding Wait Conditions](/getting-started/adding-wait-conditions)**
* **[Step 6: Executing Tasks in Parallel](/getting-started/executing-tasks-in-parallel)**
9 changes: 4 additions & 5 deletions docs/getting-started/running-an-inline-function.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,8 @@ import Install from '@site/src/components/install.mdx';

# Step 4: Running an Inline Function

[Continuing from Step 3](/getting-started/adding-custom-code-worker)

So far, we haven't done anything here, even if the fraud check fails. How can we handle the case where the fraud check returned a fail, and we want to skip processing the deposit transaction? We can add another inline task that can check for the outcome of the fraud check and send a different message to our users via SMS or Email.

<Tabs>
Expand Down Expand Up @@ -52,8 +54,5 @@ INLINE tasks can be scripted from the following template:

Read more on [INLINE tasks here](/content/reference-docs/system-tasks/inline).

## Related Topics

- Passing [inputs into workflow for tasks](/content/developer-guides/passing-inputs-to-task-in-conductor)
- Passing the [output of one task to the input of another](/content/developer-guides/passing-inputs-to-task-in-conductor)
- [Client SDKs](/content/category/sdks)
* **[Step 5: Adding Wait Conditions](/getting-started/adding-wait-conditions)**
* **[Step 6: Executing Tasks in Parallel](/getting-started/executing-tasks-in-parallel)**
9 changes: 6 additions & 3 deletions docs/getting-started/running-workflows-from-code.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,8 @@ import {

# Step 2: Running Workflows from Code

[Continuing from Step 1](/getting-started/first-workflow-application)

So far, we have seen how to compose and run basic workflows from the UI. However, more commonly, we will be running the workflows from an application or service. Let’s learn how to do this from our applications. Orkes Conductor platform offers various SDKs in different languages
for integration with applications or services.

Expand Down Expand Up @@ -114,6 +116,7 @@ In addition to triggering from code, we can also run them from:
3. [Upon receiving a Webhook](/content/reference-docs/system-tasks/wait-for-webhook)
4. [At a Schedule - using the Scheduler](/content/developer-guides/scheduling-workflows)

## Related Topics

* Passing the [output of one task to the input](/content/developer-guides/passing-inputs-to-task-in-conductor) of another
* **[Step 3: Adding Custom Code Worker](/getting-started/adding-custom-code-worker)**
* **[Step 4: Running an Inline Function](/getting-started/running-an-inline-function)**
* **[Step 5: Adding Wait Conditions](/getting-started/adding-wait-conditions)**
* **[Step 6: Executing Tasks in Parallel](/getting-started/executing-tasks-in-parallel)**
4 changes: 3 additions & 1 deletion sidebars.js
Original file line number Diff line number Diff line change
Expand Up @@ -51,7 +51,9 @@ const sidebars = {
'getting-started/quickstart-2',
'getting-started/quickstart-3',
'getting-started/quickstart-4',
]
],
collapsible: true,
collapsed: false,
}
],
collapsible: true,
Expand Down

0 comments on commit 1b2853b

Please sign in to comment.