Skip to content

Commit eda4755

Browse files
hcourdentrubenfiszel
hcourdent
and
rubenfiszel
authored
typo & small fixes (ready for review) (windmill-labs#94)
* commit message * testing PRs from terminal * Review of all documentation, only Reference page is missing * syntax changed --------- Co-authored-by: Ruben Fiszel <ruben@rubenfiszel.com>
1 parent 79535ec commit eda4755

File tree

31 files changed

+237
-163
lines changed

31 files changed

+237
-163
lines changed

‎docs/advanced/1_self_host/index.md

Lines changed: 9 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ Simplified instruction for docker compose in the
2121

2222
:::warning
2323

24-
Use `docker compose` and not `docker-compose`
24+
Use `docker compose` and not `docker-compose`.
2525

2626
:::
2727

@@ -95,7 +95,7 @@ Database volume is persistent, so updating the database image is safe too.
9595
## Helm Chart
9696

9797
We also provide a convenient [Helm Chart](https://helm.sh/docs/topics/charts/)
98-
for Kubernetes based self-hosted setup.
98+
for Kubernetes based self-hosted set-up.
9999

100100
Detailed instructions can be found in the [README][helm-readme] file in the
101101
[official repository][helm] of the chart.
@@ -105,8 +105,6 @@ Detailed instructions can be found in the [README][helm-readme] file in the
105105
If you're familiar with Helm and want to jump right in, you can deploy quickly
106106
with the snippet below.
107107

108-
Detailed instructions in the official [repository][helm].
109-
110108
```bash
111109
# add the Windmill helm repo
112110
helm repo add windmill https://windmill-labs.github.io/windmill-helm-charts/
@@ -115,6 +113,7 @@ helm install windmill-chart windmill/windmill \
115113
--namespace=windmill \
116114
--create-namespace
117115
```
116+
Detailed instructions in the official [repository][helm].
118117

119118
:::
120119

@@ -125,13 +124,12 @@ additional features. One important feature is better caching for depencies in a
125124
super cache supported by S3.
126125

127126
You need:
127+
- an Enterprise license key
128+
- an AWS account and S3 bucket
129+
- AWS credentials or IAM roles prepared for access from the Windmill worker pods.
130+
<br/>
128131

129-
1. An Enterprise license key
130-
2. An AWS account and S3 bucket
131-
3. AWS credentials or IAM roles prepared for access from the Windmill worker
132-
pods
133-
134-
See the [Helm Chart repository README][helm] for more details. The exact setup
132+
See the [Helm Chart repository README][helm] [repository][helm] for more details. The exact setup
135133
for S3 access will vary according to your environment.
136134

137135
## Compile from source
@@ -142,7 +140,7 @@ for S3 access will vary according to your environment.
142140
npm run generate-backend-client
143141
npm run build
144142
```
145-
2. Install the [LLD Linker](https://lld.llvm.org/)
143+
2. Install the [LLD Linker](https://lld.llvm.org/).
146144
3. Go to `backend` folder ([source][windmill-gh-backend]) and run:
147145
```bash
148146
SQLX_OFFLINE=true cargo build --release

‎docs/advanced/2_setup_oauth/index.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -2,18 +2,18 @@
22

33
## Google login
44

5-
Create Google OAuth keys
5+
**Create Google OAuth keys**
66

77
First, you need to create a Google OAuth Client:
88

99
- Go to https://console.developers.google.com/apis/credentials.
10-
- Click "Create Credentials", then click "OAuth Client ID" in the drop-down menu
10+
- Click "Create Credentials", then click "OAuth Client ID" in the drop-down menu.
1111
- Enter the following:
1212
- Application Type: Web Application
1313
- Name: Windmill
1414
- Authorized Redirect URLs: https://<YOUR_INSTANCE>/login_callback/google
15-
- Click Create
16-
- Copy the **Client ID** and **Client Secret** from the "OAuth Client" modal
15+
- Click Create.
16+
- Copy the **Client ID** and **Client Secret** from the "OAuth Client" modal.
1717
- Edit your `oauth.json` to look like:
1818

1919
```json

‎docs/apps/0_app_editor.md

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Overview
22

3-
Windmill's App editor allows you to build applications. Windmill's App editor has the following major components:
3+
Windmill's App editor allows you to build internal applications. Windmill's App editor has the following major components:
44

55
- [Toolbar](./app_toolbar): configure app settings, toggle preview (desktop/mobile) and debug runs.
66
- [Outputs](./app_outputs): View all components outputs and context
@@ -9,3 +9,6 @@ Windmill's App editor allows you to build applications. Windmill's App editor ha
99
- [Runnable editor](./app-runnable): Create, edit or manage the scripts or flows linked to components (Runnable), and background scripts.
1010

1111
![App Editor](../assets/apps/0_app_editor/plain-app-editor.png)
12+
13+
&nbsp;
14+
You will find more details in the next pages.

‎docs/apps/1_app_toolbar.md

Lines changed: 11 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -15,34 +15,36 @@ The app editor mode can be toggled between `Editor` and `Preview` mode. The prev
1515

1616
Switch the canvas mode in `Mobile` or `Desktop` layout from the toolbar.
1717

18-
### Menu
18+
### Menu `⋮`
1919

20-
The menu allows you to access the following options:
20+
The `⋮` menu allows you to access the following options:
2121

22-
- JSON: View the JSON representation of the app.
23-
- Publish to Hub: Publish the app to the Windmill Hub.
24-
- Hub compatible JSON: View the JSON representation of the app in a format compatible with the Windmill Hub.
22+
- JSON: view the JSON representation of the app.
23+
- Publish to Hub: publish the app to the Windmill Hub.
24+
- Hub compatible JSON: view the JSON representation of the app in a format compatible with the Windmill Hub.
2525

2626
![App Menu](../assets/apps/1_app_toolbar/app-menu.png)
2727

2828
### App inputs configuration
2929

3030
The app inputs menu displays the list of all inputs of each component.
31-
A toggle allows you to only display resources inputs, so you can easily configure your third-party resources of an app imported from the Hub, for example.
31+
A toggle allows you to only display resources inputs, so you can easily configure your third-party resources of an app imported from the Hub, for example:
3232

3333
![App inputs configuration](../assets/apps/1_app_toolbar/app-inputs-configuration.png)
3434

3535
### Debug runs
3636

37+
The app builder allows you to have a look at latests runs to spot potential bugs.
38+
3739
![App debug runs](../assets/apps/1_app_toolbar/app-debug-runs.png)
3840

3941
### Publish
4042

4143
Publish the app as a standalone app, via an URL.
42-
An app can be publish in two ways:
44+
An app can be published in two ways:
4345

44-
- Read-access required: The app can be accessed by anyone who has read access to the app.
45-
- Publish publicly: The app can be accessed by anyone knowing the secret URL. If set to `Publish publicly`, the secret url will be displayed here.
46+
- Read-access required: the app can be accessed by anyone who has read access to the app.
47+
- Publish publicly: the app can be accessed by anyone knowing the secret URL. If set to `Publish publicly`, the secret url will be displayed here.
4648

4749
![App Publish](../assets/apps/1_app_toolbar/app-publish.png)
4850

‎docs/apps/2_app_outputs.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -6,11 +6,11 @@ On the left-hand side of the app editor, you can find the app outputs. Each comp
66

77
For example, the `Table` component has the following outputs:
88

9-
- selectedRow: The selected row as an object.
10-
- loading: The loading state of the table.
11-
- result: The result of the table.
12-
- search: The search value of the table.
13-
- selectedRowIndex: The selected row index.
9+
- selectedRow: the selected row as an object
10+
- loading: the loading state of the table
11+
- result: the result of the table
12+
- search: the search value of the table
13+
- selectedRowIndex: the selected row index
1414

1515
![App outputs](../assets/apps/2_app_outputs/app_outputs.png)
1616

@@ -20,9 +20,9 @@ The outputs are used to quickly visualize the current state of the app.
2020

2121
In addition to the component outputs, the app context is also displayed. The app context contains the following outputs:
2222

23-
- email: The email of the current user.
24-
- username: The username of the current user.
25-
- query: The query parameters of the URL.
23+
- email: the email of the current user
24+
- username: the username of the current user
25+
- query: the query parameters of the URL
2626

2727
### Connecting inputs
2828

‎docs/apps/3_app_canvas.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -9,9 +9,9 @@ The apps are defined by two layouts: `Mobile` and `Desktop`. The layout can be t
99

1010
The header has the following elements:
1111

12-
- A reload button to reload the app.
13-
- A schedule button to schedule the app.
14-
- On behalf of: The user on behalf of which the app is running.
12+
- a reload button to reload the app
13+
- a schedule button to schedule the app
14+
- on behalf of: the user on behalf of which the app is running
1515

1616
## Canvas
1717

‎docs/apps/4_app_component_library.md

Lines changed: 67 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -6,33 +6,58 @@ The app component library is located on the right-hand side of the app editor. I
66

77
Component can be configured in three ways:
88

9-
- **Inputs** : Inputs can be connected to an output or computed using a runnable.
10-
- `Table` component has an input that can be connected to an output or computed using a runnable, which is an array of objects.
11-
- **Configuration** : Property such as the button label, the text input placeholder, etc.
12-
- `Table` component has a configuration property that allows you to configure the search bar: Client-side search, Server-side search, or no search.
9+
- **Inputs**: inputs can be connected to an output or computed using a runnable.
10+
- e.g. `Table` component has an input that can be connected to an output or computed using a runnable, which is an array of objects.
11+
- **Configuration**: property such as the button label, the text input placeholder, etc.
12+
- e.g. `Table` component has a configuration property that allows you to configure the search bar: Client-side search, Server-side search, or no search.
1313

1414
## Component outputs
1515

16-
- **Runnable**: Some component can trigger a runnable when an event occurs, usually when a user interacts with the component. The result of the runnable is stored in the component output in the key `result`. It also stores the `loading` state of the component.
17-
- `Button` component can trigger a runnable when clicked.
16+
- **Runnable**: some component can trigger a runnable when an event occurs, usually when a user interacts with the component. The result of the runnable is stored in the component output in the key `result`. It also stores the `loading` state of the component.
17+
- e.g. `Button` component can trigger a runnable when clicked.
1818
- **Own outputs**: Some component have outputs defined by the component.
19-
- `Table` component has a selectedRow output
19+
- e.g. `Table` component has a selectedRow output
2020

2121
## Inserting components
2222

23-
Click on a component in the component library to insert it in the app canvas.
23+
Click on a component in the component library to insert it in the app canvas. It will be automatically positioned.
2424

2525
## Component list
2626

27-
Windmill provides a set of components that can be used to build apps. Here is the list of the available components:
27+
Windmill provides a set of components that can be used to build apps. Here is the list of the available components (constantly growing according to our users' expectations):
28+
29+
- Button
30+
- Form
31+
- Form Modal
32+
- Text Input
33+
- Password Input
34+
- Number Input
35+
- Slider
36+
- Range
37+
- Date Input
38+
- Toggle
39+
- Select
40+
- HTML
41+
- Vega Lite
42+
- Plotly
43+
- Text
44+
- Table
45+
- Pie Chart
46+
- Bar/Line Chart
47+
- Scatter Chart
48+
- Timeseries
49+
- Result
50+
51+
Below you will find details about each component.
52+
2853

2954
### Button API
3055

3156
The component triggers a runnable when clicked. If the runnable has parameters, they need to be configured in the component configuration.
3257
The runnable parameters are defined:
3358

34-
- **Static**: The parameter is defined in the component configuration.
35-
- **Connected**: The parameter is connected to an output.
59+
- **Static**: the parameter is defined in the component configuration.
60+
- **Connected**: the parameter is connected to an output.
3661

3762
![Button API](../assets/apps/4_app_component_library/button.png)
3863

@@ -58,11 +83,11 @@ The runnable parameters are defined:
5883
The form component allows you to create a form. It has a submit button that triggers a runnable when clicked.
5984
The runnable parameters are defined:
6085

61-
- **Static**: The parameter is defined in the component configuration.
62-
- **User input**: The parameter is defined by the user input.
63-
- **Connected**: The parameter is connected to an output.
86+
- **Static**: the parameter is defined in the component configuration.
87+
- **User input**: the parameter is defined by the user input.
88+
- **Connected**: the parameter is connected to an output.
6489

65-
Only user input are displayed in the form.
90+
Only user inputs are displayed in the form.
6691

6792
![Form API](../assets/apps/4_app_component_library/form.png)
6893

@@ -87,11 +112,11 @@ The form modal component allows you to create a form. It has a submit button tha
87112

88113
The runnable parameters are defined:
89114

90-
- **Static**: The parameter is defined in the component configuration.
91-
- **User input**: The parameter is defined by the user input.
92-
- **Connected**: The parameter is connected to an output.
115+
- **Static**: the parameter is defined in the component configuration.
116+
- **User input**: the parameter is defined by the user input.
117+
- **Connected**: the parameter is connected to an output.
93118

94-
Only user input are displayed in the form in the modal.
119+
Only user inputs are displayed in the form in the modal.
95120

96121
![Form Modal Button](../assets/apps/4_app_component_library/form-modal-button.png)
97122
![Form Modal API](../assets/apps/4_app_component_library/form-modal.png)
@@ -163,7 +188,7 @@ The number input component allows you to get a number from the user.
163188
| Name | Type | Connectable | Templatable | Default | Description |
164189
| ------------- | :----: | :---------: | :---------: | :-----: | ------------------------------------- |
165190
| placeholder | string | false | false | Type... | The number input placeholder. |
166-
| default value | number | true | false | | The default value of the number input |
191+
| default value | number | true | false | | The default value of the number input. |
167192

168193
#### Outputs
169194

@@ -190,6 +215,28 @@ The slider component allows you to get a number from the user.
190215
| ------ | :----: | ----------------- |
191216
| result | number | The slider value. |
192217

218+
219+
### Range API
220+
221+
The slider component allows you to get a range of numbers from the user.
222+
223+
![Range API](../assets/apps/4_app_component_library/range.png)
224+
225+
226+
#### Range configuration
227+
228+
| Name | Type | Connectable | Templatable | Default | Description |
229+
| ---- | :----: | :---------: | :---------: | :-----: | -------------------------------- |
230+
| min | number | false | false | 0 | The minimum value of the range. |
231+
| max | number | false | false | 42 | The maximum value of the range. |
232+
233+
#### Outputs
234+
235+
| Name | Type | Description |
236+
| ------ | :----: | ----------------- |
237+
| result 0 | number | The range bottom value. |
238+
| result 1 | number | The range top value. |
239+
193240
### Date Input API
194241

195242
The date input component allows you to get a date from the user.

‎docs/apps/5_app-runnable.md

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,8 @@
11
# Runnables
22

3-
On the bottom of the app editor, you can find the runnable editor. It allows you to create, edit or manage the scripts or flows linked to components (Runnable), and background scripts.
4-
5-
It holds the following items:
3+
On the bottom of the app editor, you can find the runnable editor. It allows you to create, edit or manage the scripts or flows linked to components (Runnable), and background scripts.
64

5+
You can also fork scripts from :
76
- Inline scripts: scripts that are defined on the app editor, linked to a component.
87
- Workspace/Hub: scripts linked to a component, but defined in the workspace or the Hub.
98
- Background scripts: scripts that are not linked to a component, but run in the background.

‎docs/assets/apps/4_app_component_library/range.png

15 KB
Loading

‎docs/core_concepts/2_variables_and_secrets/index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -52,7 +52,7 @@ visible outside of a script.
5252
## Access a variable from a script
5353

5454
At runtime, all the variables you have access to are set as environment
55-
variables. Easiest way to use a variable in your script is to add it via the UI.
55+
variables. Easiest way to use a variable in your script is to **add it via the UI**.
5656
Click the "+Variable" button in the header row of the editor to open the
5757
variable picker and select the one you need.
5858

0 commit comments

Comments
 (0)