Skip to content

Commit

Permalink
chore(docs): Update Flow page (#2155)
Browse files Browse the repository at this point in the history
* chore(docs): Update Flow page

Handle kestra-io/kestra#2065 & kestra-io/kestra#6533

* edit sentence for conciseness
  • Loading branch information
aj-emerich authored Jan 31, 2025
1 parent 2abc1ad commit 3261df8
Showing 1 changed file with 9 additions and 7 deletions.
16 changes: 9 additions & 7 deletions content/docs/08.ui/01.flows.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,13 +16,15 @@ A **Flow** page has multiple tabs that allow you to: see the flow topology, all

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

## Editor
## Edit

The Editor gives you a rich view of your workflow, as well as Namespace Files. The Editor allows you to add multipl views to the side:
The Edit interface provides a rich view of your workflow, as well as Namespace Files. The editor allows you to add multiple views to the side of your flow's source code:
- Documentation
- Topology
- Blueprints

Additionally, from the **Actions** menu, you can export your flow as a YAML file, delete, or copy your flow.

<div class="video-container">
<iframe src="https://www.youtube.com/embed/o-d-GaXUiKQ?si=NR_-CYBsKhCqUNQ1" 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>
Expand All @@ -35,31 +37,31 @@ 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 updates to reflect the specific task type documentation.
The documentation view displays 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)

::alert{type="warning"}
Note that if you use the [Brave browser](https://brave.com/), you may need to disable the Brave Shields to make the Editor work as expected. Specifically, to view the task documentation, you need to set the `Block cookies` option to `Disabled` in the Shields settings: `brave://settings/shields`.
Note that if you use the [Brave browser](https://brave.com/), you may need to disable the Brave Shields to make the editor work as expected. Specifically, to view the task documentation, you need to set the `Block cookies` option to `Disabled` in the Shields settings: `brave://settings/shields`.

![Brave cookies](/docs/ui/brave.png)
::

### Blueprints View

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.
The blueprint view gives you example flows to copy 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. For more details, check out the [revisions concept guide](../05.concepts/03.revision.md).
You can view the history of your flow under the Revisions tab. For more details, see [Revisions](../05.concepts/03.revision.md).

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

## Dependencies

The Dependencies page allows you to view what other flows depend on the selected flow, as well as flows that the selected flow depends on. It gives you an easy way to navigate between them as well.
The Dependencies page shows the relationship dependencies between other flows and the selected flow. It gives you an easy way to navigate between them as well.

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

Expand Down

0 comments on commit 3261df8

Please sign in to comment.