Skip to content

Commit

Permalink
(chore): update UI documentation pages (#2106)
Browse files Browse the repository at this point in the history
  • Loading branch information
aj-emerich authored Jan 21, 2025
1 parent 52eaa76 commit 44f212c
Show file tree
Hide file tree
Showing 19 changed files with 67 additions and 67 deletions.
6 changes: 3 additions & 3 deletions content/docs/08.ui/00.dashboard.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,18 +5,18 @@ icon: /docs/icons/ui.svg

Get insights into your workflows with the Dashboard.

The first time you access the main **Dashboard**, you'll see the **Welcome Page** and you can click **Create my first flow** to launch a Guided Tour.
The first time you access the main **Dashboard**, you see the **Welcome Page**, and you can click **Create my first flow** to launch a Guided Tour.

Once you have executed a flow, you will see your flow executions in the dashboard.

![UI](/docs/user-interface-guide/03-Homepage.png)

The Dashboard provides a load of useful data right at your finger tips, including:
- Executions over time
- Execution Status for Today, Yesterday as well as Last 30 days
- Execution Status for Today, Yesterday, as well as Last 30 days
- Executions per namespace
- Execution errors per namespace
- List of failed Executions
- List of error logs

The dashboard is interactive so you can click on any element to get more information about it.
The dashboard is interactive, so you can click on any element to get more information about it.
14 changes: 7 additions & 7 deletions content/docs/08.ui/01.flows.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,13 +6,13 @@ icon: /docs/icons/ui.svg

Manage your flows in one place.

On the **Flows** page, you will see a list of flows which you can edit and execute. You can also create a new flow in the top right hand corner.
On the **Flows** page, you see a list of flows which you can edit and execute. You can also create a new flow in the top right hand corner.

By clicking on a flow id or on the eye icon, you can open a flow.

![Kestra User Interface Flows Page](/docs/user-interface-guide/04-Flows.png)

A **Flow** page will have multiple tabs that allow you to: see the flow topology, all flow executions, edit the flow, view its revisions, logs, metrics, and dependencies. You'll also be able to edit namespace files in the Flow editor as well.
A **Flow** page has multiple tabs that allow you to: see the flow topology, all flow executions, edit the flow, view its revisions, logs, metrics, and dependencies. You are also able to edit namespace files in the Flow editor as well.

![Kestra User Interface Flow Page](/docs/user-interface-guide/05-Flows-Flow.png)

Expand All @@ -35,7 +35,7 @@ The Topology View allows you to visualize the structure of your flow. This is es

### Documentation View

The documentation view allows you to see Kestra's documentation right inside of the editor. As you move your type cursor around the Editor, the documentation page will update to reflect the specific task type documentation.
The documentation view allows you to see Kestra's documentation right inside of the editor. As you move your type cursor around the Editor, the documentation page updates to reflect the specific task type documentation.

![Docs](/docs/user-interface-guide/docs-editor.png)

Expand All @@ -47,13 +47,13 @@ Note that if you use the [Brave browser](https://brave.com/), you may need to di

### Blueprints View

The blueprint view allows you to copy example flows directly into your flow. Especially useful if you're using a new plugin where you want to work off of an existing example.
The blueprint view allows you to copy example flows directly into your flow. Blueprints are especially useful if you're using a new plugin where you want to work off of an existing example.

![Blueprints Editor](/docs/user-interface-guide/blueprints-editor.png)

## Revisions

You can view the history of your flow under the Revisions tab. Read more about revisions [here](../05.concepts/03.revision.md).
You can view the history of your flow under the Revisions tab. For more details, check out the [revisions concept guide](../05.concepts/03.revision.md).

![Blueprints Editor](/docs/user-interface-guide/revisions.png)

Expand All @@ -69,7 +69,7 @@ The Dependencies View on the Namespaces page shows all the flows in the namespac

## JSON Schema Usage for Flow Validation

Kestra provides a JSON Schema to validate your flow definitions. This ensures that your flows are correctly structured and helps catch errors early in the development process.
Kestra provides a JSON Schema to validate your flow definitions. This schema ensures that your flows are correctly structured and helps catch errors early in the development process.

### JSON Schema in VSCode

Expand Down Expand Up @@ -103,7 +103,7 @@ tasks:
message: "Hello, World!"
```
When you open this flow in the editor, the JSON Schema will validate the structure and provide autocompletion and error checking.
When you open this flow in the editor, the JSON Schema validates the structure and provide autocompletion and error checking.
### Globally Available Location for JSON Schema
Expand Down
2 changes: 1 addition & 1 deletion content/docs/08.ui/02.executions.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ icon: /docs/icons/ui.svg

Manage your Flow executions all in one place.

On the **Executions** page, you will see a list of all your completed flow executions.
On the **Executions** page, you see a list of all your completed flow executions.

You can select multiple checkboxes to choose executions for bulk actions, such as Restart, Kill, Pause, or Force Run. Alternatively, you can click an execution ID or the magnifying glass icon to open an execution for further examination.

Expand Down
4 changes: 2 additions & 2 deletions content/docs/08.ui/03.logs.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,11 +6,11 @@ docId: logs

Manage Logs generated by tasks.

On the **Logs** page, you will have access to all task logs.
On the **Logs** page, you have access to all task logs.

![Kestra User Interface Logs Page](/docs/user-interface-guide/10-Logs.png)

On here, you can filter by:
On this page, you can filter by:
- Namespace
- Log level
- Time period
Expand Down
16 changes: 8 additions & 8 deletions content/docs/08.ui/04.namespaces/ee.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,38 +19,38 @@ There's a number of extra namespace pages available in the enterprise edition:

## Edit

Manage the namespace description, [worker group](../../06.enterprise/worker-group.md) and permissions.
Manage the namespace description, [worker group](../../06.enterprise/worker-group.md), and permissions.

![Edit](/docs/user-interface-guide/edit.png)

## Variables

Variables defined at the namespace level can be used in any flow defined under the same namespace using the syntax: `{{ namespace.variable_name }}`.

Read more about Variables [here](../../06.enterprise/08.centralized-task-configuration.md#variables)
Read more about [Variables](../../06.enterprise/08.centralized-task-configuration.md#variables).

![Variables](/docs/user-interface-guide/variables.png)

## Plugin Defaults
## Plugin defaults

Plugin Defaults can also be defined at the namespace level. These plugin defaults are then applied for all tasks of the corresponding type defined in the flows under the same namespace.
Plugin defaults can also be defined at the namespace level. These plugin defaults are then applied for all tasks of the corresponding type defined in the flows under the same namespace.

![Plugin Defaults](/docs/user-interface-guide/plugindefaults-namespaces.png)
![Plugin Defaults](/docs/user-interface-guide/plugindefaults-namespaces.png).

Read more about Plugin Defaults [here](../../06.enterprise/08.centralized-task-configuration.md#plugin-defaults)
Read more about [Plugin defaults](../../06.enterprise/08.centralized-task-configuration.md#plugin-defaults)

## Secrets

Configure Secrets directly from the UI. These secrets are available to all flows inside of the namespace.

![Secrets](/docs/user-interface-guide/secrets-namespaces.png)

Read more about Secrets [here](../../06.enterprise/secrets.md)
Read more about [Secrets](../../06.enterprise/secrets.md).

## Audit Logs

Audit Logs record all activities performed in your Kestra instance by users and service accounts. You can view all of the audit logs related to the selected namespace in this view.

![Audit Logs](/docs/user-interface-guide/auditlogs-namespaces.png)

Read more about Audit Logs [here](../../06.enterprise/06.audit-logs.md).
Read more about [Audit Logs](../../06.enterprise/06.audit-logs.md).
14 changes: 7 additions & 7 deletions content/docs/08.ui/04.namespaces/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ icon: /docs/icons/ui.svg

Manage resources associated with a namespace in one place.

Starting 0.18.0, Kestra has introduced the Namespaces tab in the Kestra UI for OSS. In this tab, you can see all the namespaces associated with the different flows in Kestra.
Starting in 0.18.0, Kestra has introduced the Namespaces tab in the Kestra UI for OSS. In this tab, you can see all the namespaces associated with the different flows in Kestra.

<div class="video-container">
<iframe src="https://www.youtube.com/embed/MbG9BHJIMzU?si=9gVEROGc5hXcIJR2" title="YouTube video player" frameborder="0" allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture; web-share" referrerpolicy="strict-origin-when-cross-origin" allowfullscreen></iframe>
Expand All @@ -19,35 +19,35 @@ This is the default landing page of the Namespace. This page contains the dashbo

## Editor

The in-built editor where you can add/edit namespace files. This makes it easier to edit just your namespace files without needing to select a flow inside of the namespace.
The built-in editor is where you can add/edit namespace files. This acess makes it easier to edit just your namespace files without needing to select a flow inside of the namespace.

![Editor](/docs/user-interface-guide/editor-namespaces.png)

## Flows

Shows all the flows in the namespace. It gives a brief about each of the flows including the flow ID, labels, last execution date and last execution status, and the execution statistics. By selecting the details button on the right of the flow, you can navigate to that flow's page.
The Flows tab shows all the flows in the namespace. It gives a summary about each of the flows including the flow ID, labels, last execution date and last execution status, and the execution statistics. By selecting the details button on the right of the flow, you can navigate to that flow's page.

![Flows](/docs/user-interface-guide/flows-namespaces.png)

## Dependencies

Shows all the flows and which ones are dependent on each other (for example through Subflows or Flow Triggers).
The Dependencies tab shows all the flows and which ones are dependent on each other (e.g., through Subflows or Flow Triggers).

This is similar to the Dependencies page in the Flow Editor, but this shows you how all flows within a namespace even if some of them don't depend on any others.
This is similar to the Dependencies page in the Flow Editor, but this page shows you how all flows within a namespace relate even if some of them don't depend on any others.

![Dependencies](/docs/user-interface-guide/dependencies-namespaces.png)

## KV Store

Manage the key-values pairs associated with this namespace. More details on KV Store can be found [here](../../05.concepts/05.kv-store.md).
From the KV Store tab, manage the key-values pairs associated with a namespace. More details, check out the [KV Store concept guide](../../05.concepts/05.kv-store.md).

![KV Store](/docs/user-interface-guide/kvstore-namespaces.png)

<div class="video-container">
<iframe src="https://www.youtube.com/embed/CNv_z-tnwnQ?si=llG-CMXRBG9PG3nF" title="YouTube video player" frameborder="0" allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture; web-share" referrerpolicy="strict-origin-when-cross-origin" allowfullscreen></iframe>
</div>

## Additional Enterprise Pages
## Additional Enterprise pages

In the Enterprise Edition, there's a number of additional pages that give you richer insight and control over your namespaces. To read more about them, check out the page below:

Expand Down
6 changes: 3 additions & 3 deletions content/docs/08.ui/05.blueprints.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,15 +11,15 @@ Ready-to-use examples designed to kickstart your workflow.

---

Blueprints are a curated, organized, and searchable catalog of ready-to-use examples designed to help you kickstart your workflow. Each Blueprint combines code and documentation, and can be assigned several tags for organization and discoverability.
Blueprints are a curated, organized, and searchable catalog of ready-to-use examples designed to help you kickstart your workflow. Each Blueprint combines code and documentation and can be assigned several tags for organization and discoverability.

All Blueprints are validated and documented. You can easily customize and integrate them into your new or existing flows with a single click on the "Use" button.
All Blueprints are validated and documented. You can easily customize and integrate them into your new or existing flows with a single click on the **Use** button.

![Blueprint](/docs/user-interface-guide/blueprints.png)

## Custom Blueprints

You can also create custom blueprints, shared within your organization.
You can also create custom blueprints shared within your organization.

::alert{type="info"}
Custom blueprints require a [commercial license](/pricing).
Expand Down
16 changes: 8 additions & 8 deletions content/docs/08.ui/06.settings.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,17 +6,17 @@ docId: settings

Configure Settings for Kestra.

On the **Settings** page, you will be able to configure the Kestra UI. These configuration options are on a per-user basis.
On the **Settings** page, you are able to configure the Kestra UI. These configuration options are on a per-user basis.

![Kestra User Interface Settings Page](/docs/user-interface-guide/13-Settings.png)


## Main Configuration

Options you can configure under **Main Configuration** include:
- **Default Namespace**: e.g. `company.team`
- **Default Log Level**: e.g. `TRACE`
- **Default Log Display**: Expand all, Collapse all or Expand only failed tasks
- **Default Namespace**: e.g., `company.team`
- **Default Log Level**: e.g., `TRACE`
- **Default Log Display**: Expand all, Collapse all, or Expand only failed tasks
- **Execute the Flow**: In the same tab or in a new tab

---
Expand All @@ -27,7 +27,7 @@ Kestra allows you to have a Light or Dark mode.

You can also specify the Editor to be a separate Light or Dark mode too. In addition, you can adjust the font size and family for the Editor too.

There's also the option to change the environment name and color to help you identify if you have multiple Kestra instances, e.g. `dev` and `prod`.
There's also the option to change the environment name and color to help you identify if you have multiple Kestra instances, for example a `dev` and `prod` environment.

<div class="video-container">
<iframe src="https://www.youtube.com/embed/8hXLiVKUr8k?si=EuxnZcfmVQqxVw45" title="YouTube video player" frameborder="0" allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture; web-share" referrerpolicy="strict-origin-when-cross-origin" allowfullscreen></iframe>
Expand All @@ -38,7 +38,7 @@ Below is a detailed list of the Theme Preferences you can configure:
- **Theme Mode**: Dark or Light
- **Chart Color Scheme**: Classic (red-green) or Kestra (pink-purple)
- **Editor Theme**: Dark or Light
- **Editor Font Size**: e.g. 12 — arbitrary integer number
- **Editor Font Size**: e.g., 12 — arbitrary integer number
- **Editor Font Family**: one of the following:
- Source Code Pro
- Courier
Expand All @@ -47,15 +47,15 @@ Below is a detailed list of the Theme Preferences you can configure:
- Times New Roman Arabic
- SimSun
- **Automatic Code Folding in the Editor**: a toggle, by default toggled off
- **Environment Name**: e.g. dev, staging, prod
- **Environment Name**: e.g., dev, staging, prod
- **Environment Color**: select a color from the color picker

---

## Language and Region

- **Language**: English, German, Spanish, French, Hindi, Italian, Japanese, Korean, Polish, Portuguese, Russian, or Chinese
- **Time Zone**: e.g. Europe/Berlin (UTC+02:00)
- **Time Zone**: e.g., Europe/Berlin (UTC+02:00)
- **Date Format**: choose one of the following formats:
- 2024-09-30T12:44:34+02:00
- 2024-09-30 12:44:34
Expand Down
2 changes: 1 addition & 1 deletion content/docs/08.ui/07.administration/00.triggers.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ icon: /docs/icons/ui.svg

Manage Triggers in Kestra.

The **Triggers** page provides a concise overview of all triggers and their status, and allows you to disable, re-enable, or unlock triggers.
The **Triggers** page provides a concise overview of all triggers and their status, and it allows you to disable, re-enable, or unlock triggers.

![administration_triggers_ui](/docs/user-interface-guide/administration_triggers_ui.png)

Expand Down
2 changes: 1 addition & 1 deletion content/docs/08.ui/07.administration/01.workers.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,6 @@ icon: /docs/icons/ui.svg

Manage Workers in Kestra.

On the **Cluster** page, navigate to **Services** tab. You will see the list of available [workers](../../07.architecture/05.worker.md) by filtering `Worker` from the **Type** dropdown.
On the **Cluster** page, navigate to **Services** tab. On this page, you can see the list of available [workers](../../07.architecture/05.worker.md) by filtering `Worker` from the **Type** dropdown.

![Kestra User Interface Workers](/docs/user-interface-guide/30-Administration-Workers.png)
4 changes: 2 additions & 2 deletions content/docs/08.ui/07.administration/02.stats.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,11 +8,11 @@ Manage Stats in Kestra.

The **Stats** page provides a dashboard of Kestra usage statistics, including the number of namespaces, flows, tasks, triggers, executions, and the total execution duration (in minutes). In the Enterprise Edition, this page also shows the number of users, groups and roles.

The main goal of that section is to keep security in mind — you can either **consider upgrading** to the Enterprise Edition or **activate basic authentication** for a single user directly from the UI. Here is how this page looks like in the Open Source Edition:
The main goal of that section is to keep security in mind — you can either **consider upgrading** to the Enterprise Edition or **activate basic authentication** for a single user directly from the UI. Below is how this page looks like in the Open Source Edition:

![stats_oss](/docs/user-interface-guide/stats_oss.png)

And here is how it looks like in the Enterprise Edition:
Additionally, below is how it looks like in the Enterprise Edition:

![stats_ee](/docs/user-interface-guide/stats_ee.png)

Expand Down
4 changes: 2 additions & 2 deletions content/docs/08.ui/07.administration/03.users.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,9 +10,9 @@ Manage Users in Kestra
This feature requires a [commercial license](/pricing).
::

On the **Users** page, you will see the list of users.
On the **Users** page, you see the list of users.

By clicking on a user id or on the eye icon, you can open the page of a user.
By clicking on a user id or on the magnifying glass icon, you can open the page of a user.

![UI](/docs/user-interface-guide/17-EE-Users.png)

Expand Down
Loading

0 comments on commit 44f212c

Please sign in to comment.