Skip to content

Commit 58d7fd2

Browse files
fatonramadanifatonramadani
authored
Fix typos (windmill-labs#423)
* Fix typos * Fix typos
1 parent 068969a commit 58d7fd2

File tree

81 files changed

+1011
-976
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

81 files changed

+1011
-976
lines changed

‎docs/advanced/1_self_host/index.mdx

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ For larger and production use-cases, use our [Helm chart](#helm-chart) to deploy
1515

1616
> Example of self-hosted Windmill on [localhost](#docker).
1717
18-
<br/>
18+
<br />
1919

2020
Windmill itself just requires 3 elements:
2121

@@ -287,7 +287,7 @@ docker compose pull windmill_server
287287
docker compose up -d
288288
```
289289

290-
Database volume is persistent, so updating the database image is safe too. Windmill provides graceful exit for jobs in workers so it will not interrumpt current jobs unless they are longer than docker stop hard kill timeout (30 seconds).
290+
Database volume is persistent, so updating the database image is safe too. Windmill provides graceful exit for jobs in workers so it will not interrupt current jobs unless they are longer than docker stop hard kill timeout (30 seconds).
291291

292292
It is sufficient to run `docker compose up -d` again if your Docker is already running detached, since it will pull the latest `:main` version and restart the containers.
293293
NOTE: The previous images are not removed automatically, you should also run `docker builder prune` to clear old versions.
@@ -386,7 +386,7 @@ GRANT USAGE ON SCHEMA public TO windmill_user;
386386

387387
### Complete New Windmill Set-Up
388388

389-
In the Admin Workspace execute the New User Setup App. This will import the default [resources types](../../core_concepts/3_resources_and_types/index.mdx) from [WindmillHub](https://hub.windmill.dev/) and update the default user credentails
389+
In the Admin Workspace execute the New User Setup App. This will import the default [resources types](../../core_concepts/3_resources_and_types/index.mdx) from [WindmillHub](https://hub.windmill.dev/) and update the default user credentials
390390

391391
### Authentication and user management
392392

@@ -473,7 +473,7 @@ Fill your SMTP details.
473473

474474
**Note**: If you're using Gmail, you'll need to [generate an App Password](https://support.google.com/accounts/answer/185833?hl=en) to use as `SMTP_PASSWORD`. This is a unique password that Gmail provides for apps and services that want to connect to your account.
475475

476-
You'll be offered to "Test SMTP settings" & send a blank e-mail to a given adress.
476+
You'll be offered to "Test SMTP settings" & send a blank e-mail to a given address.
477477

478478
![Filled SMTP](./smtp_filled.png 'Filled SMTP')
479479

‎docs/advanced/2_clients/python_client.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -87,4 +87,4 @@ The `JobStatus` class is an enumeration that represents the different states of
8787
- `RUNNING`: Represents a job that is currently running.
8888
- `WAITING`: Represents a job that is queued and waiting to be executed.
8989

90-
The `JobStatus` enumeration is useful when retrieving the status of a job using the `get_job_status` method.
90+
The `JobStatus` enumeration is useful when retrieving the status of a job using the `get_job_status` method.

‎docs/advanced/2_clients/ts_client.mdx

Lines changed: 7 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -15,14 +15,14 @@ Once Deno/Bun is installed, you can import the `windmill` module directly from t
1515
<TabItem value="deno" label="TypeScript (Deno)" attributes={{className: "text-xs p-4 !mt-0 !ml-0"}}>
1616

1717
```typescript
18-
import * as wmill from 'https://deno.land/x/windmill/mod.ts'
18+
import * as wmill from 'https://deno.land/x/windmill/mod.ts';
1919
```
2020

2121
</TabItem>
2222
<TabItem value="bun" label="TypeScript (Bun)" attributes={{className: "text-xs p-4 !mt-0 !ml-0"}}>
2323

2424
```typescript
25-
import * as wmill from "windmill-client@1.147.3"
25+
import * as wmill from 'windmill-client@1.147.3';
2626
```
2727

2828
</TabItem>
@@ -36,26 +36,25 @@ The TypeScript client provides several functions that you can use to interact wi
3636
<TabItem value="deno" label="TypeScript (Deno)" attributes={{className: "text-xs p-4 !mt-0 !ml-0"}}>
3737

3838
```typescript
39-
import * as wmill from 'https://deno.land/x/windmill/mod.ts'
39+
import * as wmill from 'https://deno.land/x/windmill/mod.ts';
4040

4141
export async function main() {
42-
let x = await wmill.getResource('u/user/name')
42+
let x = await wmill.getResource('u/user/name');
4343
}
4444
```
4545

4646
</TabItem>
4747
<TabItem value="bun" label="TypeScript (Bun)" attributes={{className: "text-xs p-4 !mt-0 !ml-0"}}>
4848

4949
```typescript
50-
import * as wmill from "windmill-client@1.147.3"
50+
import * as wmill from 'windmill-client@1.147.3';
5151

5252
export async function main() {
53-
let x = await wmill.getResource('u/user/name')
53+
let x = await wmill.getResource('u/user/name');
5454
}
5555
```
5656

5757
</TabItem>
5858
</Tabs>
5959

60-
61-
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.
60+
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.

‎docs/advanced/3_cli/index.mdx

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -6,16 +6,16 @@ The Windmill CLI, `wmill` allows you to interact with Windmill instances right f
66
terminal.
77

88
<iframe
9-
style={{ aspectRatio: '16/9' }}
10-
src="https://www.youtube.com/embed/w2HVTlR2QDI?vq=hd1080"
11-
title="YouTube video player"
12-
frameBorder="0"
13-
allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture; web-share"
14-
allowFullScreen
15-
className="border-2 rounded-xl object-cover w-full dark:border-gray-800"
9+
style={{ aspectRatio: '16/9' }}
10+
src="https://www.youtube.com/embed/w2HVTlR2QDI?vq=hd1080"
11+
title="YouTube video player"
12+
frameBorder="0"
13+
allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture; web-share"
14+
allowFullScreen
15+
className="border-2 rounded-xl object-cover w-full dark:border-gray-800"
1616
></iframe>
1717

18-
<br/>
18+
<br />
1919

2020
You can also use it for various automation tasks, including
2121
[syncing](./sync.mdx) folders &
@@ -29,7 +29,7 @@ See [Installation](./installation.md) for getting started.
2929
description="How to install the CLI"
3030
href="/docs/advanced/cli/installation"
3131
/>
32-
<DocCard
32+
<DocCard
3333
title="Local Development"
3434
description="Develop from various environments such as your terminal, VS Code, and JetBrains IDEs."
3535
href="/docs/advanced/local_development"

‎docs/advanced/3_cli/sync.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ Synchronizing folders & git repositories to a Windmill instance is made easy
66
using the wmill CLI. Syncing operations are behind the `wmill sync` subcommand.
77

88
Having a Windmill instance synchronized to folders & git repositories allows for
9-
local devlopment through the [VS Codeextension](../../cli_local_dev/1_vscode-extension/index.mdx).
9+
local development through the [VS Codeextension](../../cli_local_dev/1_vscode-extension/index.mdx).
1010

1111
<div class="grid grid-cols-2 gap-6 mb-4">
1212
<DocCard
@@ -38,7 +38,7 @@ updating the remote equivalents.
3838

3939
## Stateful Syncing
4040

41-
Stateful syncing is best used when you want to continuously syncronize a folder
41+
Stateful syncing is best used when you want to continuously synchronize a folder
4242
or git(hub) repository with a Windmill instance. The CLI will automatically
4343
maintain state for you and ensure modifications that happen concurrently on the
4444
remote and locally stay in sync.

‎docs/advanced/4_local_development/index.mdx

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -19,14 +19,14 @@ Local development in Windmill (whether [self-hosted](../1_self_host/index.mdx) o
1919
description="Build scripts and flows in the comfort of your VS Code Editor, while leveraging Windmill UIs for test & flows edition."
2020
href="/docs/cli_local_dev/vscode-extension"
2121
/>
22-
<DocCard
22+
<DocCard
2323
title="Run Locally"
2424
description="Run scripts locally that interact with a Windmill instance."
2525
href="/docs/advanced/local_development/run_locally"
2626
/>
27-
<DocCard
27+
<DocCard
2828
title="Command-Line Interface (CLI)"
2929
description="Interact with Windmill instances right from your terminal."
3030
href="/docs/advanced/cli"
3131
/>
32-
</div>
32+
</div>

‎docs/advanced/4_local_development/run_locally.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@ To get started with local development and use `git` to version your scripts, ins
2525
description="Interact with Windmill instances right from your terminal."
2626
href="/docs/advanced/cli"
2727
/>
28-
<DocCard
28+
<DocCard
2929
title="Local Development"
3030
description="Develop from various environments such as your terminal, VS Code, and JetBrains IDEs."
3131
href="/docs/advanced/local_development"
@@ -61,7 +61,7 @@ You should see all your scripts, flows, apps inside the folder.
6161

6262
You can now edit the files directly as shown below.
6363

64-
Once you have finished developement, you can either [push the files directly to your remote](#pushing-your-scripts-to-windmill) or setup [GitHub action to push changes to your workspace on commit](https://github.com/windmill-labs/windmill-sync-example).
64+
Once you have finished development, you can either [push the files directly to your remote](#pushing-your-scripts-to-windmill) or setup [GitHub action to push changes to your workspace on commit](https://github.com/windmill-labs/windmill-sync-example).
6565

6666
## Deno / Bun
6767

‎docs/advanced/5_sharing_common_logic/index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
It is common to want to share common logic between your scripts. This can be done easily using relative imports in both Python and Deno.
44

5-
Note that in both the webeditor and with the CLI, your scripts do not necessarily need to have a main function. If they don't, they are asummed to be shared logic and not runnable scripts.
5+
Note that in both the webeditor and with the CLI, your scripts do not necessarily need to have a main function. If they don't, they are assumed to be shared logic and not runnable scripts.
66

77
It works extremely well in combination with [Developing scripts locally](../4_local_development/index.mdx) and you can easily sync your scripts with the [CLI](../3_cli/index.mdx).
88

‎docs/advanced/6_imports/index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ On the [enterprise edition](../../misc/7_plans_details/index.mdx), Windmill's ca
88

99
:::info
1010

11-
To import other scripts from your workpace, see [Sharing common logic](../5_sharing_common_logic/index.md).
11+
To import other scripts from your workspace, see [Sharing common logic](../5_sharing_common_logic/index.md).
1212

1313
:::
1414

‎docs/advanced/7_docker/index.mdx

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@ In the charts values of our [helm charts](https://github.com/windmill-labs/windm
3131

3232
### Remote Docker Daemon
3333

34-
One possibility to use the docker daemon wiht k8s with containerd is to run a docker daemon in the same pod using "Docker-in-Docker" ( dind) Using the official image `docker:stable-dind`:
34+
One possibility to use the docker daemon with k8s with containerd is to run a docker daemon in the same pod using "Docker-in-Docker" ( dind) Using the official image `docker:stable-dind`:
3535

3636
Here an example of a dind template to be adapted:
3737

@@ -42,13 +42,13 @@ metadata:
4242
name: dind
4343
spec:
4444
containers:
45-
- name: dind
46-
image: 'docker:stable-dind'
47-
command:
48-
- dockerd
49-
- --host=tcp://0.0.0.0:8000
50-
securityContext:
51-
privileged: true
45+
- name: dind
46+
image: 'docker:stable-dind'
47+
command:
48+
- dockerd
49+
- --host=tcp://0.0.0.0:8000
50+
securityContext:
51+
privileged: true
5252
```
5353
5454
## Use
@@ -73,9 +73,9 @@ The image is the docker image to run. It can be any image available on docker hu
7373

7474
The command is the command to run inside the container. It can be any command available in the image.
7575

76-
It is just a bash script so it will behave exactly the same as a local command or if running this as an ssh command on the host. As a consequence, you can use any strategy to cache docker images or handle authentification.
76+
It is just a bash script so it will behave exactly the same as a local command or if running this as an ssh command on the host. As a consequence, you can use any strategy to cache docker images or handle authentication.
7777

78-
Do not use the deamon mode `-d` otherwise the script will immediately return while the container continue to run in the background. However, in some cases, that might be what you want.
78+
Do not use the daemon mode `-d` otherwise the script will immediately return while the container continue to run in the background. However, in some cases, that might be what you want.
7979

8080
Like any bash script, it will return the last line of the stdout. So be sure to print the the return value from your command if you'd like to use it as a result.
8181

@@ -118,6 +118,6 @@ latest: Pulling from library/alpine
118118
7264a8db6415: Pull complete
119119
Digest: sha256:7144f7bab3d4c2648d7e59409f15ec52a18006a128c733fcff20d3a4a54ba44a
120120
Status: Downloaded newer image for alpine:latest
121-
Hello
121+
Hello
122122
+ exit 0
123123
```

0 commit comments

Comments
 (0)