Skip to content

Commit bc3ed11

Browse files
authored
Articles about Run page + Groups & Folders (windmill-labs#151)
* Runs menu article * Article about groups and folders
1 parent 10abf28 commit bc3ed11

File tree

12 files changed

+98
-4
lines changed

12 files changed

+98
-4
lines changed

blog/2023-03-20-handler-slack-commands/index.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -169,7 +169,7 @@ All commands (except the default one) of this slackbot deal with [resources](htt
169169
170170
One specificity of triggering resources from Slack is that **you have to let Windmill know Slack can interact with them**.
171171
172-
You won't be able to have Slack interact with your resources and variables before adding them to the `slack` group that was automatically created by Windmill after you set up your Slack workspace on Windmill.
172+
You won't be able to have Slack interact with your resources and variables before adding them to the `slack` [group](https://www.windmill.dev/docs/core_concepts/groups_and_folders) that was automatically created by Windmill after you set up your Slack workspace on Windmill.
173173
174174
:::tip Allow resources to be triggered from Slack
175175
@@ -181,7 +181,7 @@ To give the permission, go to "Resources" (and "Variables") menu, click on `Shar
181181
182182
<br/>
183183
184-
One simplier way to handle permissions is to host resources and variables on a folder that is part of the group `slack`.
184+
One simplier way to handle permissions is to host resources and variables on a [folder](https://www.windmill.dev/docs/core_concepts/groups_and_folders#folders) that is part of the [group](https://www.windmill.dev/docs/core_concepts/groups_and_folders#groups) `slack`.
185185
186186
<br/>
187187
Loading
Loading
Loading
Loading
Lines changed: 52 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,52 @@
1+
---
2+
id: monitor_past_and_future_runs
3+
title: Monitor Past and Future Runs
4+
---
5+
6+
# Monitor Past and Future Runs
7+
8+
Each workspace has a dedicated Runs menu that allows you to visualise all past and future runs.
9+
10+
<video
11+
className="border-2 rounded-xl object-cover w-full h-full"
12+
autoPlay
13+
loop
14+
controls
15+
id="main-video"
16+
src="/videos/runs-menu.mp4"
17+
/>
18+
19+
## Aggregated View
20+
21+
From the Runs menu, you have a time series where you can choose the time slot you want to monitor. The green (resp. red) dots being the tasks that succeeded (resp. failed). You can play with the level of details by picking "All", "Runs", "Previews" or "Dependecies".
22+
23+
![Time series](./1-runs-menu.png "Time series")
24+
25+
## Details per Run
26+
27+
Each run on the menu is clickable. The run page allows you to visualize the state of the run, the inputs, reasons of success/failure etc.
28+
29+
View of a past run:
30+
31+
![Details per run](./2-detail-per-run.png "Details per run")
32+
33+
You can also have a view on runs that are [scheduled](../../getting_started/8_scheduling_scripts_flows/index.md) from the run menu, with a view on arguments used and next trigger.
34+
35+
View of a scheduled run:
36+
37+
![Schedule run](./3-scheduled-run.png)
38+
39+
## Filters
40+
41+
There are multiple ways to filter the Runs menu:
42+
- by Datetime
43+
- Success / Failure
44+
- Skipped / Not skipped
45+
- Runs / Previews / Dependencies / Alls
46+
- by [Path](../../reference/index.md#path)
47+
- by Arguments
48+
- by Result
49+
50+
Example of a few filters being used:
51+
52+
![Filters](./4-filters.png "Filters")
Loading
Loading
Loading
Lines changed: 42 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,42 @@
1+
---
2+
id: groups_and_folders
3+
title: Groups and Folders
4+
---
5+
6+
# Groups and Folders
7+
8+
Groups and folders are made to split and share permissions within workspace.
9+
10+
## Groups
11+
12+
Groups are **users** classed together. Users within a same group (you can also call it role) will have homogenous permissions. Same users can be in multiple groups at the same time.
13+
14+
![Groups](./1-groups.png "Groups")
15+
16+
As for users, groups can be given 3 levels of permission for a given item:
17+
- Viewer: read-only access.
18+
- Writer: read and write access.
19+
- Admin: read and write access, and can manage permissions and new admins.
20+
21+
## Folders
22+
23+
Folders allow to group **items** such as scripts/flows/resources/schedule together and to grant homogenous (Role-based access control) permissions to groups and individual users towards them.
24+
25+
![Folders](./3-folders.png "Folders")
26+
27+
28+
## Groups and Folders together
29+
30+
Groups can be part of folders, not the other way around.
31+
32+
It means that if you want to allow a team to use a given resource, you can save it in a folder, and either add each member of the team as a user in the folder, or add a group containing the whole team to the folder.
33+
34+
:::tip Example
35+
36+
For example, you [build a Slackbot](https://www.windmill.dev/blog/handler-slack-commands) and want it to use manipulate some resources. Then you should add the group "slack" (automatically created once you [configured Slack on Windmill](../../integrations/slack.md) to the given resource).
37+
38+
<br/>
39+
40+
![Groups within folders](./2-groups-within-folders.png "Groups within folders")
41+
42+
:::

0 commit comments

Comments
 (0)