From 0b3e68e0a4cf1d616b9be35cbbc663239861cf93 Mon Sep 17 00:00:00 2001 From: Ruben Fiszel Date: Sat, 24 Jun 2023 19:31:29 +0200 Subject: [PATCH] docs -> www --- README.md | 8 ++-- backend/windmill-api/openapi.yaml | 4 +- backend/windmill-api/src/oauth2.rs | 14 ++++++- cli/README.md | 6 ++- frontend/src/lib/components/AppConnect.svelte | 2 +- frontend/src/lib/components/EditorBar.svelte | 8 ++-- frontend/src/lib/components/Path.svelte | 2 +- .../src/lib/components/SchemaEditor.svelte | 2 +- frontend/src/lib/components/SchemaForm.svelte | 2 +- .../src/lib/components/ScriptBuilder.svelte | 12 +++--- .../src/lib/components/ScriptEditor.svelte | 2 +- .../apps/editor/AppEditorHeader.svelte | 2 +- .../EmptyInlineScript.svelte | 2 +- .../InlineScriptsPanelList.svelte | 2 +- .../editor/settingsPanel/Recompute.svelte | 2 +- .../components/flows/CreateActionsApp.svelte | 2 +- .../flows/content/FlowInputs.svelte | 8 ++-- .../components/flows/content/FlowLoop.svelte | 2 +- .../flows/content/FlowModuleCache.svelte | 2 +- .../flows/content/FlowModuleEarlyStop.svelte | 2 +- .../flows/content/FlowModuleSleep.svelte | 2 +- .../flows/content/FlowModuleSuspend.svelte | 2 +- .../flows/content/FlowRetries.svelte | 2 +- .../flows/content/FlowSettings.svelte | 10 ++--- .../components/sidebar/SidebarContent.svelte | 2 +- frontend/src/lib/consts.ts | 42 ++++++++++++++----- .../src/lib/init_scripts/python_init_code.ts | 2 +- frontend/src/lib/script_helpers.ts | 2 +- .../(logged)/flows/get/[...path]/+page.svelte | 2 +- .../(root)/(logged)/folders/+page.svelte | 2 +- .../(root)/(logged)/groups/+page.svelte | 2 +- .../(root)/(logged)/resources/+page.svelte | 4 +- .../(logged)/runs/[...path]/+page.svelte | 2 +- .../(root)/(logged)/schedules/+page.svelte | 2 +- .../(logged)/user/(user)/login/+page.svelte | 4 +- .../(root)/(logged)/variables/+page.svelte | 2 +- .../(root)/(logged)/workers/+page.svelte | 2 +- openflow.openapi.yaml | 2 +- python-client/wmill/pyproject.toml | 2 +- python-client/wmill_pg/pyproject.toml | 2 +- 40 files changed, 105 insertions(+), 73 deletions(-) diff --git a/README.md b/README.md index f6503ff900..a3d17e2262 100644 --- a/README.md +++ b/README.md @@ -33,7 +33,7 @@ Scripts are turned into UIs and no-code modules, no-code modules can be composed

- Try it - Docs - Discord - Hub - Contributor's guide + Try it - Docs - Discord - Hub - Contributor's guide

# Windmill - Turn scripts into workflows and UIs that you can share and run at scale @@ -137,7 +137,7 @@ instance from local commands. See You can run your script locally easily, you simply need to pass the right environment variables for the `wmill` client library to fetch resources and variables from your instance if necessary. See more: -. +. ## Stack @@ -194,7 +194,7 @@ back to the database is ~50ms. A typical lightweight deno job will take around We only provide docker-compose setup here. For more advanced setups, like compiling from source or using without a postgres super user, see -[documentation](https://docs.windmill.dev/docs/advanced/self_host). +[documentation](https://www.windmill.dev/docs/advanced/self_host). ### Docker compose @@ -267,7 +267,7 @@ rights. [The list of all possible "connect an app" oauth clients](https://github.com/windmill-labs/windmill/blob/main/backend/oauth_connect.json) To add more "connect an app" OAuth clients to the Windmill project, read the -[Contributor's guide](https://docs.windmill.dev/docs/misc/contributing). We +[Contributor's guide](https://www.windmill.dev/docs/misc/contributing). We welcome contributions! You may also add your own custom OAuth2 IdP and OAuth2 Resource provider: diff --git a/backend/windmill-api/openapi.yaml b/backend/windmill-api/openapi.yaml index 2a2ec4d9d3..ca26fb25b9 100644 --- a/backend/windmill-api/openapi.yaml +++ b/backend/windmill-api/openapi.yaml @@ -14,10 +14,10 @@ info: url: https://www.apache.org/licenses/LICENSE-2.0.html x-logo: - url: https://docs.windmill.dev/img/windmill.svg + url: https://windmill.dev/img/windmill.svg externalDocs: description: documentation portal - url: https://docs.windmill.dev + url: https://windmill.dev servers: - url: /api diff --git a/backend/windmill-api/src/oauth2.rs b/backend/windmill-api/src/oauth2.rs index c30488c5d8..b6ee665c03 100644 --- a/backend/windmill-api/src/oauth2.rs +++ b/backend/windmill-api/src/oauth2.rs @@ -415,7 +415,12 @@ async fn connect_slack(cookies: Cookies) -> error::Result { let mut client = OAUTH_CLIENTS .slack .as_ref() - .ok_or_else(|| error::Error::BadRequest("slack client not setup. See: https://docs.windmill.dev/docs/misc/setup_oauth#slack".to_string()))? + .ok_or_else(|| { + error::Error::BadRequest( + "slack client not setup. See: https://www.windmill.dev/docs/misc/setup_oauth#slack" + .to_string(), + ) + })? .to_owned(); let state = State::new_random(); @@ -616,7 +621,12 @@ async fn connect_slack_callback( let client = OAUTH_CLIENTS .slack .as_ref() - .ok_or_else(|| error::Error::BadRequest("slack client not setup. See: https://docs.windmill.dev/docs/misc/setup_oauth#slack".to_string()))? + .ok_or_else(|| { + error::Error::BadRequest( + "slack client not setup. See: https://www.windmill.dev/docs/misc/setup_oauth#slack" + .to_string(), + ) + })? .to_owned(); let token = exchange_code::(callback, &cookies, client, &HTTP_CLIENT, None).await?; diff --git a/cli/README.md b/cli/README.md index d1a128dfd3..f4fcc167f5 100644 --- a/cli/README.md +++ b/cli/README.md @@ -3,7 +3,8 @@ A simple CLI allowing interactions with windmill from the command line. ![](./vhs/output/setup.gif) -You can find more information in [Windmill Docs](https://docs.windmill.dev/docs/advanced/cli) +You can find more information in +[Windmill Docs](https://www.windmill.dev/docs/advanced/cli) ## Installation @@ -20,7 +21,8 @@ workspace settings. ## Running Flows & Scripts Run a script or flow using `wmill flow/script run u/username/path/to/script` and -pass any inputs using `--data` + Inputs specified as a JSON string or a file using `@ ` or stdin using @-. +pass any inputs using `--data` + Inputs specified as a JSON string or a file +using `@ ` or stdin using @-. Curl-style syntax using `-d @-` for stdin or `-d @` is also supported. diff --git a/frontend/src/lib/components/AppConnect.svelte b/frontend/src/lib/components/AppConnect.svelte index bc9673ce21..047c2b8540 100644 --- a/frontend/src/lib/components/AppConnect.svelte +++ b/frontend/src/lib/components/AppConnect.svelte @@ -300,7 +300,7 @@ > + documentationLink="https://www.windmill.dev/docs/integrations/integrations_on_windmill"> {#if step == 1}
resourceEditor.initEdit(x) }} extraField="description" @@ -314,7 +314,7 @@ sendUserToast(`${name} inserted at cursor`) }} tooltip="Resources Types are the schemas associated with a Resource. They define the structure of the data that is returned from a Resource." - documentationLink="https://docs.windmill.dev/docs/core_concepts/resources_and_types" + documentationLink="https://www.windmill.dev/docs/core_concepts/resources_and_types" itemName="Resource Type" extraField="name" loadItems={async () => diff --git a/frontend/src/lib/components/Path.svelte b/frontend/src/lib/components/Path.svelte index afd26c1f40..b53396d355 100644 --- a/frontend/src/lib/components/Path.svelte +++ b/frontend/src/lib/components/Path.svelte @@ -333,7 +333,7 @@