Skip to content

Commit

Permalink
Merge pull request #216 from RizaFarheen/main
Browse files Browse the repository at this point in the history
Few Doc Updates: 404 links fixed
  • Loading branch information
nhandt2021 authored Dec 7, 2022
2 parents e4f8c72 + 795d180 commit b77e44b
Show file tree
Hide file tree
Showing 13 changed files with 15 additions and 15 deletions.
2 changes: 1 addition & 1 deletion docs/Conductor/adding-datadog.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ There is a Datadog integration in the [Conductor Community](https://github.com/N

## Setting up DataDog

We'll start with the assumption that Conductor is currently running on your system. If not, clone the GitHub repository and get it [running locally](/content/docs/getting-started/install/running-locally).
We'll start with the assumption that Conductor is currently running on your system. If not, clone the GitHub repository and get it [running locally](/content/docs/getting-started/install/running-locally-docker).

1. First, we will add the metrics dependency to the `server/build.gradle` file.

Expand Down
2 changes: 1 addition & 1 deletion docs/codelab/beginner.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ Let's create a simple workflow that adds Netflix Idents to videos. We'll be mock

!!!info "What are Netflix Idents?"
Netflix Idents are those 4 second videos with Netflix logo, which appears at the beginning and end of shows.
Learn more about them [here](https://partnerhelp.netflixstudios.com/hc/en-us/articles/115004750187-Master-QC-Identifying-and-Implementing-the-Netflix-Ident-). You might have also noticed they're different for Animation and several other genres.
Learn more about them [here](https://partnerhelp.netflixstudios.com/hc/en-us/articles/1500000260302-Overview-of-the-Netflix-Idents). You might have also noticed they're different for Animation and several other genres.

!!!warning "Disclaimer"
Obviously, this is not how Netflix adds Idents. Those Workflows are indeed very complex. But, it should give you an idea about how Conductor can be used to implement similar features.
Expand Down
2 changes: 1 addition & 1 deletion docs/codelab/helloworld.md
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ ON completion of the codelab, the final Hello World workflow looks a lot more co

## Requirements

This demo will use the Orkes [Conductor playground](https://play.orkes.io) to run the workflow. Create an account for free by signing up with an email address or Google account. Alternatively, the open source Conductor [installed locally](/docs/getting-started/install/running-locally) can also be used, using the API to add Tasks and Workflows. The UI in the Playground screenshots will be otherwise similar.
This demo will use the Orkes [Conductor playground](https://play.orkes.io) to run the workflow. Create an account for free by signing up with an email address or Google account. Alternatively, the open source Conductor [installed locally](/docs/getting-started/install/running-locally-docker) can also be used, using the API to add Tasks and Workflows. The UI in the Playground screenshots will be otherwise similar.

To run the Java worker, Java must be installed on yur local computer.

Expand Down
2 changes: 1 addition & 1 deletion docs/codelab/orderfulfillment.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ In this codelab, we'll follow your work as you build out a Conductor workflow to

## What you need to complete this codelab

You'll need a development environment to edit and run your local workers. To run conductor, we'll use the [Orkes Playground](https://play.orkes.io), which requires an account for use (but it is free!). You can also use any installation of [Conductor](/content/docs/getting-started/install/running-locally) to build your workflow.
You'll need a development environment to edit and run your local workers. To run conductor, we'll use the [Orkes Playground](https://play.orkes.io), which requires an account for use (but it is free!). You can also use any installation of [Conductor](/content/docs/getting-started/install/running-locally-docker) to build your workflow.

## A simple order Fulfillment workflow

Expand Down
2 changes: 1 addition & 1 deletion docs/codelab/orderfulfillment4.md
Original file line number Diff line number Diff line change
Expand Up @@ -96,7 +96,7 @@ The other thing to note is that with an HTTP task, the ```connectionTimeout``` a

Despite the ```connectionTimeout``` and ```readTimeout``` parameters, it can still take over 5 seconds for the heroku instance to spin up (if it has gone dormant). We can build more error handling into this task to prevent our workflow from failing.

The HTTP Task has the ```retrycount``` built in, but let's [extend the task](/content/docs/how-tos/Tasks/extending-system-tasks) with retry values.
The HTTP Task has the ```retrycount``` built in, but let's extend the task with retry values.

To do this, we'll define a new task with the same name as our HTTP Task (click "Task Definitions" and then "Define Task").

Expand Down
2 changes: 1 addition & 1 deletion docs/codelab/orderfulfillment5.md
Original file line number Diff line number Diff line change
Expand Up @@ -93,7 +93,7 @@ The switch case can evaulate the input in several ways (including running JavaSc
}
```

In this workflow, the switch case is at the end of the workflow, so we'll insert 2 [terminate tasks](https://orkes.io/content/docs/reference-docs/terminate-task0): one for the default case, and one for the failure case.
In this workflow, the switch case is at the end of the workflow, so we'll insert 2 [terminate tasks](https://orkes.io/content/docs/reference-docs/terminate-task): one for the default case, and one for the failure case.

## Terminate task

Expand Down
4 changes: 2 additions & 2 deletions docs/codelab/orderfulfillment6.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ Our workflow creates the labels for multiple shipments - but currently only hand

## Workflow V2

<p align="center"><img src="/content/img/codelab/of5_5_loopworkflow.png" alt="adding the do-while loop" width="400" style={{paddingBottom: 40, paddingTop: 40}} /></p>
<p align="center"><img src="/content/img/codelab/OF5_5_loopworkflow.png" alt="adding the do-while loop" width="400" style={{paddingBottom: 40, paddingTop: 40}} /></p>

In order to support drop-shipping while still supporting multiple shipments to a single address, we need to run the ```shipping_loop``` (and the internal ```widget_shipping```) tasks once per address. To do this, we'll utilize the [FORK](/content/docs/reference-docs/fork-task) System task. The Fork task creates a number of parallel task flows thcat can run simultaneously. We'll use a FORK to create address labels for multiple addresses at once.

Expand Down Expand Up @@ -50,7 +50,7 @@ For space, the 2 forkTasks are left out, but imagine reusing the ```widget_shipp

<p align="center"><img src="/content/img/codelab/of4_forkexample.png" alt="version 2 regular fork" width="500" style={{paddingBottom: 40, paddingTop: 40}} /></p>

Now, this is really great...but with a FORK, the number of 'tines' in the fork are defined at workflow definition. Since the number of addresses will change on each order, we need something more flexible, that can be defined at runtime. Luckily we have that - the [DYNAMIC_FORK](content/docs/reference-docs/dynamic-fork-task). Dynamic forks determine the number of 'tines' at workflow runtime - which is exactly what we need to build our dropshipping application. This will provide the flexibility we need to support dropshipping of Bob's widgets.
Now, this is really great...but with a FORK, the number of 'tines' in the fork are defined at workflow definition. Since the number of addresses will change on each order, we need something more flexible, that can be defined at runtime. Luckily we have that - the [DYNAMIC_FORK](/content/docs/reference-docs/dynamic-fork-task. Dynamic forks determine the number of 'tines' at workflow runtime - which is exactly what we need to build our dropshipping application. This will provide the flexibility we need to support dropshipping of Bob's widgets.

But - before we build our dynamic fork, we have a lot of housekeeping to take care of.

Expand Down
4 changes: 2 additions & 2 deletions docs/codelab/sequentialHTTPtasks.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ The second task can only run with input provided from the first task.

## Codelab Requirements

You'll need a version of Conductor. The images will be based on the [Conductor Playground](https://play.orkes.io), but a [local Conductor instance](/content/docs/getting-started/install/running-locally) works as well.
You'll need a version of Conductor. The images will be based on the [Conductor Playground](https://play.orkes.io), but a [local Conductor instance](/content/docs/getting-started/install/running-locally-docker) works as well.

## Workflow input

Expand Down Expand Up @@ -174,7 +174,7 @@ The HTTP request system task does not have retry parameters built in by default,
}
```

This tells Conductor to add a ```retryCount: 3```, with a ```"retryDelaySeconds": 5,``` between each attempt. The retry logic is set to ```"retryLogic": "FIXED",``` (but could also be set to ```EXPONENTIAL_BACKOFF```) ([Read more on this](/content/docs/how-tos/Tasks/extending-system-tasks)).
This tells Conductor to add a ```retryCount: 3```, with a ```"retryDelaySeconds": 5,``` between each attempt. The retry logic is set to ```"retryLogic": "FIXED",``` (but could also be set to ```EXPONENTIAL_BACKOFF```).


If the timeout is lowered in the HTTP connection (say to 1500ms), this task is much more likely to fail (due to the slow API response time). The task will be attempted 4 times (once and then 3 retries), and if none of the attempts succeed, the workflow will fail after 4 tries.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -70,7 +70,7 @@ To add a Workflow/Task permission, click the ```+``` at the top of the ```Workf

<p align="center"><img src="/content/img/application_permission.png" alt="permission dialog" width="500" style={{paddingBottom: 40, paddingTop: 40}} /></p>

> Note: When adding tasks, you can specify a [domain](http://localhost:3000/content/docs/codelab/taskToDomain). This allows you to direct all traffic to a specific instance of a task - without specifying in the API.
> Note: When adding tasks, you can specify a [domain](https://orkes.io/content/docs/codelab/taskToDomain). This allows you to direct all traffic to a specific instance of a task - without specifying in the API.
Once all of the workflows and tasks have been added, the table will display the selection. The application below is set for running the [order fulfillment codelab](/content/docs/codelab/orderfulfillment).

Expand Down
2 changes: 1 addition & 1 deletion docs/how-tos/Tasks/creating-tasks.md
Original file line number Diff line number Diff line change
Expand Up @@ -142,6 +142,6 @@ fetch("http://localhost:8080/api/metadata/taskdefs", {
## Best Practices

1. You can update a set of tasks together in this API
2. Task configurations are important attributes that controls the behavior of this task in a Workflow. Refer to [Task Configurations](/content/docs/how-tos/task-configurations) for all the options and details'
2. Task configurations are important attributes that controls the behavior of this task in a Workflow.
3. You can also use the Conductor Swagger UI to update the tasks

2 changes: 1 addition & 1 deletion docs/how-tos/Tasks/updating-tasks.md
Original file line number Diff line number Diff line change
Expand Up @@ -38,4 +38,4 @@ fetch("http://localhost:8080/api/metadata/taskdefs", {
## Best Practices

1. You can also use the Conductor Swagger UI to update the tasks
2. Task configurations are important attributes that controls the behavior of this task in a Workflow. Refer to [Task Configurations](/content/docs/how-tos/task-configurations) for all the options and details'
2. Task configurations are important attributes that controls the behavior of this task in a Workflow.
2 changes: 1 addition & 1 deletion docs/introduction.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ Conductor is a platform originally developed at Netflix to orchestrate workflows
* Tasks can be system managed (no-code deployment) or your [custom code](how-tos/Workers/write-workers)
* Tasks are managed by persistent task queues transparent to users
* Custom code tasks can be written in any language and can connect to a workflow using the [client SDKs](how-tos/SDKs)
* Tasks can be run like a programming language, i.e., [sub workflows](docs/reference-docs/sub-workflow-task), step-by-step, [parallel tasks](reference-docs/fork-task), [conditional tasks](reference-docs/switch-task), [dynamic tasks](reference-docs/dynamic-fork-task), etc. [are supported](reference-docs)
* Tasks can be run like a programming language, i.e., [sub workflows](reference-docs/sub-workflow-task), step-by-step, [parallel tasks](reference-docs/fork-task), [conditional tasks](reference-docs/switch-task), [dynamic tasks](reference-docs/dynamic-fork-task), etc. [are supported](reference-docs)

<p style={{textAlign: "center"}}><img src="/content/img/anatomy.png" alt="adding a secret via UI" width="600" style={{paddingBottom: 40, paddingTop: 40}} /></p>

Expand Down
2 changes: 1 addition & 1 deletion docs/reference-docs/switch-task.md
Original file line number Diff line number Diff line change
Expand Up @@ -124,6 +124,6 @@ Here is an example using the `javascript` evaluator type:
```

### Codelab examples
* [Hello World codelab](http://localhost:3000/content/docs/codelab/helloworld5) using JavaScript Evaluation
* [Hello World codelab](/content/docs/codelab/helloworld5) using JavaScript Evaluation
* [Post office Workflows](/content/docs/usecases/US_post_office) Switch handles success and failure mechanisms via `value-param`.
* [Document Approval](/content/docs/usecases/document_approvals)

0 comments on commit b77e44b

Please sign in to comment.