Changelog update and doc schedules

windmill-labs · Oct 14, 2024 · b359d44 · b359d44
1 parent 766f1e0
commit b359d44
Show file tree

Hide file tree

Showing 15 changed files with 203 additions and 94 deletions.
diff --git a/changelog/2024-10-03-flow-quick-access-menu/index.md b/changelog/2024-10-03-flow-quick-access-menu/index.md
@@ -0,0 +1,15 @@
+---
+slug: flow-quick-access-menu
+version: v1.404.0
+title: Quick access menu for faster component insertion
+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:
+  [
+    'Powerful Searchbar: Instantly locate flows, scripts, flow logic, or generate new AI scripts.',
+    'Smart Filters: Easily explore components from both the Hub and your Workspace.',
+    'Keyboard Navigation: Quickly select components.'
+  ]
+video: /videos/quick_access_menu.mp4
+docs: /docs/flows/flow_editor
+---
diff --git a/changelog/2024-10-03-workers-run-natively-windows/index.md b/changelog/2024-10-03-workers-run-natively-windows/index.md
@@ -0,0 +1,10 @@
+---
+slug: workers-run-natively-windows
+version: v1.405.0
+title: Support workers to run natively on Windows
+description: The goal was to be able to build and run workers on Windows without the need of Docker or WSL.
+features:
+  [
+    Add Windows support for workers by updating executors and environment configurations for compatibility.
+  ]
+---
diff --git a/changelog/2024-10-09-move-components-inside-containers-with-ctrl/index.md b/changelog/2024-10-09-move-components-inside-containers-with-ctrl/index.md
@@ -0,0 +1,13 @@
+---
+slug: move-components-inside-containers-with-ctrl
+version: v1.406.0
+title: Move components inside containers with ctrl+click
+tags: ['App editor']
+description: Components can be moved inside containers by holding ctrl/cmd and clicking on the component.
+features:
+  [
+   'Adds drag-and-drop functionality for moving components between subgrids with visual feedback in the frontend grid system.'
+  ]
+video: /videos/move_components.mp4
+docs: /docs/apps/canvas
+---
diff --git a/changelog/2024-10-10-deno-2.0/index.md b/changelog/2024-10-10-deno-2.0/index.md
@@ -0,0 +1,12 @@
+---
+slug: deno-2.0
+version: v1.407.0
+title: Deno 2.0
+tags: ['Script editor']
+description: Deno has been updated to 2.0.0 in Windmill.
+features:
+  [
+    'Deno 2.0 runtime'
+  ]
+docs: https://deno.com/blog/v2.0
+---
diff --git a/changelog/2024-10-10-queue-metric-alerts/index.md b/changelog/2024-10-10-queue-metric-alerts/index.md
@@ -0,0 +1,14 @@
+---
+slug: queue-metric-alerts
+version: v1.406.0
+title: Queue metric alerts
+tags: ['Worker groups', 'Enterprise Edition']
+description: Critical alerts for jobs waiting in queue.
+docs: /docs/core_concepts/worker_groups#queue-metric-alerts
+features:
+  [
+    'Add functionality to monitor job queues and trigger alerts for waiting jobs, with UI for alert management in enterprise feature.',
+    'The "cooldown" parameter determines the minimum duration between two consecutive alerts if the number of waiting jobs are fluctuating around the configured threshold.'
+  ]
+image: ./queue-metric-alerts.png
+---
diff --git a/changelog/2024-10-10-queue-metric-alerts/queue-metric-alerts.png b/changelog/2024-10-10-queue-metric-alerts/queue-metric-alerts.png
diff --git a/changelog/2024-10-12-file-download-helper/file_download_helper.png b/changelog/2024-10-12-file-download-helper/file_download_helper.png
diff --git a/changelog/2024-10-12-file-download-helper/index.md b/changelog/2024-10-12-file-download-helper/index.md
@@ -0,0 +1,13 @@
+---
+slug: file-download-helper
+version: v1.408.0
+title: File download helper
+tags: ['App editor']
+description: Frontend script helper to download a file from a url, base64 encoded string, dataUrl or S3 object.
+features:
+  [
+    'Download a file from a url, base64 encoded string, dataUrl or S3 object.'
+  ]
+image: ./file_download_helper.png
+docs: /docs/apps/app-runnable-panel#downloadfile
+---
diff --git a/docs/apps/3_app-runnable-panel.mdx b/docs/apps/3_app-runnable-panel.mdx
@@ -343,13 +343,10 @@ Syntax:
 goto(path: string, newTab?: boolean)
 ```
 
-Parameters:
-
-`path`
-The URL to navigate to.
-
-`newTab` (optional)
-Whether to open the URL in a new tab or not.
+| Parameter | Type | Description |
+|-----------|------|-------------|
+| `path`    | string | The URL to navigate to. |
+| `newTab` (optional) | boolean | Whether to open the URL in a new tab or not. |
 
 Example:
 
@@ -370,11 +367,10 @@ Syntax:
 setTab(id: string, index: string)
 ```
 
-Parameters:
-
-`id` string: The id of the component.
-
-`index` string: The index of the tab to set.
+| Parameter | Type | Description |
+|-----------|------|-------------|
+| `id`      | string | The id of the component. |
+| `index`   | string | The index of the tab to set. |
 
 Example:
 
@@ -391,99 +387,97 @@ Where 'a' is the id of the component and 1 is the index of the tab to set.
 />
 <br />
 
-### open
+### recompute
 
-Use the `open` function to open a modal or drawer.
+Use the `recompute` function to recompute a component.
 
 Syntax:
 
 ```js
-open(id: string)
+recompute(id: string)
 ```
 
-Parameters:
-
-`id` string
-The id of the modal or drawer component to open.
+| Parameter | Type | Description |
+|-----------|------|-------------|
+| `id`      | string | The id of the component to recompute. |
 
 Example:
 
+
 ```js
-open('a');
+recompute('a');
 ```
 
-### close
+### getAgGrid
 
-Use the `close` function to close a modal.
+Use the `getAgGrid` function to get the ag-grid instance of a table.
 
 Syntax:
 
 ```js
-close(id: string)
+getAgGrid(id: string)
 ```
 
-Parameters:
-
-`id` string
-The id of the modal or drawer component to close.
+### setValue
 
-Example:
+The `setValue` function is meant to manually set or force the value of a component. This can be convenient in cases where [connecting components](./2_connecting_components/index.mdx) is not the easiest pattern.
 
 ```js
-close('a');
+setValue(id: string, value: any)
 ```
 
-### recompute
+Note that it's a bad idea to mix dynamic default value and setValue together.
 
-Use the `recompute` function to recompute a component.
+
+### setSelectedIndex
+
+Use the `setSelectedIndex` function to select a row in a table or an AG Grid table.
 
 Syntax:
 
 ```js
-recompute(id: string)
+setSelectedIndex(id: string, index: number)
 ```
+### open
 
-Parameters:
-
-`id` string
-The id of the component to recompute.
+Use the `open` function to open a modal or drawer.
 
-Example:
+Syntax:
 
 ```js
-recompute('a');
+open(id: string)
 ```
 
-### getAgGrid
+| Parameter | Type | Description |
+|-----------|------|-------------|
+| `id`      | string | The id of the modal or drawer component to open. |
 
-Use the `getAgGrid` function to get the ag-grid instance of a table.
-
-Syntax:
+Example:
 
 ```js
-getAgGrid(id: string)
+open('a');
 ```
 
-### setSelectedIndex
+### close
 
-Use the `setSelectedIndex` function to select a row in a table or an AG Grid table.
+Use the `close` function to close a modal.
 
 Syntax:
 
 ```js
-setSelectedIndex(id: string, index: number)
+close(id: string)
 ```
 
-### setValue
+| Parameter | Type | Description |
+|-----------|------|-------------|
+| `id`      | string | The id of the modal or drawer component to close. |
 
-The `setValue` function is meant to manually set or force the value of a component. This can be convenient in cases where [connecting components](./2_connecting_components/index.mdx) is not the easiest pattern.
+Example:
 
 ```js
-setValue(id: string, value: any)
+close('a');
 ```
 
-Note that it's a bad idea to mix dynamic default value and setValue together.
-
 ### validate
 
 Make a specific field of a form in a Validate state.
@@ -492,14 +486,6 @@ Make a specific field of a form in a Validate state.
 validate(id: string, key: string)
 ```
 
-### validateAll
-
-Make all fields of a form in a Validate state.
-
-```js
-validateAll(id: string, key: string)
-```
-
 ### invalidate
 
 Invalidate a specific field of a form.
@@ -508,21 +494,24 @@ Invalidate a specific field of a form.
 invalidate(id: string, key: string, error: string)
 ```
 
-Parameters:
-
-`id` string
+| Parameter | Type | Description |
+|-----------|------|-------------|
+| `id`      | string | The id of the form component. |
+| `key`     | string | The key of the field to invalidate. |
+| `error`   | string | The error message to display. |
 
-### recompute
+### validateAll
 
-Recompute a component.
+Make all fields of a form in a Validate state.
 
 ```js
-recompute(id: string)
+validateAll(id: string, key: string)
 ```
 
-Parameters:
-
-`id` string
+| Parameter | Type | Description |
+|-----------|------|-------------|
+| `id`      | string | The id of the form component. |
+| `key`     | string | The key of the field to validate. |
 
 ### clearFiles
 
@@ -532,9 +521,10 @@ Clear the files of a file input.
 clearFiles(id: string)
 ```
 
-Parameters:
+| Parameter | Type | Description |
+|-----------|------|-------------|
+| `id`      | string | The id of the file input component. |
 
-`id` string
 
 ### showToast
 
@@ -544,10 +534,10 @@ Sends a toast notification.
 showToast(message: string, error: boolean)
 ```
 
-Parameters:
-
-`message` string
-`error` boolean
+| Parameter | Type | Description |
+|-----------|------|-------------|
+| `message` | string | The message to display. |
+| `error`   | boolean | Whether the toast is an error toast or not. |
 
 ### waitJob
 
@@ -560,12 +550,37 @@ waitJob(jobId: string).then(() => {
 
 ```
 
-Parameters:
-
-`jobId` string
+| Parameter | Type | Description |
+|-----------|------|-------------|
+| `jobId`   | string | The id of the job to wait for. |
 
 Note that the helper returns a promise.
 
+### askNewResource
+
+Ask user [resource](../core_concepts/3_resources_and_types/index.mdx) on a [UserResourceComponent](./4_app_configuration_settings/resource_select.mdx).
+
+```js
+askNewResource(id: string): void
+```
+
+| Parameter | Type | Description |
+|-----------|------|-------------|
+| `id`      | string | The id of the component. |
+
+### downloadFile
+
+Download a file from a url, [base64 encoded string](https://developer.mozilla.org/en-US/docs/Web/API/WindowBase64/Base64_encoding_and_decoding), [dataUrl](https://developer.mozilla.org/en-US/docs/Web/URI/Schemes/data) or [S3 object](../core_concepts/38_object_storage_in_windmill/index.mdx#workspace-object-storage).
+
+```js
+downloadFile(input: string | { s3: string; storage?: string; }, fileName?: string): void
+```
+
+| Parameter | Type | Description |
+|-----------|------|-------------|
+| `input`   | string | The url, base64 encoded string, dataUrl or S3 object. |
+| `fileName` (optional) | string | The name of the file to download. |
+
 ## Policy
 
 A viewer of the app will execute the runnables of the app on behalf of the publisher avoiding the risk that a resource or script would not be available to the viewer. To guarantee tight security, a policy is computed at time of saving of the app which only allow the scripts/flows referred to in the app to be called on behalf of. Furthermore, static parameters are not overridable. Hence, users will only be able to use the app as intended by the publisher without risk for leaking resources not used in the app.