Skip to content

Commit 3bec7ef

Browse files
fatonramadanifatonramadani
authored
update doc (windmill-labs#289)
1 parent b786260 commit 3bec7ef

File tree

4 files changed

+70
-66
lines changed

4 files changed

+70
-66
lines changed

‎docs/apps/4_app_configuration-settings/1_app_component_library.md

Lines changed: 18 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -138,9 +138,7 @@ The container component has no configuration.
138138

139139
#### Outputs
140140

141-
| Name | Type | Description |
142-
| ---------------- | :----: | ------------------------------- |
143-
| selectedTabIndex | number | The number of the selected tab. |
141+
The container component has no output.
144142

145143
### List
146144

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

192190
#### List configuration
193191

194-
| Name | Type | Connectable | Templatable | Default | Description |
195-
| ------------ | :----: | :---------: | :---------: | :------------: | -------------------------------------------- |
196-
| items | array | true | false | 3 items | The list items. |
197-
| item keys | string | true | false | `"foo": 1` ... | The keys of each card. |
198-
| Width | string | false | false | false | Wether items should be "Card" of "Full Row". |
199-
| Min Width Px | number | true | true | 300 | The minimum width in pixels. |
200-
| Height Px | number | true | true | 280 | The height in pixels. |
192+
| Name | Type | Connectable | Templatable | Default | Description |
193+
| ------------ | :----: | :---------: | :---------: | :-------------------: | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
194+
| items | array | true | false | 3 items | The list items. |
195+
| item keys | string | true | false | `"foo": 1` ... | The keys of each card. |
196+
| Width | string | false | false | "Card" | Whether items should be "Card" of "Full Row". |
197+
| Min Width Px | number | true | true | 300 | The minimum width in pixels. Only applies when "Width" is set to Card |
198+
| Height Px | number | true | true | 280 | The height in pixels. |
199+
| 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. |
200+
| Page count | number | false | false | 1 | The number of pages. Only applies when pagination is managed by the runnable. |
201+
| Page size | number | false | false | 3 | The number of items per page. Only applies when pagination is managed by component. |
201202

202203
#### Outputs
203204

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

210212
### Divider X
211213

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

353355
#### Outputs
354356

355-
| Name | Type | Description |
356-
| ---------------- | :-----: | -------------------------------- |
357-
| currentStepIndex | number | Number of the step / tab. |
358-
| result | any | The result of the runnable. |
359-
| loading | boolean | The loading state of the button. |
357+
| Name | Type | Description |
358+
| ---------------- | :------------------------: | -------------------------------------- | --- |
359+
| currentStepIndex | number | Number of the step / tab. |
360+
| result | any | The result of the runnable. |
361+
| loading | boolean | The loading state of the button. |
362+
| lastAction | string: "previous", "next" | The last action performed by the user. | F |
360363

361364
## Tabs
362365

‎docs/core_concepts/13_json_schema_and_parsing/index.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -157,9 +157,9 @@ Below is the list of all available advanced settings for each argument type:
157157
| Type | Advanced Configuration |
158158
| ------- | ----------------------------------------------------------------------------------------------------------------------------------------- |
159159
| Integer | No advanced configuration for this type. |
160-
| Number | No advanced configuration for this type. |
161-
| String | - File (base64) | Enum | Format: email, hostname, uri, uuid, ipv4, yaml, sql | Pattern (Regex) |
160+
| Number | Min and Max. |
161+
| String | - File (base64) | Enum | Format: email, hostname, uri, uuid, ipv4, yaml, sql, date-time | Pattern (Regex) |
162162
| Boolean | No advanced configuration for this type. |
163-
| Object | Advanced settings are [Resource Types](../3_resources_and_types/index.mdx). |
163+
| Object | Advanced settings are [Resource Types](../3_resources_and_types/index.mdx). |
164164
| Array | - Items are strings | Items are strings from an enum | Items are objects (JSON) | Items are numbers | Items are bytes |
165165
| Any | No advanced configuration for this type. |

‎docs/flows/3_editor_components.mdx

Lines changed: 39 additions & 38 deletions
Original file line numberDiff line numberDiff line change
@@ -23,6 +23,7 @@ The Flow Builder has the following major components we will detail below:
2323

2424
The toolbar allows you to export the flow, configure the flow settings, and test the flow.
2525
Here are the different options available in the toolbar:
26+
2627
- **Summary**: shortcut to edit the flow summary.
2728
- **Previous/Next**: undo actions.
2829
- **[Path](../core_concepts/16_roles_and_permissions/index.mdx#path)**: define the permissions of the flow.
@@ -56,17 +57,17 @@ The owner can be either a user, or a group of users ([folder](../core_concepts/8
5657

5758
<div class="grid grid-cols-2 gap-6 mb-4">
5859
<DocCard
59-
title="Roles and Permissions"
60-
description="Control access and manage permissions within your instance and workspaces."
61-
href="/docs/core_concepts/roles_and_permissions"
60+
title="Roles and Permissions"
61+
description="Control access and manage permissions within your instance and workspaces."
62+
href="/docs/core_concepts/roles_and_permissions"
6263
color="teal"
63-
/>
64-
<DocCard
65-
title="Groups and Folders"
66-
description="Groups and Folders enable efficient permission management by grouping users with similar access levels."
67-
href="/docs/core_concepts/groups_and_folders"
64+
/>
65+
<DocCard
66+
title="Groups and Folders"
67+
description="Groups and Folders enable efficient permission management by grouping users with similar access levels."
68+
href="/docs/core_concepts/groups_and_folders"
6869
color="teal"
69-
/>
70+
/>
7071
</div>
7172

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

9293
<div class="grid grid-cols-2 gap-6 mb-4">
93-
<DocCard
94-
color="teal"
95-
title="Scheduling"
96-
description="Scheduling allows you to define schedules for Scripts and Flows, automatically running them at set frequencies."
97-
href="/docs/core_concepts/scheduling"
98-
/>
94+
<DocCard
95+
color="teal"
96+
title="Scheduling"
97+
description="Scheduling allows you to define schedules for Scripts and Flows, automatically running them at set frequencies."
98+
href="/docs/core_concepts/scheduling"
99+
/>
99100
</div>
100101

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

131132
<div class="grid grid-cols-2 gap-6 mb-4">
132-
<DocCard
133+
<DocCard
133134
color="teal"
134135
title="Persistent Storage"
135-
description="Ensure that your data is safely stored and easily accessible whenever required."
136-
href="/docs/core_concepts/persistent_storage"
137-
/>
136+
description="Ensure that your data is safely stored and easily accessible whenever required."
137+
href="/docs/core_concepts/persistent_storage"
138+
/>
138139
</div>
139140

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

163164
<video
164-
className="border-2 rounded-xl object-cover w-full h-full dark:border-gray-800"
165-
controls
166-
src="/videos/flow_test_flow.mp4"
165+
className="border-2 rounded-xl object-cover w-full h-full dark:border-gray-800"
166+
controls
167+
src="/videos/flow_test_flow.mp4"
167168
/>
168169

169-
<br/>
170+
<br />
170171

171172
<div class="grid grid-cols-2 gap-6 mb-4">
172173
<DocCard
173-
title="Instant Preview & Testing"
174-
description="Windmill allows users to test what they are building directly from the editor, even before deployment."
175-
href="/docs/core_concepts/instant_preview"
174+
title="Instant Preview & Testing"
175+
description="Windmill allows users to test what they are building directly from the editor, even before deployment."
176+
href="/docs/core_concepts/instant_preview"
176177
color="teal"
177-
/>
178+
/>
178179
</div>
179180

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

349350
<div class="grid grid-cols-2 gap-6 mb-4">
350-
<DocCard
351+
<DocCard
351352
color="teal"
352353
title="Script Editor"
353-
description="In Windmill, Scripts are the basis of all major features."
354-
href="/docs/script_editor"
355-
/>
354+
description="In Windmill, Scripts are the basis of all major features."
355+
href="/docs/script_editor"
356+
/>
356357
</div>
357358

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

408409
<div class="grid grid-cols-2 gap-6 mb-4">
409410
<DocCard
410-
title="Instant Preview & Testing"
411-
description="Windmill allows users to test what they are building directly from the editor, even before deployment."
412-
href="/docs/core_concepts/instant_preview"
411+
title="Instant Preview & Testing"
412+
description="Windmill allows users to test what they are building directly from the editor, even before deployment."
413+
href="/docs/core_concepts/instant_preview"
413414
color="teal"
414-
/>
415+
/>
415416
</div>
416417

417418
#### Advanced
@@ -425,7 +426,7 @@ The advanced section allows to configure the following:
425426
description="Re-try a step in case of error."
426427
href="/docs/flows/retries"
427428
/>
428-
<DocCard
429+
<DocCard
429430
color="teal"
430431
title="Cache for Steps"
431432
description="Re-use a step's previous results."

‎docs/script_editor/customize_arguments.mdx

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -7,23 +7,23 @@ Some arguments' types can be given advanced settings that will affect the inputs
77
Here is an example on how to define a python list as an enum of strings using the `Customize` menu.
88

99
<video
10-
className="border-2 rounded-xl object-cover w-full h-full dark:border-gray-800"
11-
controls
12-
id="main-video"
13-
src="/videos/advanced_parameters_enum.mp4"
10+
className="border-2 rounded-xl object-cover w-full h-full dark:border-gray-800"
11+
controls
12+
id="main-video"
13+
src="/videos/advanced_parameters_enum.mp4"
1414
/>
1515

16-
<br/>
16+
<br />
1717

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

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

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

0 commit comments

Comments
 (0)