DOC-727: Convert Workflow reference to MD (#488)

up42 · Nov 3, 2023 · 685f30b · 685f30b
1 parent e2752cc
commit 685f30b
Show file tree

Hide file tree

Showing 5 changed files with 533 additions and 20 deletions.
diff --git a/docs/analytics.md b/docs/analytics.md
@@ -15,24 +15,20 @@ A workflow starts with a data block, which may be followed by processing blocks.
   project = up42.initialize_project()
 
   workflow = project.create_workflow(name="My workflow with Processing from Storage")
-  workflow.add_workflow_tasks([
-    "Processing from Storage"
-  ])
+  workflow.add_workflow_tasks(["Processing from Storage"])
   ```
 1. If needed, search for compatible blocks:
   ```python
   workflow.get_compatible_blocks()
   ```
   The search outputs a dataframe with blocks that can be added to your workflow, for example:
   ```python
-  workflow.add_workflow_tasks([
-    "Sharpening Filter"
-  ])
+  workflow.add_workflow_tasks(["Processing from Storage", "Sharpening Filter"])
   ```
 
 ## Step 2. Retrieve an input schema
 
-Retrieve input parameters of the first block in a workflow:
+Retrieve input JSON parameters of the first block in a workflow:
 ```python
 workflow.get_parameters_info()
 ```

diff --git a/docs/reference/job-reference.md b/docs/reference/job-reference.md
@@ -2,7 +2,7 @@
 
 The Job class enables access to the UP42 [analytics functionality](analytics.md).
 
-A job is an instance of a workflow. It delivers geospatial outputs defined by job parameters.
+A job is an instance of a workflow. It delivers geospatial outputs defined by job JSON parameters.
 
 ```python
 job = up42.initialize_job(job_id="68567134-27ad-7bd7-4b65-d61adb11fc78")

diff --git a/docs/reference/project-reference.md b/docs/reference/project-reference.md
@@ -22,7 +22,7 @@ project.info
 
 ### max_concurrent_jobs
 
-The `max_concurrent_jobs` attribute returns the maximum number of jobs that can be running simultaneously.
+The `max_concurrent_jobs` attribute returns the maximum number of jobs that can run simultaneously.
 
 The returned format is `int`.
 
@@ -39,6 +39,7 @@ The `get_project_settings()` function returns threshold limits applied to the pr
 ```python
 get_project_settings()
 ```
+
 The returned format is `list[dict[str, str]]`.
 
 <h5> Example </h5>
@@ -63,11 +64,11 @@ The returned format is `dict`.
 
 <h5> Arguments </h5>
 
-| Argument              | Overview                                                                                                            |
-| --------------------- | ------------------------------------------------------------------------------------------------------------------- |
-| `max_aoi_size`        | **int**<br/>The largest area of interest that can be specified. Use a value from 1 to 1,000 km<sup>2</sup>.         |
-| `max_concurrent_jobs` | **int**<br/>The maximum number of jobs that can be running simultaneously. Use a value from 1 to 10 km<sup>2</sup>. |
-| `number_of_images`    | **int**<br/>The maximum number of images that can be returned. Use a value from 1 to 20 km<sup>2</sup>.             |
+| Argument              | Overview                                                                                                    |
+| --------------------- | ----------------------------------------------------------------------------------------------------------- |
+| `max_aoi_size`        | **int**<br/>The largest area of interest that can be specified. Use a value from 1 to 1,000 km<sup>2</sup>. |
+| `max_concurrent_jobs` | **int**<br/>The maximum number of jobs that can run simultaneously. Use a value from 1 to 10.               |
+| `number_of_images`    | **int**<br/>The maximum number of images that can be returned. Use a value from 1 to 20.                    |
 
 <h5> Example </h5>