Merge pull request #570 from RizaFarheen/main

Doc Updates - Nov 22
orkes-io · Nov 22, 2023 · ceb9630 · ceb9630
2 parents 6a62b2e + 94a415b
commit ceb9630
Show file tree

Hide file tree

Showing 11 changed files with 32 additions and 30 deletions.
diff --git a/docs/reference-docs/api/metadata/creating-task-definitions.md b/docs/reference-docs/api/metadata/creating-task-definitions.md
@@ -1,12 +1,12 @@
 ---
-sidebar_position: 2
+sidebar_position: 1
 ---
 import Tabs from '@theme/Tabs';
 import TabItem from '@theme/TabItem';
 
 # Creating Task Definitions
 
-Tasks are the building blocks of workflow in Conductor. A task can be an operator, system task or custom code written in any programming language.
+Tasks are the building blocks of workflow in Conductor. A task can be an operator, system task or custom code written in any programming language. This API is used to create task definitions in Orkes Conductor.
 
 ## Input Payload
 

diff --git a/docs/reference-docs/api/metadata/creating-workflow-definition.md b/docs/reference-docs/api/metadata/creating-workflow-definition.md
@@ -1,12 +1,12 @@
 ---
-sidebar_position: 7
+sidebar_position: 6
 ---
 import Tabs from '@theme/Tabs';
 import TabItem from '@theme/TabItem';
 
 # Creating Workflow Definition
 
-Workflow can be defined as the collection of tasks and operators that specifies the order and execution of the defined tasks.
+Workflow can be defined as the collection of tasks and operators that specifies the order and execution of the defined tasks. This API is used to create workflow definitions in Orkes Conductor.
 
 ## Input Payload
 

diff --git a/docs/reference-docs/api/metadata/delete-task-definition.md b/docs/reference-docs/api/metadata/delete-task-definition.md
@@ -1,17 +1,18 @@
 ---
-sidebar_position: 4
+sidebar_position: 3
 ---
 import Tabs from '@theme/Tabs';
 import TabItem from '@theme/TabItem';
 
 # Delete Task Definitions
 
+The API to delete the task definitions. 
 
-## Request Paramater
+## Input Parameters
 
 | Attribute  | Description                                           |
 |------------|-------------------------------------------------------|
-| taskType   | Task name for which task definition has to be deleted |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                   |
+| taskType   | The name of the task which is to be deleted. |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                   |
 
 ## API Endpoint
 ```

diff --git a/docs/reference-docs/api/metadata/delete-workflow-definition.md b/docs/reference-docs/api/metadata/delete-workflow-definition.md
@@ -1,20 +1,20 @@
 ---
-sidebar_position: 10
+sidebar_position: 8
 ---
 
 import Tabs from '@theme/Tabs';
 import TabItem from '@theme/TabItem';
 
 # Remove the Workflow Definition
 
-Remove the workflow defintion
+The API to remove/delete the workflow definition.
 
 ## Input Payload
 
 | Attribute | Description |
 | --------- | -------------- |
-| name      | The *name* of the workflow you want to retrieve definition of |
-| version   | Choose the workflow version |
+| name      | The *name* of the workflow you want to delete.|
+| version   | The version of the workflow to be deleted. |
 
 ## API Endpoint
 

diff --git a/docs/reference-docs/api/metadata/get-all-task-definitions.md b/docs/reference-docs/api/metadata/get-all-task-definitions.md
@@ -1,12 +1,12 @@
 ---
-sidebar_position: 1
+sidebar_position: 4
 ---
 import Tabs from '@theme/Tabs';
 import TabItem from '@theme/TabItem';
 
 # Get All Task Definitions
 
-Get all the task definitions.
+The API to get all the task definitions.
 
 ## API Endpoint
 ```

diff --git a/docs/reference-docs/api/metadata/get-all-workflow-definitions.md b/docs/reference-docs/api/metadata/get-all-workflow-definitions.md
@@ -1,13 +1,13 @@
 ---
-sidebar_position: 8
+sidebar_position: 9
 ---
 
 import Tabs from '@theme/Tabs';
 import TabItem from '@theme/TabItem';
 
 # Get All Workflow Definitions
 
-Get all workflow definitions
+The API to get all the workflow definitions.
 
 ## API Endpoint
 

diff --git a/docs/reference-docs/api/metadata/get-task-definition.md b/docs/reference-docs/api/metadata/get-task-definition.md
@@ -6,13 +6,14 @@ import TabItem from '@theme/TabItem';
 
 # Get Task Definition
 
-Get the task definition for the task type
+The API to get all the task definitions.
+
 ## Input Payload
 
 
 | Attribute  | Description                                    |
 | ---------- |------------------------------------------------|
-| taskType   | TaskType for which task definition has to get. | 
+| taskType   | The name of the task for which the task definition is to be retrieved. | 
 ## API Endpoint
 ```
 GET /api/metadata/taskdefs/{taskType}

diff --git a/docs/reference-docs/api/metadata/get-workflow-definition.md b/docs/reference-docs/api/metadata/get-workflow-definition.md
@@ -1,21 +1,21 @@
 ---
-sidebar_position: 9
+sidebar_position: 10
 ---
 
 import Tabs from '@theme/Tabs';
 import TabItem from '@theme/TabItem';
 
 # Get Workflow Definition
 
-Used to retrieve a workflow definition.
+The API to retrieve a partticular workflow definition.
 
 ## Input Payload
 
 | Attribute | Description |
 | --------- | -------------- |
-| name      | The *name* of the workflow you want to retrieve definition of |
-| version   | Choose the workflow version |
-| metadata  | Get with metadata |
+| name      | The *name* of the workflow you want to retrieve definition of. |
+| version   | Provide the workflow version. |
+| metadata  | Provide the metadata details. |
 
 ## API Endpoint
 

diff --git a/docs/reference-docs/api/metadata/update-task-definitions.md b/docs/reference-docs/api/metadata/update-task-definitions.md
@@ -1,16 +1,16 @@
 ---
-sidebar_position: 3
+sidebar_position: 2
 ---
 import Tabs from '@theme/Tabs';
 import TabItem from '@theme/TabItem';
 
 # Updating Task Definitions
 
-Tasks are the building blocks of workflow in Conductor. A task can be an operator, system task or custom code written in any programming language.
+The API to update the existing task definitions.
 
 ## Input Payload
 
-You can configure task definitions directly via UI and using API. The task definitions include the following parameters:
+You can update the task definitions directly via UI and using API. The task definitions include the following parameters:
 
 | Attribute                                          | Description                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              |
 | -------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |

diff --git a/docs/reference-docs/api/metadata/update-workflow-definitions.md b/docs/reference-docs/api/metadata/update-workflow-definitions.md
@@ -6,11 +6,11 @@ import TabItem from '@theme/TabItem';
 
 # Update Workflow Definitions
 
-Workflow can be defined as the collection of tasks and operators that specifies the order and execution of the defined tasks.
+The API to update an existing workflow definition.
 
 ## Input Payload
 
-You can configure workflow definitions directly via UI and using API. The workflow definition include the following parameters:
+You can update the workflow definitions directly via UI and using API. The workflow definition include the following parameters:
 
 | Attribute                     | Description                                                                                                                                                                                                                                            |
 | ----------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
@@ -35,7 +35,7 @@ You can configure workflow definitions directly via UI and using API. The workfl
 PUT /api/metadata/workflow
 ```
 
-When overwrite is passed to true it will overwrite the existing workflow definitions.
+When overwrite is passed to **true** it will overwrite the existing workflow definitions.
 
 ## Client SDK Methods
 

diff --git a/docs/reference-docs/system-tasks/update-secret.md b/docs/reference-docs/system-tasks/update-secret.md
@@ -33,8 +33,8 @@ A system task to update the value of any secret, given the user has permission t
 | secretValue | Value of the secret key. |
 
 :::note Notes
-1. The user must have update permission over the secretKey; otherwise, the workflow will be terminated with a 403 error.
-2. If the secret does not exist by the secretKey, it will be created, and the value will be as per the secretValue.
+1. The user must have update permission over the **secretKey**; otherwise, the workflow will be terminated with a 403 error.
+2. If the secret does not exist, it will be created, and the value will be the **secretValue** provided as the input parameter to the task.
 3. Only one secret can be updated at a time.
 :::