You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/getting_started/00_how_to_use_windmill/index.mdx
+1-10Lines changed: 1 addition & 10 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -4,23 +4,14 @@ import DocCard from '@site/src/components/DocCard';
4
4
5
5
Windmill is a fast, **<ahref="https://github.com/windmill-labs/windmill">open-source</a>** workflow engine and developer platform. It's an alternative to the likes of Retool, Superblocks, n8n, Airflow, Prefect, Kestra and Temporal, designed to **build comprehensive internal tools** (endpoints, workflows, UIs). It supports coding in TypeScript, Python, Go, PHP, Bash, C#, SQL and Rust, or any Docker image, alongside intuitive low-code builders.
6
6
7
-
## Choose Your Setup
7
+
## Choose your setup
8
8
9
9
### Windmill cloud
10
10
11
11
Quickly get started with our [Cloud App](https://app.windmill.dev/), no credit card required. Sign up using GitHub, GitLab, Google, or Microsoft SSO. Start with 1,000 monthly executions on our Community Plan, and easily upgrade for more. [Start with Windmill cloud](https://app.windmill.dev/).
12
12
13
13
Windmill cloud is hosted in the US. We offer dedicated cloud instances in the EU for [Cloud Enterprise](/pricing) customers.
14
14
15
-
<divclassName="grid grid-cols-2 gap-6 mb-4">
16
-
<DocCard
17
-
target="_blank"
18
-
title="Windmill cloud"
19
-
description="Use Windmill's Cloud App (no credit card required)."
20
-
href="https://app.windmill.dev/"
21
-
/>
22
-
</div>
23
-
24
15
### Self-host Windmill
25
16
26
17
For full control over your infrastructure, self-host Windmill using our [helm charts](https://github.com/windmill-labs/windmill-helm-charts) for Kubernetes or docker-compose for simpler setups. [Learn how to self-host Windmill](../../advanced/1_self_host/index.mdx).
Copy file name to clipboardExpand all lines: docs/getting_started/0_scripts_quickstart/10_ansible_quickstart/index.mdx
+5-10Lines changed: 5 additions & 10 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -47,7 +47,7 @@ Scripts are the basic building blocks in Windmill. They can be [run and schedule
47
47
Scripts consist of 2 parts:
48
48
49
49
-[Code](#code-playbook): for Ansible this is a playbook file written in yaml.
50
-
-[Settings](#settings): settings & metadata about the Script such as its path, summary, description, [jsonschema](../../../core_concepts/13_json_schema_and_parsing/index.mdx) of its inputs (inferred from its signature).
50
+
-[Settings](#settings): settings & metadata about the Script such as its path, summary, description, [JSON Schema](../../../core_concepts/13_json_schema_and_parsing/index.mdx) of its inputs (inferred from its signature).
51
51
52
52
When stored in a code repository, these 2 parts are stored separately at `<path>.playbook.yml` and `<path>.script.yaml`
53
53
@@ -59,16 +59,11 @@ When stored in a code repository, these 2 parts are stored separately at `<path>
59
59
60
60
As part of the [settings](../../../script_editor/settings.mdx) menu, each script has metadata associated with it, enabling it to be defined and configured in depth.
61
61
62
-
-**Path** is the Script's unique identifier that consists of the
63
-
[script's owner](../../../core_concepts/16_roles_and_permissions/index.mdx), and the script's name.
64
-
The owner can be either a user, or a group ([folder](../../../core_concepts/8_groups_and_folders/index.mdx#folders)).
65
-
-**Summary** (optional) is a short, human-readable summary of the Script. It
66
-
will be displayed as a title across Windmill. If omitted, the UI will use the `path` by
67
-
default.
62
+
-**Summary** (optional) is a short, human-readable summary of the Script. It will be displayed as a title across Windmill. If omitted, the UI will use the `path` by default.
63
+
-**Path** is the Script's unique identifier that consists of the [script's owner](../../../core_concepts/16_roles_and_permissions/index.mdx), and the script's name. The owner can be either a user, or a group ([folder](../../../core_concepts/8_groups_and_folders/index.mdx#folders)).
64
+
-**Description** is where you can give instructions through the [auto-generated UI](../../../core_concepts/6_auto_generated_uis/index.mdx) to users on how to run your Script. It supports markdown.
68
65
-**Language** of the script.
69
-
-**Description** is where you can give instructions through the [auto-generated UI](../../../core_concepts/6_auto_generated_uis/index.mdx)
70
-
to users on how to run your Script. It supports markdown.
71
-
-**Script kind**: Action (by default), [Trigger](../../../flows/10_flow_trigger.mdx), [Approval](../../../flows/11_flow_approval.mdx) or [Error handler](../../../flows/7_flow_error_handler.md). This acts as a tag to filter appropriate scripts from the [flow editor](../../6_flows_quickstart/index.mdx).
66
+
-**Script kind**: Action (by default), [Trigger](../../../flows/10_flow_trigger.mdx), [Approval](../../../flows/11_flow_approval.mdx), [Error handler](../../../flows/7_flow_error_handler.md) or [Preprocessor](../../../core_concepts/43_preprocessors/index.mdx). This acts as a tag to filter appropriate scripts from the [flow editor](../../6_flows_quickstart/index.mdx).
72
67
73
68
This menu also has additional settings on [Runtime](../../../script_editor/settings.mdx#runtime), [Generated UI](#generated-ui) and [Triggers](../../../script_editor/settings.mdx#triggers).
Copy file name to clipboardExpand all lines: docs/getting_started/0_scripts_quickstart/11_csharp_quickstart/index.mdx
+6-11Lines changed: 6 additions & 11 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -39,30 +39,25 @@ Scripts are the basic building blocks in Windmill. They can be [run and schedule
39
39
Scripts consist of 2 parts:
40
40
41
41
-[Code](#code): for C# scripts, it must have at least a **public** static Main method inside a class (the name of the class is irrelevant).
42
-
-[Settings](#settings): settings & metadata about the Script such as its path, summary, description, [jsonschema](../../../core_concepts/13_json_schema_and_parsing/index.mdx) of its inputs (inferred from its signature).
42
+
-[Settings](#settings): settings & metadata about the Script such as its path, summary, description, [JSON Schema](../../../core_concepts/13_json_schema_and_parsing/index.mdx) of its inputs (inferred from its signature).
43
43
44
44
When stored in a code repository, these 2 parts are stored separately at `<path>.rs` and `<path>.script.yaml`
45
45
46
46
Windmill automatically manages [dependencies](../../../advanced/6_imports/index.mdx) for you. When you import libraries in your C# script, Windmill parses these imports upon saving the script and automatically generates a list of dependencies. It then spawns a dependency job to associate these PyPI packages with a lockfile, ensuring that the same version of the script is always executed with the same versions of its dependencies.
47
47
48
-
From the Home page, click `+Script`. This will take you to the first step of script creation: Metadata.
48
+
From the Home page, click `+Script`. This will take you to the first step of script creation: [Metadata](../../../script_editor/settings.mdx#metadata).
49
49
50
50
## Settings
51
51
52
52

53
53
54
54
As part of the [settings](../../../script_editor/settings.mdx) menu, each script has metadata associated with it, enabling it to be defined and configured in depth.
55
55
56
-
-**Path** is the Script's unique identifier that consists of the
57
-
[script's owner](../../../core_concepts/16_roles_and_permissions/index.mdx), and the script's name.
58
-
The owner can be either a user, or a group ([folder](../../../core_concepts/8_groups_and_folders/index.mdx#folders)).
59
-
-**Summary** (optional) is a short, human-readable summary of the Script. It
60
-
will be displayed as a title across Windmill. If omitted, the UI will use the `path` by
61
-
default.
56
+
-**Summary** (optional) is a short, human-readable summary of the Script. It will be displayed as a title across Windmill. If omitted, the UI will use the `path` by default.
57
+
-**Path** is the Script's unique identifier that consists of the [script's owner](../../../core_concepts/16_roles_and_permissions/index.mdx), and the script's name. The owner can be either a user, or a group ([folder](../../../core_concepts/8_groups_and_folders/index.mdx#folders)).
58
+
-**Description** is where you can give instructions through the [auto-generated UI](../../../core_concepts/6_auto_generated_uis/index.mdx) to users on how to run your Script. It supports markdown.
62
59
-**Language** of the script.
63
-
-**Description** is where you can give instructions through the [auto-generated UI](../../../core_concepts/6_auto_generated_uis/index.mdx)
64
-
to users on how to run your Script. It supports markdown.
65
-
-**Script kind**: Action (by default), [Trigger](../../../flows/10_flow_trigger.mdx), [Approval](../../../flows/11_flow_approval.mdx) or [Error handler](../../../flows/7_flow_error_handler.md). This acts as a tag to filter appropriate scripts from the [flow editor](../../6_flows_quickstart/index.mdx).
60
+
-**Script kind**: Action (by default), [Trigger](../../../flows/10_flow_trigger.mdx), [Approval](../../../flows/11_flow_approval.mdx), [Error handler](../../../flows/7_flow_error_handler.md) or [Preprocessor](../../../core_concepts/43_preprocessors/index.mdx). This acts as a tag to filter appropriate scripts from the [flow editor](../../6_flows_quickstart/index.mdx).
66
61
67
62
This menu also has additional settings on [Runtime](../../../script_editor/settings.mdx#runtime), [Generated UI](#generated-ui) and [Triggers](../../../script_editor/settings.mdx#triggers).
Copy file name to clipboardExpand all lines: docs/getting_started/0_scripts_quickstart/13_java_quickstart/index.mdx
+6-11Lines changed: 6 additions & 11 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -39,27 +39,22 @@ Scripts are the basic building blocks in Windmill. They can be [run and schedule
39
39
Scripts consist of 2 parts:
40
40
41
41
-[Code](#code): for Java scripts, it must have at least a **public** static main method inside a Main class.
42
-
-[Settings](#settings): settings & metadata about the Script such as its path, summary, description, [jsonschema](../../../core_concepts/13_json_schema_and_parsing/index.mdx) of its inputs (inferred from its signature).
42
+
-[Settings](#settings): settings & metadata about the Script such as its path, summary, description, [JSON Schema](../../../core_concepts/13_json_schema_and_parsing/index.mdx) of its inputs (inferred from its signature).
43
43
44
44
45
-
From the Home page, click `+Script`. This will take you to the first step of script creation: Metadata.
45
+
From the Home page, click `+Script`. This will take you to the first step of script creation: [Metadata](../../../script_editor/settings.mdx#metadata).
46
46
47
47
## Settings
48
48
49
49

50
50
51
51
As part of the [settings](../../../script_editor/settings.mdx) menu, each script has metadata associated with it, enabling it to be defined and configured in depth.
52
52
53
-
-**Path** is the Script's unique identifier that consists of the
54
-
[script's owner](../../../core_concepts/16_roles_and_permissions/index.mdx), and the script's name.
55
-
The owner can be either a user, or a group ([folder](../../../core_concepts/8_groups_and_folders/index.mdx#folders)).
56
-
-**Summary** (optional) is a short, human-readable summary of the Script. It
57
-
will be displayed as a title across Windmill. If omitted, the UI will use the `path` by
58
-
default.
53
+
-**Summary** (optional) is a short, human-readable summary of the Script. It will be displayed as a title across Windmill. If omitted, the UI will use the `path` by default.
54
+
-**Path** is the Script's unique identifier that consists of the [script's owner](../../../core_concepts/16_roles_and_permissions/index.mdx), and the script's name. The owner can be either a user, or a group ([folder](../../../core_concepts/8_groups_and_folders/index.mdx#folders)).
55
+
-**Description** is where you can give instructions through the [auto-generated UI](../../../core_concepts/6_auto_generated_uis/index.mdx) to users on how to run your Script. It supports markdown.
59
56
-**Language** of the script.
60
-
-**Description** is where you can give instructions through the [auto-generated UI](../../../core_concepts/6_auto_generated_uis/index.mdx)
61
-
to users on how to run your Script. It supports markdown.
62
-
-**Script kind**: Action (by default), [Trigger](../../../flows/10_flow_trigger.mdx), [Approval](../../../flows/11_flow_approval.mdx) or [Error handler](../../../flows/7_flow_error_handler.md). This acts as a tag to filter appropriate scripts from the [flow editor](../../6_flows_quickstart/index.mdx).
57
+
-**Script kind**: Action (by default), [Trigger](../../../flows/10_flow_trigger.mdx), [Approval](../../../flows/11_flow_approval.mdx), [Error handler](../../../flows/7_flow_error_handler.md) or [Preprocessor](../../../core_concepts/43_preprocessors/index.mdx). This acts as a tag to filter appropriate scripts from the [flow editor](../../6_flows_quickstart/index.mdx).
63
58
64
59
This menu also has additional settings on [Runtime](../../../script_editor/settings.mdx#runtime), [Generated UI](#generated-ui) and [Triggers](../../../script_editor/settings.mdx#triggers).
0 commit comments