Merge pull request #559 from RizaFarheen/main

Updates based on latest UI changes - 2
orkes-io · Nov 9, 2023 · c5c6919 · c5c6919
2 parents b695c2c + d011bce
commit c5c6919
Show file tree

Hide file tree

Showing 24 changed files with 23 additions and 25 deletions.
diff --git a/docs/faqs/workflow-versioning.md b/docs/faqs/workflow-versioning.md
@@ -26,7 +26,7 @@ To create a new version of a workflow, you can make changes to your existing wor
 
 You can view previous versions of a workflow from the Workflow Definitions page. 
 
-1. Navigate to **Workflow > Definitions**.
+1. Navigate to **Definitions > Workflow**.
 2. Click the required workflow.
 3. You can choose the workflow version to view your definition.
 

diff --git a/docs/reference-docs/operators/terminate-workflow.md b/docs/reference-docs/operators/terminate-workflow.md
@@ -89,23 +89,21 @@ Suppose another running workflow is to be terminated; we can create a workflow w
 A sample workflow may look like this:
 ```json
     {
-      "name": "terminate_workflow",
-      "description": "Edit or extend this sample workflow. Set the workflow name to get started",
-      "version": 1,
-      "tasks": [
-        {
-          "name": "terminate_hello_world",
-          "taskReferenceName": "terminate_hello_world",
-          "inputParameters": {
-            "workflowId": "ff2c8cdc-d20e-11ed-b1a7-ce4d7ef052ad"
-          },
-          "type": "TERMINATE_WORKFLOW"
-        }
-      ],
-      "schemaVersion": 2,
-      "ownerEmail": "[email protected]",
-      "timeoutPolicy": "ALERT_ONLY"
+  "name": "terminate_workflow",
+  "description": "Edit or extend this sample workflow. Set the workflow name to get started",
+  "version": 1,
+  "tasks": [
+    {
+      "name": "terminate_hello_world",
+      "taskReferenceName": "terminate_hello_world",
+      "inputParameters": {
+        "workflowId": "a8776d48-7ec9-11ee-8f81-26c6bd51258d"
+      },
+      "type": "TERMINATE_WORKFLOW"
     }
+  ],
+  "ownerEmail": "[email protected]"
+}
 ```
 If we run this workflow, the workflow with the mentioned workflowId gets terminated, and we can get the terminatedWorkflowIds from the execution page.
 

diff --git a/docs/reference-docs/system-tasks/wait-for-webhook.md b/docs/reference-docs/system-tasks/wait-for-webhook.md
@@ -81,15 +81,15 @@ For example, the above one will match the webhook event payload where the **even
 
 Let’s create a Webhook now.
 
-1. Navigate to **Webhooks** from the Conductor server.
+1. Navigate to **Definitions > Webhooks** from the left menu of your Conductor console.
 2. Click **New Webhook**.
 3. You need to fill in the following details:
 
 | Field                                   | Description                                                                                                                                                                                                                                                                     |
 |-----------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
-| Webhook Name                            | Provide a unique name for your Webhook.                                                                                                                                                                                                                                         |
-| Workflow To Receive Webhook Event       | Provide the workflow name that is supposed to receive this webhook event.                                                                                                                                                                                                       |
-| Source Platform                         | Choose the platform from which this webhook event is going to be invoked. The currently supported platforms are GitHub, Slack, Twilio, Stripe, Pagerduty, Zendesk, Twitter, Facebook, Sendgrid & Custom. <br/> **Note**: You can use the option custom for unsupported systems. |
+| Webhook name                            | Provide a unique name for your Webhook.                                                                                                                                                                                                                                         |
+| Workflow to receive webhook event       | Provide the workflow name that is supposed to receive this webhook event.                                                                                                                                                                                                       |
+| Source platform                         | Choose the platform from which this webhook event is going to be invoked. The currently supported platforms are GitHub, Slack, Twilio, Stripe, Pagerduty, Zendesk, Twitter, Facebook, Sendgrid & Custom. <br/> **Note**: You can use the option custom for unsupported systems. |
 | Start workflow when webhook events come | Check this option to start a new workflow based on the data received from the webhook event. Once enabled, you need to choose the workflow to be executed.                                                                                                                      |
 
 4. Click the **Create** button, and the Conductor will generate a Webhook URL, which will be unverified.

diff --git a/docs/templates/examples/custom-conductor-webhook-using-curl.md b/docs/templates/examples/custom-conductor-webhook-using-curl.md
@@ -14,7 +14,7 @@ In this example, let’s create a sample workflow like this:
 
 To create a workflow,
 
-1. From your Conductor server, navigate to **Workflows > Definitions** from the left menu.
+1. From your Conductor server, navigate to **Definitions > Workflows** from the left menu.
 2. Click **Define Workflow** and create the workflow to implement your business solution. Include the *[WAIT_FOR_WEBHOOK](https://orkes.io/content/reference-docs/system-tasks/wait-for-webhook)* task where you need to receive the signal to the webhook. 
 
 The JSON code for the above workflow is as follows:
@@ -64,7 +64,7 @@ The JSON code for the above workflow is as follows:
 
 Next, you need to create a webhook.
 
-1. From your Conductor server, navigate to **Webhooks** from the left menu.
+1. From your Conductor server, navigate to **Definitions > Webhooks** from the left menu.
 2. Click the **New Webhook** button and create the webhook with the following configurations.
 
 <p align="center"><img src="/content/img/sample-webhook-using-curl.png" alt="Webhook created in Conductor" width="70%" height="auto" style={{paddingBottom: 40, paddingTop: 40}} /></p>

diff --git a/docs/templates/examples/incoming-webhook-using-postman.md b/docs/templates/examples/incoming-webhook-using-postman.md
@@ -12,7 +12,7 @@ Consider the following workflow that waits for a webhook event from Postman:
 
 To create a workflow:
 
-1. Navigate to **Workflows > Definitions** from the left menu.
+1. Navigate to **Definitions > Workflows** from the left menu.
 2. Click **Define Workflow** and create a workflow including a [WAIT_FOR_WEBHOOK](https://orkes.io/content/reference-docs/system-tasks/wait-for-webhook) task.
 
 For the WAIT_FOR_WEBHOOK task, the input matches are defined as:
@@ -72,7 +72,7 @@ Next, create a webhook to invoke this workflow.
 
 ## Creating Webhook in Conductor
 
-1. From your Conductor server, navigate to **Webhooks** from the left menu.
+1. From your Conductor server, navigate to **Definitions > Webhooks** from the left menu.
 2. Click the **New Webhook** button and create the webhook with the following configurations.
 
 <p align="center"><img src="/content/img/sample-webhook.png" alt="Webhook example" width="70%" height="auto" style={{paddingBottom: 40, paddingTop: 40}} /></p>

diff --git a/static/img/Creating-a-challenge-based-verifier-Webhook-in-Conductor.png b/static/img/Creating-a-challenge-based-verifier-Webhook-in-Conductor.png
diff --git a/static/img/Creating-a-header-based-verifier-Webhook-in-Conductor.png b/static/img/Creating-a-header-based-verifier-Webhook-in-Conductor.png
diff --git a/static/img/Creating-a-signature-based-verifier-Webhook-in-Conductor.png b/static/img/Creating-a-signature-based-verifier-Webhook-in-Conductor.png
diff --git a/static/img/Webhook-with-a-verified-URL-in-Conductor.png b/static/img/Webhook-with-a-verified-URL-in-Conductor.png
diff --git a/static/img/Webhook-with-an-unverified-URL-in-Conductor.png b/static/img/Webhook-with-an-unverified-URL-in-Conductor.png
diff --git a/static/img/completed-webhook-curl.png b/static/img/completed-webhook-curl.png
diff --git a/static/img/deleting-versions-in-workflow.png b/static/img/deleting-versions-in-workflow.png
diff --git a/static/img/running-different-workflow-versions.png b/static/img/running-different-workflow-versions.png
diff --git a/static/img/running-workflow-curl.png b/static/img/running-workflow-curl.png
diff --git a/static/img/sample-webhook-using-curl.png b/static/img/sample-webhook-using-curl.png
diff --git a/static/img/start-workflow-output-in-conductor.png b/static/img/start-workflow-output-in-conductor.png
diff --git a/static/img/terminate-workflow.png b/static/img/terminate-workflow.png
diff --git a/static/img/terminated-workflow.png b/static/img/terminated-workflow.png
diff --git a/static/img/triggered-workflow-curl.png b/static/img/triggered-workflow-curl.png
diff --git a/static/img/verified-webhook-curl.png b/static/img/verified-webhook-curl.png
diff --git a/static/img/viewing-execution-curl.png b/static/img/viewing-execution-curl.png
diff --git a/static/img/workflow-status-update-from-ui.png b/static/img/workflow-status-update-from-ui.png
diff --git a/static/img/workflow-versioning.png b/static/img/workflow-versioning.png
diff --git a/static/img/workflowid.png b/static/img/workflowid.png