Skip to content

Commit

Permalink
Update UI Guide (#466)
Browse files Browse the repository at this point in the history
* [docs] update setting page

* [docs] add administration page and refactor users, groups, roles in it

* [feature] add deprecated on Template page UI

* [fix] edit screenshots to reflect change in setting bar order
  • Loading branch information
Ben8t authored Aug 29, 2023
1 parent f65b1c9 commit 5feb621
Show file tree
Hide file tree
Showing 8 changed files with 77 additions and 52 deletions.
7 changes: 6 additions & 1 deletion content/docs/04.user-interface-guide/03-templates.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,12 @@
---
title: Templates Page
title: Templates Page (deprecated)
---

::alert{type="warning"}
⚠️ Templates are deprecated. Please use subflows instead of templates. See the [Migrations section](../15.migrations/templates.md) explaining how you can migrate from templates to subflows.
::


On the **Templates** page, you will see a list of templates.

When clicking on a template id or on the eye icon, you can open the page of a template.
Expand Down
71 changes: 71 additions & 0 deletions content/docs/04.user-interface-guide/10-administration.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,71 @@
---
title: Administration Page
---

## Users Page (EE)

::alert{type="warning"}
This is an [Enterprise Edition](https://kestra.io/enterprise) feature.
::

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

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

![Kestra User Interface Home Page](/docs/user-interface-guide/17-EE-Users.png)

A **Create** button allows creating a new user and managing his access to Kestra.

![Kestra User Interface Home Page](/docs/user-interface-guide/18-EE-Users-Create.png)

## Groups Page (EE)

::alert{type="warning"}
This is an [Enterprise Edition](https://kestra.io/enterprise) feature.
::

On the **Groups** page, you will see a list of groups.

When clicking on a group id or on the eye icon, you can open the page of a group.

![Kestra User Interface Home Page](/docs/user-interface-guide/19-EE-Groups.png)

A **Create** button allows creating a new group and managing its access to Kestra.

![Kestra User Interface Home Page](/docs/user-interface-guide/20-EE-Groups-Access.png)


## Roles Page (EE)


::alert{type="warning"}
This is an [Enterprise Edition](https://kestra.io/enterprise) feature.
::

On the **Roles** page, you will see a list of roles.

When clicking on a role id or on the eye icon, you can open the page of a role.

![Kestra User Interface Home Page](/docs/user-interface-guide/21-EE-Roles.png)

A **Create** button allows creating a new role.

![Kestra User Interface Home Page](/docs/user-interface-guide/22-EE-Roles-Create.png)

## Triggers Page

On the **Triggers** page, you can see an overview of the various triggers of your instance and troubleshooting capabilities.

![Kestra User Interface Trigger](/docs/user-interface-guide/31-Administration-Triggers.png)


## Workers Page (EE)

::alert{type="warning"}
This is an [Enterprise Edition](https://kestra.io/enterprise) feature.
::

On the **Workers** page, you will see the list of available [worker groups](/docs/architecture#worker-group-ee).

![Kestra User Interface Worker Groups](/docs/user-interface-guide/30-Administration-Workers.png)

17 changes: 0 additions & 17 deletions content/docs/04.user-interface-guide/10-users.md

This file was deleted.

17 changes: 0 additions & 17 deletions content/docs/04.user-interface-guide/11-groups.md

This file was deleted.

17 changes: 0 additions & 17 deletions content/docs/04.user-interface-guide/12-roles.md

This file was deleted.

Binary file modified public/docs/user-interface-guide/13-Settings.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

1 comment on commit 5feb621

@vercel
Copy link

@vercel vercel bot commented on 5feb621 Aug 29, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Successfully deployed to the following URLs:

kestra-io – ./

kestra-io.vercel.app
kestra-io-kestra.vercel.app
kestra-io-git-main-kestra.vercel.app

Please sign in to comment.