Skip to content

Commit

Permalink
update doc (#289)
Browse files Browse the repository at this point in the history
  • Loading branch information
@fatonramadani
fatonramadani authored Sep 4, 2023
1 parent b786260 commit 3bec7ef
Show file tree
Hide file tree
Showing 4 changed files with 70 additions and 66 deletions.
33 changes: 18 additions & 15 deletions docs/apps/4_app_configuration-settings/1_app_component_library.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -138,9 +138,7 @@ The container component has no configuration.

#### Outputs

| Name | Type | Description |
| ---------------- | :----: | ------------------------------- |
| selectedTabIndex | number | The number of the selected tab. |
The container component has no output.

### List

Expand Down Expand Up @@ -191,13 +189,16 @@ List components also support having [inputs](#inputs) set inside them. Retrieve

#### List configuration

| Name | Type | Connectable | Templatable | Default | Description |
| ------------ | :----: | :---------: | :---------: | :------------: | -------------------------------------------- |
| items | array | true | false | 3 items | The list items. |
| item keys | string | true | false | `"foo": 1` ... | The keys of each card. |
| Width | string | false | false | false | Wether items should be "Card" of "Full Row". |
| Min Width Px | number | true | true | 300 | The minimum width in pixels. |
| Height Px | number | true | true | 280 | The height in pixels. |
| Name | Type | Connectable | Templatable | Default | Description |
| ------------ | :----: | :---------: | :---------: | :-------------------: | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| items | array | true | false | 3 items | The list items. |
| item keys | string | true | false | `"foo": 1` ... | The keys of each card. |
| Width | string | false | false | "Card" | Whether items should be "Card" of "Full Row". |
| Min Width Px | number | true | true | 300 | The minimum width in pixels. Only applies when "Width" is set to Card |
| Height Px | number | true | true | 280 | The height in pixels. |
| Pagination | string | false | false | "Managed by runnable" | Pagination can be managed using two methods: By the component: Based on a specified page size, the component divides the array into several pages. By the runnable: The component shows all items, leaving the task of pagination to the runnable. The current page number is available in the component outputs. |
| Page count | number | false | false | 1 | The number of pages. Only applies when pagination is managed by the runnable. |
| Page size | number | false | false | 3 | The number of items per page. Only applies when pagination is managed by component. |

#### Outputs

Expand All @@ -206,6 +207,7 @@ List components also support having [inputs](#inputs) set inside them. Retrieve
| result | any | The result of the list component. |
| loading | boolean | The loading state of the component. |
| inputs | any | The [inputs](#inputs) of the component. |
| page | number | The current page number. |

### Divider X

Expand Down Expand Up @@ -352,11 +354,12 @@ A validation function can be set and won't allow users to go to the next step wh

#### Outputs

| Name | Type | Description |
| ---------------- | :-----: | -------------------------------- |
| currentStepIndex | number | Number of the step / tab. |
| result | any | The result of the runnable. |
| loading | boolean | The loading state of the button. |
| Name | Type | Description |
| ---------------- | :------------------------: | -------------------------------------- | --- |
| currentStepIndex | number | Number of the step / tab. |
| result | any | The result of the runnable. |
| loading | boolean | The loading state of the button. |
| lastAction | string: "previous", "next" | The last action performed by the user. | F |

## Tabs

Expand Down
6 changes: 3 additions & 3 deletions docs/core_concepts/13_json_schema_and_parsing/index.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -157,9 +157,9 @@ Below is the list of all available advanced settings for each argument type:
| Type | Advanced Configuration |
| ------- | ----------------------------------------------------------------------------------------------------------------------------------------- |
| Integer | No advanced configuration for this type. |
| Number | No advanced configuration for this type. |
| String | - File (base64) | Enum | Format: email, hostname, uri, uuid, ipv4, yaml, sql | Pattern (Regex) |
| Number | Min and Max. |
| String | - File (base64) | Enum | Format: email, hostname, uri, uuid, ipv4, yaml, sql, date-time | Pattern (Regex) |
| Boolean | No advanced configuration for this type. |
| Object | Advanced settings are [Resource Types](../3_resources_and_types/index.mdx). |
| Object | Advanced settings are [Resource Types](../3_resources_and_types/index.mdx). |
| Array | - Items are strings | Items are strings from an enum | Items are objects (JSON) | Items are numbers | Items are bytes |
| Any | No advanced configuration for this type. |
77 changes: 39 additions & 38 deletions docs/flows/3_editor_components.mdx
View file
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,7 @@ The Flow Builder has the following major components we will detail below:

The toolbar allows you to export the flow, configure the flow settings, and test the flow.
Here are the different options available in the toolbar:

- **Summary**: shortcut to edit the flow summary.
- **Previous/Next**: undo actions.
- **[Path](../core_concepts/16_roles_and_permissions/index.mdx#path)**: define the permissions of the flow.
Expand Down Expand Up @@ -56,17 +57,17 @@ The owner can be either a user, or a group of users ([folder](../core_concepts/8

<div class="grid grid-cols-2 gap-6 mb-4">
<DocCard
title="Roles and Permissions"
description="Control access and manage permissions within your instance and workspaces."
href="/docs/core_concepts/roles_and_permissions"
title="Roles and Permissions"
description="Control access and manage permissions within your instance and workspaces."
href="/docs/core_concepts/roles_and_permissions"
color="teal"
/>
<DocCard
title="Groups and Folders"
description="Groups and Folders enable efficient permission management by grouping users with similar access levels."
href="/docs/core_concepts/groups_and_folders"
/>
<DocCard
title="Groups and Folders"
description="Groups and Folders enable efficient permission management by grouping users with similar access levels."
href="/docs/core_concepts/groups_and_folders"
color="teal"
/>
/>
</div>

#### Description
Expand All @@ -90,12 +91,12 @@ Have more details on all the ways to trigger flows [here](../getting_started/9_t
:::

<div class="grid grid-cols-2 gap-6 mb-4">
<DocCard
color="teal"
title="Scheduling"
description="Scheduling allows you to define schedules for Scripts and Flows, automatically running them at set frequencies."
href="/docs/core_concepts/scheduling"
/>
<DocCard
color="teal"
title="Scheduling"
description="Scheduling allows you to define schedules for Scripts and Flows, automatically running them at set frequencies."
href="/docs/core_concepts/scheduling"
/>
</div>

### Shared Directory
Expand Down Expand Up @@ -129,12 +130,12 @@ This flow can be found on the Demo workspace.
Another example is to be found from the [Hub](https://hub.windmill.dev/flows/32/same-worker-example-of-using-the-'.%2Fshared'-folder).

<div class="grid grid-cols-2 gap-6 mb-4">
<DocCard
<DocCard
color="teal"
title="Persistent Storage"
description="Ensure that your data is safely stored and easily accessible whenever required."
href="/docs/core_concepts/persistent_storage"
/>
description="Ensure that your data is safely stored and easily accessible whenever required."
href="/docs/core_concepts/persistent_storage"
/>
</div>

### Worker Group Tag
Expand All @@ -161,20 +162,20 @@ You can also test up to a certain step by clicking on an action (x) and then on
At last, you can directly [test a step](#test-this-step).

<video
className="border-2 rounded-xl object-cover w-full h-full dark:border-gray-800"
controls
src="/videos/flow_test_flow.mp4"
className="border-2 rounded-xl object-cover w-full h-full dark:border-gray-800"
controls
src="/videos/flow_test_flow.mp4"
/>

<br/>
<br />

<div class="grid grid-cols-2 gap-6 mb-4">
<DocCard
title="Instant Preview & Testing"
description="Windmill allows users to test what they are building directly from the editor, even before deployment."
href="/docs/core_concepts/instant_preview"
title="Instant Preview & Testing"
description="Windmill allows users to test what they are building directly from the editor, even before deployment."
href="/docs/core_concepts/instant_preview"
color="teal"
/>
/>
</div>

## Static inputs
Expand Down Expand Up @@ -218,8 +219,8 @@ Below is the list of all available advanced settings for each argument type:
| Type | Advanced Configuration |
| ------- | ----------------------------------------------------------------------------------------------------------------------------------------- |
| Integer | No advanced configuration for this type. |
| Number | No advanced configuration for this type. |
| String | - File (base64) &#124; Enum &#124; Format: email, hostname, uri, uuid, ipv4, yaml, sql &#124; Pattern (Regex) |
| Number | Min and Max. |
| String | - File (base64) &#124; Enum &#124; Format: email, hostname, uri, uuid, ipv4, yaml, sql, date-time &#124; Pattern (Regex) |
| Boolean | No advanced configuration for this type. |
| Object | Advanced settings are [Resource Types](../core_concepts/3_resources_and_types/index.mdx). |
| Array | - Items are strings &#124; Items are strings from an enum &#124; Items are objects (JSON) &#124; Items are numbers &#124; Items are bytes |
Expand Down Expand Up @@ -347,12 +348,12 @@ The header is composed of:
- Script: view hub or workspace script code.

<div class="grid grid-cols-2 gap-6 mb-4">
<DocCard
<DocCard
color="teal"
title="Script Editor"
description="In Windmill, Scripts are the basis of all major features."
href="/docs/script_editor"
/>
description="In Windmill, Scripts are the basis of all major features."
href="/docs/script_editor"
/>
</div>

### Step configuration/Test this step
Expand Down Expand Up @@ -407,11 +408,11 @@ The result and logs are displyed on the left-hand side.

<div class="grid grid-cols-2 gap-6 mb-4">
<DocCard
title="Instant Preview & Testing"
description="Windmill allows users to test what they are building directly from the editor, even before deployment."
href="/docs/core_concepts/instant_preview"
title="Instant Preview & Testing"
description="Windmill allows users to test what they are building directly from the editor, even before deployment."
href="/docs/core_concepts/instant_preview"
color="teal"
/>
/>
</div>

#### Advanced
Expand All @@ -425,7 +426,7 @@ The advanced section allows to configure the following:
description="Re-try a step in case of error."
href="/docs/flows/retries"
/>
<DocCard
<DocCard
color="teal"
title="Cache for Steps"
description="Re-use a step's previous results."
Expand Down
20 changes: 10 additions & 10 deletions docs/script_editor/customize_arguments.mdx
View file
Original file line number Diff line number Diff line change
Expand Up @@ -7,23 +7,23 @@ Some arguments' types can be given advanced settings that will affect the inputs
Here is an example on how to define a python list as an enum of strings using the `Customize` menu.

<video
className="border-2 rounded-xl object-cover w-full h-full dark:border-gray-800"
controls
id="main-video"
src="/videos/advanced_parameters_enum.mp4"
className="border-2 rounded-xl object-cover w-full h-full dark:border-gray-800"
controls
id="main-video"
src="/videos/advanced_parameters_enum.mp4"
/>

<br/>
<br />

Below is the list of all available advanced settings for each argument type:

| Type | Advanced Configuration |
| ------- | ----------------------------------------------------------------------------------------------------------------------------------------- |
| Integer | No advanced configuration for this type. |
| Number | No advanced configuration for this type. |
| String | - File (base64) &#124; Enum &#124; Format: email, hostname, uri, uuid, ipv4, yaml, sql &#124; Pattern (Regex) |
| Number | Min and Max. |
| String | - File (base64) &#124; Enum &#124; Format: email, hostname, uri, uuid, ipv4, yaml, sql, date-time &#124; Pattern (Regex) |
| Boolean | No advanced configuration for this type. |
| Object | Advanced settings are [Resource Types](../core_concepts/3_resources_and_types/index.mdx). |
| Object | Advanced settings are [Resource Types](../core_concepts/3_resources_and_types/index.mdx). |
| Array | - Items are strings &#124; Items are strings from an enum &#124; Items are objects (JSON) &#124; Items are numbers &#124; Items are bytes |
| Any | No advanced configuration for this type. |

Expand All @@ -37,5 +37,5 @@ Below is the list of all available advanced settings for each argument type:
title="JSON Schema and Parsing"
description="JSON Schemas are used for defining the input specification for scripts and flows, and specifying resource types."
href="/docs/core_concepts/json_schema_and_parsing"
/>
</div>
/>
</div>

0 comments on commit 3bec7ef

Please sign in to comment.