Skip to content

Commit 3b54f69

Browse files
hcourdenthcourdent
authored
Added docs pages to latest workspace settings (windmill-labs#527)
1 parent 7f8ebeb commit 3b54f69

File tree

12 files changed

+164
-85
lines changed

12 files changed

+164
-85
lines changed

‎docs/advanced/11_git_sync/git_sync_setup.png

-53.9 KB
Loading

‎docs/advanced/11_git_sync/index.mdx

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -70,7 +70,11 @@ Add this resource to the workspace settings, in "Git Sync" tab and `Save Git syn
7070

7171
![Git Sync Setup](./git_sync_setup.png 'Git Sync Setup')
7272

73-
And that's it! Now, all scripts, flows and apps located in the workspace and `f/` [folders](../../core_concepts/8_groups_and_folders/index.mdx) will be pushed to the Git repository.
73+
And that's it! Now, all scripts, flows apps, resources, variables, schedules and resource types located in the workspace and `f/` [folders](../../core_concepts/8_groups_and_folders/index.mdx) will be pushed to the Git repository.
74+
75+
You can filter on type if you don't want some items (e.g. variables) to be pushed to the Git repository.
76+
77+
Additionally, you can filter on path, meaning only scripts, flows and apps with their path matching one of those filters will be synced to the Git repositories below. The filters allow '*'' and '**' characters, with '*'' matching any character allowed in paths until the next slash (/) and '**' matching anything including slashes. By default everything in folders will be synced.
7478

7579
## Git Sync - Item mode: Deploy to Prod using a Git Workflow
7680

‎docs/apps/1_default_app/index.md

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
# Workspace Default App
2+
3+
If configured, users who are [operators](../../core_concepts/16_roles_and_permissions/index.mdx) in this workspace will be redirected to this app automatically when logging into this workspace.
4+
5+
Make sure the default app is [shared with all the operators](../../core_concepts/8_groups_and_folders/index.mdx) of this workspace before turning this feature on.
6+
7+
Set up the app from workspace settings:
8+
9+
![Set up default app](./set_default_app.png "Set up default app")
10+
11+
Operators will have it open right when logging into the workspace:
12+
13+
<video
14+
className="border-2 rounded-xl object-cover w-full h-full dark:border-gray-800"
15+
controls
16+
src="/videos/default_app_operator.mp4"
17+
/>

‎docs/apps/1_default_app/set_default_app.png

211 KB
Loading

‎docs/core_concepts/30_workspace_secret_encryption/index.mdx

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
# Workspace Secret Encryption
2+
3+
When updating the encryption key of a workspace, all [secrets](../2_variables_and_secrets/index.mdx#secrets) will be re-encrypted with the new key and the previous key will be replaced by the new one.
4+
5+
If you're manually updating the key to match another workspace key from another Windmill instance, make sure not to use the 'SECRET_SALT' environment variable or, if you're using it, make sure it the salt matches across both instances.
6+
7+
The encryption key should be 64 characters long and only contain letters and numbers.
8+
9+
<video
10+
className="border-2 rounded-xl object-cover w-full h-full dark:border-gray-800"
11+
controls
12+
src="/videos/encrypt_secrets.mp4"
13+
/>
14+
15+
<br/>
16+
17+
This feature is [Cloud plans and Self-Hosted Enterprise Edition](/pricing) only.

‎docs/core_concepts/index.mdx

Lines changed: 87 additions & 77 deletions
Original file line numberDiff line numberDiff line change
@@ -160,83 +160,6 @@ On top of its editors to build endpoints, flows and apps, Windmill comes with a
160160
/>
161161
</div>
162162

163-
## Enterprise & Cloud Features
164-
165-
All details & features on [Pricing page](/pricing).
166-
167-
<div className="grid grid-cols-2 gap-6 mb-4">
168-
<DocCard
169-
title="Support & SLA"
170-
description="Our SLAs are designed to provide timely assistance and address any issues."
171-
href="/docs/misc/support_and_sla"
172-
/>
173-
<DocCard
174-
title="Audit Logs"
175-
description="Windmill provides audit logs for every operation and action that has side-effects."
176-
href="/docs/core_concepts/audit_logs"
177-
/>
178-
<DocCard
179-
title="Deploy to Staging/Prod Web UI"
180-
description="Deploy items to another staging/prod workspace."
181-
href="/docs/core_concepts/staging_prod"
182-
/>
183-
<DocCard
184-
title="Git Sync"
185-
description="Connect the Windmill workspace to a Git repository to automatically commit and push scripts, flows and apps to the repository on each deploy."
186-
href="/docs/advanced/git_sync"
187-
/>
188-
<DocCard
189-
title="Worker Groups Management UI"
190-
description="Manage Worker Groups through Windmill UI."
191-
href="/docs/misc/worker_group_management_ui"
192-
/>
193-
<DocCard
194-
title="Concurrency Limits"
195-
description="The Concurrency Limits feature allows you to define concurrency limits for scripts, flows and inline scripts within flows."
196-
href="/docs/core_concepts/concurrency_limits"
197-
/>
198-
<DocCard
199-
title="S3 Distributed Dependency Cache"
200-
description="Leverage a global S3 cache to speed up Python dependency handling by storing and reusing pre-installed package."
201-
href="/docs/misc/s3_cache"
202-
/>
203-
<DocCard
204-
title="OpenID Connect (OIDC)"
205-
description="Use Windmill's OIDC provider to authenticate from scripts to cloud providers and other APIs."
206-
href="/docs/core_concepts/oidc"
207-
/>
208-
<DocCard
209-
title="SAML & SCIM"
210-
description="Configure Okta for both SAML and SCIM."
211-
href="/docs/misc/saml_and_scim"
212-
/>
213-
<DocCard
214-
title="Dedicated Workers / High Throughput"
215-
description="Dedicated Workers are workers that are dedicated to a particular script."
216-
href="/docs/core_concepts/dedicated_workers"
217-
/>
218-
<DocCard
219-
title="Agent Workers"
220-
description="Agent Workers are a 4th mode of execution of the Windmill binary, but instead of using MODE=worker, we use here MODE=agent."
221-
href="/docs/core_concepts/agent_workers"
222-
/>
223-
<DocCard
224-
title="Content Search"
225-
description="Search any scripts, flows, resources, apps for a specific string similar to GitHub search."
226-
href="/docs/core_concepts/content_search"
227-
/>
228-
<DocCard
229-
title="CSS Editor"
230-
description="The Global CSS Editor is designed to give styling and theming across your entire app."
231-
href="/docs/apps/css_editor"
232-
/>
233-
<DocCard
234-
title="Multiplayer"
235-
description="Collaborate on scripts simultaneously."
236-
href="/docs/core_concepts/multiplayer"
237-
/>
238-
</div>
239-
240163
## Code Editor-Specific Features
241164

242165
<div className="grid grid-cols-2 gap-6 mb-4">
@@ -469,3 +392,90 @@ All details on Apps can be found in the [Apps section](../apps/0_app_editor/inde
469392
href="/docs/apps/react_components"
470393
/>
471394
</div>
395+
396+
## Enterprise & Cloud Features
397+
398+
All details & features on [Pricing page](/pricing).
399+
400+
<div className="grid grid-cols-2 gap-6 mb-4">
401+
<DocCard
402+
title="Support & SLA"
403+
description="Our SLAs are designed to provide timely assistance and address any issues."
404+
href="/docs/misc/support_and_sla"
405+
/>
406+
<DocCard
407+
title="Audit Logs"
408+
description="Windmill provides audit logs for every operation and action that has side-effects."
409+
href="/docs/core_concepts/audit_logs"
410+
/>
411+
<DocCard
412+
title="Deploy to Staging/Prod Web UI"
413+
description="Deploy items to another staging/prod workspace."
414+
href="/docs/core_concepts/staging_prod"
415+
/>
416+
<DocCard
417+
title="Git Sync"
418+
description="Connect the Windmill workspace to a Git repository to automatically commit and push scripts, flows and apps to the repository on each deploy."
419+
href="/docs/advanced/git_sync"
420+
/>
421+
<DocCard
422+
title="Worker Groups Management UI"
423+
description="Manage Worker Groups through Windmill UI."
424+
href="/docs/misc/worker_group_management_ui"
425+
/>
426+
<DocCard
427+
title="Concurrency Limits"
428+
description="The Concurrency Limits feature allows you to define concurrency limits for scripts, flows and inline scripts within flows."
429+
href="/docs/core_concepts/concurrency_limits"
430+
/>
431+
<DocCard
432+
title="S3 Distributed Dependency Cache"
433+
description="Leverage a global S3 cache to speed up Python dependency handling by storing and reusing pre-installed package."
434+
href="/docs/misc/s3_cache"
435+
/>
436+
<DocCard
437+
title="OpenID Connect (OIDC)"
438+
description="Use Windmill's OIDC provider to authenticate from scripts to cloud providers and other APIs."
439+
href="/docs/core_concepts/oidc"
440+
/>
441+
<DocCard
442+
title="SAML & SCIM"
443+
description="Configure Okta for both SAML and SCIM."
444+
href="/docs/misc/saml_and_scim"
445+
/>
446+
<DocCard
447+
title="Dedicated Workers / High Throughput"
448+
description="Dedicated Workers are workers that are dedicated to a particular script."
449+
href="/docs/core_concepts/dedicated_workers"
450+
/>
451+
<DocCard
452+
title="Agent Workers"
453+
description="Agent Workers are a 4th mode of execution of the Windmill binary, but instead of using MODE=worker, we use here MODE=agent."
454+
href="/docs/core_concepts/agent_workers"
455+
/>
456+
<DocCard
457+
title="Content Search"
458+
description="Search any scripts, flows, resources, apps for a specific string similar to GitHub search."
459+
href="/docs/core_concepts/content_search"
460+
/>
461+
<DocCard
462+
title="CSS Editor"
463+
description="The Global CSS Editor is designed to give styling and theming across your entire app."
464+
href="/docs/apps/css_editor"
465+
/>
466+
<DocCard
467+
title="Multiplayer"
468+
description="Collaborate on scripts simultaneously."
469+
href="/docs/core_concepts/multiplayer"
470+
/>
471+
<DocCard
472+
title="Workspace Default App"
473+
description="If configured, users who are operators in this workspace will be redirected to this app automatically when logging into this workspace."
474+
href="/docs/apps/default_app"
475+
/>
476+
<DocCard
477+
title="Workspace Secret Encryption"
478+
description="When updating the encryption key of a workspace, all secrets will be re-encrypted with the new key and the previous key will be replaced by the new one."
479+
href="/docs/core_concepts/workspace_secret_encryption"
480+
/>
481+
</div>

‎docs/misc/15_react_sdk/index.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,8 @@
11
# Windmill React SDK
22

3-
The Windmill React SDK provides a suite of tools and components to integrate Windmill applications into React-based projects.
3+
The Windmill React SDK provides a suite of tools and components to integrate Windmill applications (scripts editor, flows editor, app editor and its deployed apps) into React-based projects.
4+
5+
This feature is available only for [White Label Edition](/pricing).
46

57
## Installation
68

‎docs/misc/8_white_labelling/index.mdx

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -18,6 +18,11 @@ For more information about white labeling and customization options, please reac
1818
description="Send email to contact@windmill.dev to talk about partnership."
1919
href="mailto:contact@windmill.dev"
2020
/>
21+
<DocCard
22+
title="Windmill React SDK"
23+
description="The Windmill React SDK provides a suite of tools and components to integrate Windmill applications into React-based projects."
24+
href="/docs/misc/react_sdk"
25+
/>
2126
</div>
2227

2328
<br />

‎sidebars.js

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -738,8 +738,10 @@ const sidebars = {
738738
'core_concepts/content_search/index',
739739
'apps/css_editor',
740740
'core_concepts/multiplayer/index',
741-
'misc/react_sdk/index',
742-
'misc/white_labelling/index'
741+
'apps/default_app/index',
742+
'core_concepts/workspace_secret_encryption/index',
743+
'misc/white_labelling/index',
744+
'misc/react_sdk/index'
743745
]
744746
}
745747
]

‎src/components/Pricing.js

Lines changed: 26 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -116,6 +116,7 @@ const pricing = {
116116
{ text: 'SAML support including groups synchronization' }
117117
]
118118
},
119+
{ text: 'Unlimited SSO users' },
119120
{
120121
text: <span>Commercial licence</span>
121122
},
@@ -126,8 +127,7 @@ const pricing = {
126127
},
127128
{
128129
text: <span>Design partners for roadmap</span>
129-
},
130-
{ text: 'Unlimited SSO users' }
130+
}
131131
]
132132
}
133133
],
@@ -269,8 +269,8 @@ const pricing = {
269269
description:
270270
'Windmill offers white labeling capabilities, allowing you to customize the Windmill platform to align with your brand.',
271271
features: [
272-
{ text: 'Embed the entire Windmill app.' },
273-
{ text: 'Embed specific components (flow builder, app builder).' }
272+
{ text: 'Embed the entire Windmill app' },
273+
{ text: 'Embed specific components (flow builder, app builder) with Windmill React SDK' }
274274
],
275275
customMessage: 'Learn more',
276276
href: '/docs/misc/white_labelling'
@@ -426,6 +426,17 @@ const sections = [
426426
},
427427
link: '/docs/misc/saml_and_scim'
428428
},
429+
{
430+
name: 'Workspace Secret Encryption',
431+
tiers: {
432+
'Free and Open-source': false,
433+
Pro: true,
434+
Enterprise: true,
435+
Community: true,
436+
Team: false
437+
},
438+
link: '/docs/core_concepts/workspace_secret_encryption'
439+
},
429440
{
430441
name: 'Support level',
431442
tiers: {
@@ -757,6 +768,17 @@ const sections = [
757768
Team: true
758769
},
759770
link: '/docs/apps/app_configuration_settings/aggrid_table'
771+
},
772+
{
773+
name: 'Workspace Default App',
774+
tiers: {
775+
'Free and Open-source': false,
776+
Pro: true,
777+
Enterprise: true,
778+
Community: true,
779+
Team: true
780+
},
781+
link: '/docs/apps/default_app'
760782
}
761783
]
762784
}

0 commit comments

Comments
 (0)