Docs fixes & approval arguments clarification (#779)

windmill-labs · Dec 4, 2024 · 8289695 · 8289695
1 parent 6fe6f33
commit 8289695
Show file tree

Hide file tree

Showing 110 changed files with 403 additions and 407 deletions.
diff --git a/changelog/2023-12-17-decision-tree/index.md b/changelog/2023-12-17-decision-tree/index.md
@@ -1,7 +1,7 @@
 ---
 slug: decision-tree
 version: v1.227.0
-title: Decision Tree
+title: Decision tree
 tags: ['App editor', 'Component']
 image: ./decision-tree.png
 description: This app component allows you to create a decision tree controlled by a flow-like structure. Each node in the tree represents a decision point with a dedicated subgrid and can lead to one or more subsequent nodes based on specified conditions.

diff --git a/changelog/2024-01-11-ag-charts/index.md b/changelog/2024-01-11-ag-charts/index.md
@@ -1,14 +1,14 @@
 ---
 slug: ag-charts
 version: v1.239.0
-title: Ag Charts
+title: Ag charts
 tags: ['App editor', 'Postgres']
 image: ./ag-charts.png
-description: The Ag Charts component integrates the Ag Charts library, enabling the visualization of data through various chart types. This component is designed to offer a flexible and powerful way to display data graphically within the application.
+description: The Ag charts component integrates the Ag charts library, enabling the visualization of data through various chart types. This component is designed to offer a flexible and powerful way to display data graphically within the application.
 features:
   [
-    'Chart Display: Leverages the Ag Charts library to present data in a visually appealing chart format.',
-    'Diverse Chart Types: Supports multiple chart types including Bar, Line, Scatter, and both Area & Range Bar that are exclusive to Enterprise Edition (because Ag Charts key needed).'
+    'Chart Display: Leverages the Ag charts library to present data in a visually appealing chart format.',
+    'Diverse Chart Types: Supports multiple chart types including Bar, Line, Scatter, and both Area & Range Bar that are exclusive to Enterprise Edition (because Ag charts key needed).'
   ]
 docs: /docs/apps/app_configuration_settings/agcharts
 ---
diff --git a/changelog/2024-01-23-database-studio/index.md b/changelog/2024-01-23-database-studio/index.md
@@ -1,10 +1,10 @@
 ---
 slug: database-studio
 version: v1.251.1
-title: Database Studio
+title: Database studio
 tags: ['App editor', 'Postgres']
 image: ./database-studio.png
-description: Introducing the Database Studio, a web-based database management tool that leverages Ag Grid for table display and interaction. In apps, interaction with database content made easy; from a SQL resource, display, edit, add rows, delete rows ... and connect to other components.
+description: Introducing the Database studio, a web-based database management tool that leverages Ag Grid for table display and interaction. In apps, interaction with database content made easy; from a SQL resource, display, edit, add rows, delete rows ... and connect to other components.
 features:
   [
     'Display the content of a table.',

diff --git a/changelog/2024-01-24-default-app/index.md b/changelog/2024-01-24-default-app/index.md
@@ -1,7 +1,7 @@
 ---
 slug: default-app
 version: v1.252.0
-title: Default App
+title: Default app
 tags: ['App editor', 'Enterprise Edition']
 video: /videos/default_app_operator.mp4
 description: If configured, users who are operators in this workspace will be redirected to this app automatically when logging into this workspace.

diff --git a/changelog/2024-02-15-ai-copilot/index.md b/changelog/2024-02-15-ai-copilot/index.md
@@ -1,10 +1,10 @@
 ---
 slug: ai-copilot
 version: v1.270.0
-title: Flow & Metadata Copilot
+title: Flow & metadata copilot
 tags: ['Windmill AI', 'Flow editor', 'Script editor']
 video: /videos/ai_fill_inputs.mp4
-description: The Flow & Metadata Copilot is an assistant powered by an OpenAI resource that simplifies your script & flows building experience by population fields (summaries, descriptions, step input expressions) automatically based on context and prompts.
+description: The Flow & metadata copilot is an assistant powered by an OpenAI resource that simplifies your script & flows building experience by population fields (summaries, descriptions, step input expressions) automatically based on context and prompts.
 features:
   [
     'Fills summary of script & flow steps.',

diff --git a/changelog/2024-02-15-workspace-secret-encryption/index.md b/changelog/2024-02-15-workspace-secret-encryption/index.md
@@ -1,7 +1,7 @@
 ---
 slug: workspace-encryption
 version: v1.270.0
-title: Custom Workspace secret encryption
+title: Custom workspace secret encryption
 tags: ['Security']
 image: ./workspace-secret-encryption.png
 description: All secrets of a workspace are encrypted with a symmetric key unique to that workspace. This key is generated when the workspace is created and is stored in the database in the workspace_settings. You can now manually update the encryption key of a workspace, it will be re-encrypted with the new key and the previous key will be replaced by the new one.

diff --git a/changelog/2024-02-27-pin-database/index.md b/changelog/2024-02-27-pin-database/index.md
@@ -1,7 +1,7 @@
 ---
 slug: pin-database
 version: v1.280.0
-title: Pin Database in SQL Scripts
+title: Pin database in SQL scripts
 tags: ['Script editor', 'SQL']
 video: /videos/pin_database.mp4
 description: Pin database resource path directly within a SQL script instead of filling it through the UI.

diff --git a/changelog/2024-03-13-configurable-languages/index.md b/changelog/2024-03-13-configurable-languages/index.md
@@ -1,7 +1,7 @@
 ---
 slug: configurable-languages
 version: v1.290.0
-title: Configurable Available Languages
+title: Configurable available languages
 tags: ['Script editor']
 image: ./configurable-languages.png
 description: Windmill supports many languages, but organizations usually only use a few, now you can configure the languages that are visible and their order.

diff --git a/changelog/2024-03-22-rename-workspace/index.md b/changelog/2024-03-22-rename-workspace/index.md
@@ -1,7 +1,7 @@
 ---
 slug: rename-workspace
 version: v1.294.0
-title: Rename Workspace
+title: Rename workspace
 tags: ['Instance']
 image: ./change_workspace_id.png
 description: On self-hosted instances, workspaces can have names and IDs updated from the workspace settings.

diff --git a/changelog/2024-03-23-custom-contextual-variables/index.md b/changelog/2024-03-23-custom-contextual-variables/index.md
@@ -1,7 +1,7 @@
 ---
 slug: custom-contextual-variables
 version: v1.295.0
-title: Custom Contextual Variables
+title: Custom contextual variables
 tags: ['Variables']
 image: ./create_custom_contextual_variable.png
 description: From Variables tab, admins can create custom contextual variables that will act as env variables for all jobs within a workspace.

diff --git a/changelog/2024-03-23-log-disk-distributed-storage-compaction/index.md b/changelog/2024-03-23-log-disk-distributed-storage-compaction/index.md
@@ -1,9 +1,8 @@
 ---
 slug: log-disk-distributed-storage-compaction
 version: v1.295.0
-title: Large log disk and Distributed storage compaction
+title: Large log disk and distributed storage compaction
 tags: ['Storage']
-image: ./windmill_alone.png
 description: One of our large scale customers noticed that their database disk usage was much much higher than they anticipated. After investigation, we realized that our use of the database for streaming was very suboptimal in a few ways due to the nature of update in postgres. When you update a row in Postgres, it will actually keep the prior row as a dead tuple until it is collected. It doesn't matter in much case but it will if you're appending a few log lines to a 25MB log row, every 500ms. <br/><br/> **We have completely refactored the way we deal with logs in major ways  and starting on 1.295.0 you should feel comfortable having extremely large logs on Windmill** <br/><br/> First action we took was to extract the logs from the queue table to a separate table. That was to avoid update unrelated to logs creating dead tuples. Second action was to make the streaming rate from the worker adaptive to the duration of the job, a longer job does not need to update its log every 500ms, every 2.5s is reasonable for jobs of more than 10s, 5s for 60s+, etc... <br/><br/> But that was still not enough, even every 2.5s an update on a 25mb log would create lots of heavy dead tuples. And 25MB is not that large, our customer should feel confident streaming GBs of logs per job with jobs that run for months. <br/><br/> So we completely revisited the way we store logs to only treat the database as a buffer for streaming purpose rather than long term storage. We keep the db as a 5000 char buffer to still provide the same instant preview as before but <br/><br/> 1. On EE, the logs will be streamed to S3 if you connected your instance to S3, everything is seamless and you can still download the entire log, Windmill will take care of streaming from S3 <br/><br/> 2. non EE, the excess log (>10000 chars)  will be stored on disk of the worker (mount /tmp/windmill/logs to persist those). <br/><br/> **Now the db only stores at most 5Kb of logs per job rows, reducing the pressure on it by order of magnitudes, while users can now run jobs with unlimited logs with minimal impact on the worker or db. And the logs are still as live as before**
 features:
   [

diff --git a/changelog/2024-03-23-log-disk-distributed-storage-compaction/windmill_alone.png b/changelog/2024-03-23-log-disk-distributed-storage-compaction/windmill_alone.png
diff --git a/changelog/2024-03-26-custom-flow-state/index.md b/changelog/2024-03-26-custom-flow-state/index.md
@@ -1,7 +1,7 @@
 ---
 slug: custom-flow-states
 version: v1.296.0
-title: Custom Flow States
+title: Custom flow states
 tags: ['Flow editor']
 image: ./custom_flow_states.png
 description: You can set and retrieve a value given a key from any step of flow and it will be available from within the flow globally.

diff --git a/changelog/2024-03-27-approval-steps/index.md b/changelog/2024-03-27-approval-steps/index.md
@@ -1,7 +1,7 @@
 ---
 slug: approval-steps-improvements
 version: v1.298.0
-title: Approval Steps Improvements
+title: Approval steps improvements
 tags: ['Flow editor']
 image: ./hide_cancel_approval_page.png
 description: Improved the experience with approval steps.

diff --git a/changelog/2024-03-27-map-support-renderer/index.md b/changelog/2024-03-27-map-support-renderer/index.md
@@ -1,7 +1,7 @@
 ---
 slug: map-support-renderer
 version: v1.298.0
-title: Map Support in Result Renderer
+title: Map support in result renderer
 tags: ['Script editor', 'Flow editor']
 image: ./map.png
 description: Map support in Rich display rendering.

diff --git a/changelog/2024-04-12-aggrid-actions/index.md b/changelog/2024-04-12-aggrid-actions/index.md
@@ -1,10 +1,10 @@
 ---
 slug: aggrid-actions
 version: v1.306.0
-title: AgGrid Actions
+title: AgGrid actions
 tags: ['App editor']
 image: ./aggrid_actions.png
-description: AgGrid and Database Studio rows now support actions, components that will be displayed at each row of the table.
+description: AgGrid and Database studio rows now support actions, components that will be displayed at each row of the table.
 features:
   [
     'Support the following components:',

diff --git a/changelog/2024-04-24-aggrid-infinite-table/index.md b/changelog/2024-04-24-aggrid-infinite-table/index.md
@@ -1,10 +1,10 @@
 ---
 slug: aggrid-infinite-table
 version: v1.315.0
-title: AgGrid Infinite Table
+title: AgGrid infinite table
 tags: ['App editor']
 video: /videos/infinite_table.mp4
-description: The AgGrid Infinite Table component allows you to display an Ag Grid table with infinite scrolling.
+description: The AgGrid infinite table component allows you to display an Ag Grid table with infinite scrolling.
 features:
   [
     'Specific syntax to let component manage rows display.',

diff --git a/changelog/2024-04-24-jobs-labels/index.md b/changelog/2024-04-24-jobs-labels/index.md
@@ -1,7 +1,7 @@
 ---
 slug: jobs-labels
 version: v1.316.0
-title: Jobs Labels
+title: Jobs labels
 tags: ['Runs', 'Script editor', 'Flow editor']
 image: ./runs_labels.png
 description: Labels allow to add static or dynamic tags to jobs with property "wm_labels" followed by an array of strings (e.g. `return {"wm_labels":["showcase_labels", "another_label"]}`

diff --git a/changelog/2024-05-10-workers-metrics/index.md b/changelog/2024-05-10-workers-metrics/index.md
@@ -1,7 +1,7 @@
 ---
 slug: workers-metrics
 version: v1.325.0
-title: Workers Metrics
+title: Workers metrics
 tags: ['Workers']
 image: ./workers_metrics.png
 description: You can visualize metrics for Delayed jobs per tag and Queue delay per tag.

diff --git a/changelog/2024-05-15-full-height-components/index.md b/changelog/2024-05-15-full-height-components/index.md
@@ -1,7 +1,7 @@
 ---
 slug: full-height-components
 version: v1.331.0
-title: Full Height Components
+title: Full-height components
 tags: ['App editor']
 video: /videos/full_height.mp4
 description: When set to full height, a component (in its respective view type, desktop or mobile) components will have their height go down until the end of the parent container (if no, canvas).

diff --git a/changelog/2024-05-15-php-support/index.md b/changelog/2024-05-15-php-support/index.md
@@ -1,7 +1,7 @@
 ---
 slug: php-support
 version: v1.330.0
-title: PHP Support
+title: PHP support
 tags: ['Script editor']
 image: ./php_changelog.png
 description: PHP is now supported as a primary language along TypeScript, Python, Go, Bash, or SQL languages.

diff --git a/changelog/2024-05-27-gpt-4o/index.md b/changelog/2024-05-27-gpt-4o/index.md
@@ -1,7 +1,7 @@
 ---
 slug: windmill-ai-gpt-4o
 version: v1.338.0
-title: Windmill AI now supports GPT-4o
+title: GPT-4o support on Windmill AI
 tags: ['Windmill AI']
 image: ./enable_autopilot.png
 description: Windmill AI has been upgrading from GPT 4 and GPT-3.5-turbo to GPT-4o

diff --git a/changelog/2024-05-27-user-resources-in-app/index.md b/changelog/2024-05-27-user-resources-in-app/index.md
@@ -1,10 +1,10 @@
 ---
 slug: user-resources-in-apps
 version: v1.338.0
-title: Allow User Resources in Apps with a toggle
+title: Allow user resources in Apps with a toggle
 tags: ['App editor']
 image: ./resources_from_users.png
-description: Apps are executed on behalf of publishers and by default cannot access viewer's resources.<br/><br/>If the resource passed here as a reference does not come from a static Resource Select component (which will be whitelisted by the auto-generated policy), you need to toggle "Resources from users allowed".<br/><br/>The toggle "Static resource select only / Resources from users allowed" can be found for each runnable input when the source is an eval.
+description: Apps are executed on behalf of publishers and by default cannot access viewer's resources.<br/><br/>If the resource passed here as a reference does not come from a static Resource select component (which will be whitelisted by the auto-generated policy), you need to toggle "Resources from users allowed".<br/><br/>The toggle "Static resource select only / Resources from users allowed" can be found for each runnable input when the source is an eval.
 features:
   [
     'By default, dynamic resource input from app runnables can only be filled from components Resource Picker.',

diff --git a/changelog/2024-05-31-secondary-storage/index.md b/changelog/2024-05-31-secondary-storage/index.md
@@ -1,7 +1,7 @@
 ---
 slug: secondary-storage
 version: v1.340.0
-title: Secondary Storage
+title: Secondary storage
 tags: ['Persistent Storage']
 image: ./secondary_storage.png
 description: Read and write from a storage that is not your main storage by specifying it in the S3 object as "secondary_storage" with the name of it.

diff --git a/changelog/2024-06-17-oneof-inputs/index.md b/changelog/2024-06-17-oneof-inputs/index.md
@@ -1,7 +1,7 @@
 ---
 slug: oneof-inputs
 version: v1.347.0
-title: OneOf Inputs
+title: OneOf inputs
 tags: ['Script editor', 'Flow editor']
 description: Added new type of input `oneOf@, that displays an option between multiple objects.
 features:

diff --git a/changelog/2024-07-04-flow-versioning/index.md b/changelog/2024-07-04-flow-versioning/index.md
@@ -1,7 +1,7 @@
 ---
 slug: flow-versioning
 version: v1.357.0
-title: Flow Versioning
+title: Flow versioning
 tags: ['Flow editor', 'Script editor', 'App editor']
 image: ./deployment_history.png
 description: Flows now have versions just like scripts and apps.

diff --git a/changelog/2024-07-05-navbar/index.md b/changelog/2024-07-05-navbar/index.md
@@ -1,7 +1,7 @@
 ---
 slug: navbar
 version: v1.358.0
-title: Navbar Component
+title: Navbar component
 tags: ['App editor']
 description: The Navbar component facilitates control over an app by changing its ctx.query and jumping into another app.
 features:

diff --git a/changelog/2024-07-14-flow-status-viewer/index.md b/changelog/2024-07-14-flow-status-viewer/index.md
@@ -1,7 +1,7 @@
 ---
 slug: flow-status-viewer
 version: v1.362.0
-title: Flow Status Viewer improvements
+title: Flow status viewer improvements
 tags: ['Flow editor']
 description: Improved the flow status viewer readability.
 features:

diff --git a/changelog/2024-07-29-app-bar-components/index.md b/changelog/2024-07-29-app-bar-components/index.md
@@ -10,7 +10,7 @@ features:
     'App context Summary.',
     'New component Recompute all to recompute app once or at given frequency.',
     'New component Topbar with a Text component with ctx.summmary and a Recompute all component.',
-    'Top Bar component is default for all apps (can be moved or deleted).',
+    'Top bar component is default for all apps (can be moved or deleted).',
   ]
 docs: /docs/apps/app_configuration_settings/topbar
 video: /videos/topbar.mp4

diff --git a/changelog/2024-08-26-hide-show-app-panels/index.md b/changelog/2024-08-26-hide-show-app-panels/index.md
@@ -1,7 +1,7 @@
 ---
 slug: hide-show-app-panels
 version: v1.384.0
-title: Hide / Show App editor Panels
+title: Hide / Show App editor panels
 tags: ['App editor']
 description: Hide panels on App editor with buttons and shortcuts.
 features:

diff --git a/changelog/2024-08-30-rust-support/index.md b/changelog/2024-08-30-rust-support/index.md
@@ -1,7 +1,7 @@
 ---
 slug: rust-support
 version: v1.388.0
-title: Rust Support
+title: Rust support
 tags: ['Rust', 'Code editor']
 description: Windmill now supports Rust scripts.
 features:

diff --git a/changelog/2024-09-01-critical-alert-channels/index.md b/changelog/2024-09-01-critical-alert-channels/index.md
@@ -1,7 +1,7 @@
 ---
 slug: critical-alerts
 version: v1.389.0
-title: Critical Alerts
+title: Critical alerts
 tags: ['Workers', 'Security', 'Enterprise Edition']
 description: Get a notification everytime on critical events such as when a job is re-run after a crash.
 features:

diff --git a/changelog/2024-10-03-flow-quick-access-menu/index.md b/changelog/2024-10-03-flow-quick-access-menu/index.md
@@ -2,7 +2,7 @@
 slug: flow-quick-access-menu
 version: v1.404.0
 title: Quick access menu for faster component insertion
-tags: ['Flow Editor']
+tags: ['Flow editor']
 description: Introducing the Quick Access Menu—a streamlined solution that centralizes all key features previously scattered across side panels. Now, you can benefit from the full potential of search, enhanced by intuitive filters, all in one place.
 features:
   [

diff --git a/changelog/2024-11-22-features-dashboard/index.md b/changelog/2024-11-22-features-dashboard/index.md
@@ -1,7 +1,7 @@
 ---
 slug: feature-request-and-issue-dashboard
 title: Feature request & issue dashboard
-tags: ['Enterprise']
+tags: ['Enterprise Edition']
 description: Enterprise users now have access to a dedicated dashboard for tracking feature requests and issues.
 features:
   [

diff --git a/docs/advanced/11_git_sync/index.mdx b/docs/advanced/11_git_sync/index.mdx
@@ -78,12 +78,10 @@ You can filter on type if you don't want some items (e.g. variables) to be pushe
 
 Additionally, you can filter on [path](../../core_concepts/16_roles_and_permissions/index.mdx#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](../../core_concepts/8_groups_and_folders/index.mdx) will be synced.
 
-
-
 ### Azure DevOps with Service Principal setup
-In Microsoft Entra ID, create an application and a secret. 
+In Microsoft Entra ID, create an application and a secret (also known as Service Principal - an identity used by applications to access Azure resources). 
 Create an `azure` resource on your Windmill instance with the application's `client_id`, `client_secret` and `tenant_id`.
-On Azure DevOps, add the application to the DevOps organization with the appropriate permissions. 
+On Azure DevOps, add the application to the DevOps organization with the appropriate permissions.
 In Git sync settings of your Windmill instance, define a new repository with URL:
 
 ```