[weave] Alerts on monitors page DOCS-1938#2261
Conversation
📚 Mintlify Preview Links✨ Added (1 total)📄 Pages (1)
📝 Changed (1 total)⚙️ Other (1)
🤖 Generated automatically when Mintlify deployment succeeds |
🔗 Link Checker Results✅ All links are valid! No broken links were detected. Checked against: https://wb-21fd5541-alert-on-monitors-docs-1938.mintlify.app |
There was a problem hiding this comment.
Very comprehensive and clear from my side!
There are some minor considerations like the aggregation performance of scores (if the aggregation horizon for scores gets too long then performance will lack), alerting on feedback, scores, cost, latency but this will change over time anyways.
mdlinville
left a comment
mdlinville
left a comment
There was a problem hiding this comment.
First pass review. A couple nits and a structural question / suggestion. I think we may be able to single-source some content, but the Weave flow doesn't seem 1:1 with the Models project flow, so maybe we need to handle it a bit differently than just linking out to the Models top-level pages. Also the Models content is undergoing a major revamp that you may be able to glean some benefit from, in #2249 . It seems like your doc may land first, so I could adapt that to what you end up with.
|
|
||
| ## Create an automation | ||
|
|
||
| Create an automation in three steps: configure the triggering event, select the action to perform, and review a summary before saving. |
There was a problem hiding this comment.
Is it necessary to separate the review step? I wonder if we can converge on a way to explain it. I've been working on an automation doc revamp and here is what I came up with. Interested in your thoughts. The Mermaid diagrams are externalized to snippets.
There was a problem hiding this comment.
by "separate the review step" I assume you mean the third step I mention? since it is a 3 part modal, and the 3rd pane of the modal (sorry, drawer ;) ) is to review, i think it would be more confusing not to separate it.
As for the link, there are a lot of pages in that PR you link - could you be more specific to what part your comparing ? thx
There was a problem hiding this comment.
I don't think the reader is going to hold you to it in this summary / mental map builder. I would consider the confirmation to be the last substep of step 2.
|
|
||
| The new automation appears in the Automations table on the Automations page. | ||
|
|
||
| ## Create an automation from a monitor |
There was a problem hiding this comment.
This is the section I meant for step 3 from above.
There was a problem hiding this comment.
step 3 i didn't really feel fit(/didn't follow) since it was in a section titled Prerequisites for creating an automation - kinda cyclic/recursive. (e.g citing the thing as step 3 in prereqs for the thing the prereq is a prereq of)
maybe i need to clarify this, but 'creating an automation from a monitor' is just a minor subset of steps from 'creating a automation' (e.g. it is a shortcut of one selection box). its an alternative method. It's frankly not very useful, but mentioned for completeness.
There was a problem hiding this comment.
Before you can create the automation in Weave, you need a) a monitor, and b) either a webhook or a Slack integration configured in your team. That's what I mean. Maybe we are on the same page after Slack conversation.
Co-authored-by: Matt Linville <matt.linville@wandb.com>
Co-authored-by: Matt Linville <matt.linville@wandb.com>
| @@ -19,12 +19,10 @@ Create an automation in three steps: configure the triggering event, select the | |||
|
|
|||
| ### Prerequisites | |||
|
|
|||
| Automations can be sourced from either Ops or Monitors. If you want to alert on a monitor, your [monitor](/weave/guides/evaluation/monitors) should be created prior to creating the automation. | |||
| The triggering event (such as an Op or a monitor) and the action (such as a Slack integration) should exist prior to creating the automation that connects them. | |||
There was a problem hiding this comment.
This is kind of passive (should exist) and kind of redefines what the word prerequisite means.
mdlinville
left a comment
mdlinville
left a comment
There was a problem hiding this comment.
This looks really good. I'll go ahead and approve so I don't block you. I can tag you when I am working on integrating this content into my WIP.
3 participants
Description
New automations feature being released for Weave. (new side nav feature with new docs page to discuss it)
Testing
mint dev)mint broken-links)Related issues