Skip to content

Commit ae3ad77

Browse files
authored
Fix requirements python template and link to short demo (windmill-labs#603)
* Fix requirements python template and link to short demo * Video App Editor & Note of intent
1 parent c4618ee commit ae3ad77

File tree

12 files changed

+70
-74
lines changed

12 files changed

+70
-74
lines changed

docs/advanced/2_clients/ts_client.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -59,4 +59,4 @@ export async function main() {
5959

6060
In the example above, the `getResource` function is used to retrieve a resource with the path `'u/user/name'` from the Windmill platform. The returned resource can be further processed or used as needed in your application.
6161

62-
For more details and documentation on the client, you can visit [jsr.io/@windill/windmill](https://jsr.io/@windmill/windmill), although jsr.io is not supported for actual package imports yet.
62+
For more details and documentation on the client, you can visit [https://jsr.io/@windmill/windmill](https://jsr.io/@windmill/windmill), although jsr.io is not supported for actual package imports yet.

docs/apps/0_app_editor/index.mdx

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -21,6 +21,18 @@ The app editor is a low-code builder to create custom User Interfaces with a mix
2121
/>
2222
</div>
2323

24+
If you're more into videos, you can check out our tutorial on the App Editor:
25+
26+
<iframe
27+
style={{ aspectRatio: '16/9' }}
28+
src="https://www.youtube.com/embed/lxqdncP8XR4"
29+
title="App Editor Tutorial"
30+
frameBorder="0"
31+
allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture; web-share"
32+
allowFullScreen
33+
className="border-2 rounded-xl object-cover w-full dark:border-gray-800"
34+
></iframe>
35+
2436
<br />
2537

2638
The app editor is composed of 6 main sections:

docs/core_concepts/11_persistent_storage/large_data_files.mdx

Lines changed: 0 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -106,8 +106,6 @@ export async function main(input_file: S3Object) {
106106
<TabItem value="python" label="Python" attributes={{className: "text-xs p-4 !mt-0 !ml-0"}}>
107107

108108
```python
109-
#requirements:
110-
wmill>=1.251.7
111109
import wmill
112110
from wmill import S3Object
113111

@@ -173,8 +171,6 @@ export async function main(s3_file_path: string) {
173171
<TabItem value="python" label="Python" attributes={{className: "text-xs p-4 !mt-0 !ml-0"}}>
174172

175173
```python
176-
#requirements:
177-
wmill>=1.251.7
178174
import wmill
179175
from wmill import S3Object
180176

docs/core_concepts/27_data_pipelines/index.mdx

Lines changed: 0 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -128,8 +128,6 @@ export async function main(input_file: S3Object) {
128128
<TabItem value="python" label="Python" attributes={{className: "text-xs p-4 !mt-0 !ml-0"}}>
129129

130130
```python
131-
#requirements:
132-
#wmill>=1.251.7
133131
import wmill
134132
from wmill import S3Object
135133

@@ -195,8 +193,6 @@ export async function main(s3_file_path: string) {
195193
<TabItem value="python" label="Python" attributes={{className: "text-xs p-4 !mt-0 !ml-0"}}>
196194

197195
```python
198-
#requirements:
199-
#wmill>=1.251.7
200196
import wmill
201197
from wmill import S3Object
202198

Binary file not shown.
Binary file not shown.

docs/getting_started/7_apps_quickstart/index.mdx

Lines changed: 21 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -5,9 +5,17 @@ import { useColorMode } from '@docusaurus/theme-common';
55

66
Welcome to the Apps Quickstart! This page will provide you with the necessary knowledge to build your first applications in a matter of minutes.
77

8-
![Example of an app in Windmill App Editor](./github_app.png 'Example of an app in Windmill App Editor')
9-
10-
> Example of an app built with Windmill App Editor.
8+
If you're more into videos, you can check out our tutorial on the App Editor:
9+
10+
<iframe
11+
style={{ aspectRatio: '16/9' }}
12+
src="https://www.youtube.com/embed/lxqdncP8XR4"
13+
title="App Editor Tutorial"
14+
frameBorder="0"
15+
allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture; web-share"
16+
allowFullScreen
17+
className="border-2 rounded-xl object-cover w-full dark:border-gray-800"
18+
></iframe>
1119

1220
<br />
1321

@@ -33,7 +41,7 @@ Although Windmill provides [auto-generated UIs to scripts and flows](../../core_
3341
/>
3442
</div>
3543

36-
**Windmill applications are customized UIs to interact with datasources** (web, internal, data providers, etc). They are a great way to have non-technical users interact with custom-made workflows.
44+
Windmill applications are customized UIs to interact with datasources (web, internal, data providers, etc). They are a great way to have non-technical users interact with custom-made workflows.
3745

3846
In short, what you need to remember about apps:
3947

@@ -53,9 +61,9 @@ From <a href="https://app.windmill.dev/" rel="nofollow">Windmill</a>, click on `
5361

5462
### Toolbar
5563

56-
Before jumping in, you should decide if you want to build a **Desktop** or a **Mobile** app. Just click on the appropriated icon on top.
64+
Before jumping in, you should decide if you want to build a Desktop or a Mobile app. Just click on the appropriated icon on top.
5765

58-
Switch from **Editor** to **Preview** mode to take a step back on what you're building.
66+
Switch from Editor to Preview mode to take a step back on what you're building.
5967

6068
![Toolbar](./toolbar.png.webp)
6169

@@ -70,9 +78,9 @@ Switch from **Editor** to **Preview** mode to take a step back on what you're bu
7078

7179
### Components
7280

73-
The App editor works on a drag-and-drop basis. From the right-side menu, click on a component to **create** it on the [canvas](../../apps/1_canvas.mdx), **move** it maintaining a click on it and **delete** it clicking on `Delete component` at the bottom of the `Settings` tab. You can resize your components by dragging the **resize** handler on the bottom-right corner.
81+
The App editor works on a drag-and-drop basis. From the right-side menu, click on a component to create it on the [canvas](../../apps/1_canvas.mdx), move it maintaining a click on it and delete it clicking on `Delete component` at the bottom of the `Settings` tab. You can resize your components by dragging the resize handler on the bottom-right corner.
7482

75-
If you have numerous components you might need to **Anchor** some of them to have them unmovable by other components.
83+
If you have numerous components you might need to Anchor some of them to have them unmovable by other components.
7684

7785
<video
7886
className="border-2 rounded-xl object-cover w-full h-full dark:border-gray-800"
@@ -82,7 +90,7 @@ If you have numerous components you might need to **Anchor** some of them to hav
8290

8391
<br />
8492

85-
Check out all of our components at [this page](../../apps/4_app_configuration_settings/1_app_component_library.mdx) or (better) directly from the app editor. Know that **we can quickly add components to the library**, just [reach out to us](../../misc/6_getting_help/index.mdx).
93+
Check out all of our components at [this page](../../apps/4_app_configuration_settings/1_app_component_library.mdx) or (better) directly from the app editor. Know that we can quickly add components to the library, just [reach out to us](../../misc/6_getting_help/index.mdx).
8694

8795
<div className="grid grid-cols-2 gap-6 mb-4">
8896
<DocCard
@@ -111,7 +119,7 @@ From a component, click on `Create an inline script` or `Select a script or flow
111119

112120
![App Runnables panel](../../assets/apps/0_app_editor/app-runnable-panel.png.webp)
113121

114-
The **[Outputs](../../apps/2_outputs.mdx)** of each component can be found on the left side menu. Each of them is associated with a component (see the component id).
122+
The [Outputs](../../apps/2_outputs.mdx) of each component can be found on the left side menu. Each of them is associated with a component (see the component id).
115123

116124
![App Outputs](../../assets/apps/0_app_editor/app-outputs.png.webp)
117125

@@ -134,7 +142,7 @@ The **[Outputs](../../apps/2_outputs.mdx)** of each component can be found on th
134142
/>
135143
</div>
136144

137-
At any time, have a look at your app's **Inputs** associated with each component on the dedicated `App inputs` tab found in the `` menu of the toolbar.
145+
At any time, have a look at your app's Inputs associated with each component on the dedicated `App inputs` tab found in the `` menu of the toolbar.
138146

139147
![Apps inputs](./apps_inputs.png.webp)
140148

@@ -155,11 +163,11 @@ At any time, have a look at your app's **Inputs** associated with each component
155163

156164
### Tailor the look of your app
157165

158-
At the **[component level](../../apps/4_app_configuration_settings/4_app_styling.mdx#component-level)**, on the `Settings` tab, configure the style of each component (color, size, label, etc.) either directly in the boxes or using Custom CSS (on the Component Settings - Styling tab).
166+
At the [component level](../../apps/4_app_configuration_settings/4_app_styling.mdx#component-level), on the `Settings` tab, configure the style of each component (color, size, label, etc.) either directly in the boxes or using Custom CSS (on the Component Settings - Styling tab).
159167

160168
![Customize components](./customize_component.png.webp)
161169

162-
At the **[app level](../../apps/4_app_configuration_settings/4_app_styling.mdx#global-styling)**, you can give a harmonized style to your app with CSS. On the `Global Styling` tab, give details in boxes or in JSON, for the whole app and per class of component.
170+
At the [app level](../../apps/4_app_configuration_settings/4_app_styling.mdx#global-styling), you can give a harmonized style to your app with CSS. On the `Global Styling` tab, give details in boxes or in JSON, for the whole app and per class of component.
163171

164172
![App styling](./customize_app.png.webp)
165173

docs/intro.mdx

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
import DocCard from '@site/src/components/DocCard';
2-
import { Book, Pen, Home, Cloud, Terminal } from 'lucide-react';
2+
import { Book, Pen, Home, Cloud, Terminal, Play } from 'lucide-react';
33

44
# What is Windmill?
55

@@ -24,6 +24,12 @@ Boilerplate code is eliminated as Windmill takes care of the repetitive work of
2424
title="Getting Started"
2525
description="Get started in 30 seconds."
2626
href="/docs/getting_started/how_to_use_windmill"
27+
Icon={Play}
28+
/>
29+
<DocCard
30+
title="Note of Intent"
31+
description="The why and how of Windmill."
32+
href="/docs/misc/note_of_intent"
2733
Icon={Book}
2834
/>
2935
</div>

docs/misc/0_note_of_intent/index.md

Lines changed: 14 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -15,17 +15,17 @@ All code is not made equal and can be split in 2 categories:
1515
code is boilerplate because it _feels_ like you shouldn't have to reinvent the
1616
wheel, over and over again.
1717

18-
Many services labels themselves as **no-code** or **low-code**, as they address
18+
Many services labels themselves as **no-code** or low-code, as they address
1919
indeed the challenge of getting rid of the boilerplate and provide a
2020
comprehensive platform accessible to all members of a diverse organization not
21-
made solely of engineers. However, **we believe they lack the full power and
21+
made solely of engineers. However, **we believe they lack the full power and
2222
flexibility of code** as they either hide it completely, or only allow it under
2323
restricted forms.
2424

2525
Windmill is different:
2626

27-
- Windmill is an [open-source](https://github.com/windmill-labs/windmill) developer platform and infra to turn scripts (TypeScript, Python, Go, Bash, SQL) into endpoints, workflows and UIs. In that respect, Windmill is an alternative to Retool, Airplane and n8n.
28-
- It **empowers semi-technical users** to access and edit that code without
27+
- Windmill is an [open-source](https://github.com/windmill-labs/windmill) developer platform and infra to turn scripts (TypeScript, Python, Go, Bash, SQL) into endpoints, workflows and UIs. In that respect, Windmill is an alternative to Retool, Prefect and n8n.
28+
- It empowers semi-technical users to access and edit that code without
2929
being overwhelmed by the usual barriers to entry (git, IDE, local
3030
environments, secrets managements, etc).
3131
- It is compatible with senior/staff software engineers **high standards for
@@ -43,9 +43,9 @@ Windmill embeds:
4343
minimal cold start
4444
- a **parser that will infer the dependencies and arguments** from the code
4545
itself and generate lockfiles and input specs
46-
- the _lockfile_ allows the script being deployed to maintain exactly the same
46+
- the _[lockfile](../../advanced/6_imports/index.mdx)_ allows the script being deployed to maintain exactly the same
4747
set of versioned dependencies forever
48-
- the in _input spec_ (which is actually a JSON schema) is used to generate a
48+
- the _[input spec](../../core_concepts/13_json_schema_and_parsing/index.md)_ (which is actually a JSON schema) is used to generate a
4949
minimal UI automatically for both using the script as a standalone compute
5050
or as a step of a Flow
5151
- a powerful **web IDE** to write Scripts with autocompletion and syntax
@@ -78,8 +78,7 @@ Windmill embeds:
7878
Flows. Combined with state storage, it can be used to watch for external
7979
events - for example triggering a Flow only if the external state is different
8080
from the one stored previously
81-
- a **[CLI](../../advanced/3_cli/index.mdx)** and GitHub Actions for **GitHub** and local
82-
based development and code management.
81+
- a **[CLI](../../advanced/3_cli/index.mdx)** and [Git Sync](../../advanced/11_git_sync/index.mdx) to automatically commit and push scripts, flows, and apps to a given repository.
8382

8483
On top of all these, you'll get an active [community](https://discord.com/invite/V7PM2YHsPB) and a responsive support
8584
team to attend you in your journey.
@@ -105,7 +104,7 @@ You can find plenty of examples and inspirations on the
105104
- Running scripts on a production-grade infra that is cost-efficient, reliable
106105
and easily monitorable takes a lot of **skill and time to do right**.
107106

108-
**Windmill solves those problems**, and makes sure that scripts become widely
107+
Windmill solves those problems, and makes sure that scripts become widely
109108
useful tools. The central tenet is: _make building automation fast and easy, and
110109
everybody will automate repetitive tasks and save a lot of time_.
111110

@@ -117,14 +116,14 @@ same time. Some other very interesting frameworks that Windmill shares overlap
117116
with:
118117

119118
- _Temporal_ and _Airflow_ for the workflow engine, both open-source. They are
120-
both **heavily code-based**, have **no low-code builders** for the flows, are
121-
**complex to set up** and operate, and do not allow to share scripts easily or
119+
both heavily code-based, have no low-code builders for the flows, are
120+
complex to set up and operate, and do not allow to share scripts easily or
122121
build UIs.
123-
- _Retool_ for building **admin panels**, and its other open-source
122+
- _Retool_ for building admin panels, and its other open-source
124123
alternatives: _Tooljet_, _Appsmith_.
125-
- _Airplane_ and _Superblocks_ have comparable set of features, but **not
126-
open-source nor self-hostable**, **limited workflow** engines, **not made for
127-
scalability** and have **no open APIs**.
124+
- _Airplane_ and _Superblocks_ have comparable set of features, but not
125+
open-source nor self-hostable, limited workflow engines, not made for
126+
scalability and have no open APIs.
128127

129128
You will find more details on our view over our space and competitors in the
130129
[Windmill compared to competitors](../../compared_to/peers.mdx) page.

docs/misc/9_guides/index.mdx

Lines changed: 0 additions & 26 deletions
This file was deleted.

0 commit comments

Comments
 (0)