Automation hub, team and org scoped automations#2959
Open
mdlinville wants to merge 2 commits into
Open
Conversation
HiveMind Sessions1 session · 31m · $5.27
View all sessions in HiveMind → Run |
Contributor
There was a problem hiding this comment.
Pull request overview
Adds documentation for the global Automations hub and expands Automations docs to cover Organization- and Team-scoped automations, including where to create them, what events are available at broader scopes, and how to view execution history.
Changes:
- Introduces the Automations hub concept and updates “where to find/create” guidance to include hub-based workflows.
- Adds Organization/Team scope definitions and event availability details (including rate limiting/cooldown note).
- Updates Slack/Webhook automation creation docs and automation history docs to reflect hub + broader scopes.
Reviewed changes
Copilot reviewed 7 out of 7 changed files in this pull request and generated 3 comments.
Show a summary per file
| File | Description |
|---|---|
| snippets/_includes/automations/where-to-find-automations.mdx | Adds the Automations hub as a primary discovery/entry point across scopes. |
| models/automations.mdx | Expands scope model, adds an Automations hub section, and updates limitations text. |
| models/automations/automation-events.mdx | Adds Organization and Team scope sections and contextual notes about triggering behavior. |
| models/automations/create-automations.mdx | Updates creation entry points to include the global Automations hub + scope selection. |
| models/automations/create-automations/webhook.mdx | Adds a note directing readers to hub-based Team/Org scope creation and scope limitations. |
| models/automations/create-automations/slack.mdx | Adds a note directing readers to hub-based Team/Org scope creation and scope limitations. |
| models/automations/view-automation-history.mdx | Adds hub-based guidance for viewing history across scopes, plus registry/project alternatives. |
Comments suppressed due to low confidence (1)
models/automations.mdx:81
- Typo: "webhoook" should be "webhook".
- At the **Team** and **Organization** scopes, the W&B App supports only artifact and collection events. Run-based events aren't available in the App at these scopes. See [Automation events and scopes](/models/automations/automation-events).
## Next steps
- [Automations tutorial](/models/automations/tutorial): Guides you to create a project automation to alert on run failures and a Registry automation to run a webhoook when an alias is added. The tutorial uses the W&B App.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
|
|
||
| ## Limitations | ||
| [Run metric automations](/models/automations/automation-events/#run-metrics-events) and [run metrics z-score change automations](/models/automations/automation-events/#run-metrics-z-score-change-automations) are currently supported only in [W&B Multi-tenant Cloud](/platform/hosting/#wb-multi-tenant-cloud). | ||
| - [Run metric automations](/models/automations/automation-events/#run-metrics-events) and [run metrics z-score change automations](/models/automations/automation-events/#run-metrics-z-score-change-automations) are supported only in [W&B Multi-tenant Cloud](/platform/hosting/#wb-multi-tenant-cloud). |
Contributor
Author
There was a problem hiding this comment.
Good catch — these were pre-existing broken anchors that I inherited when I reworked this line. Fixed in a7f01cb: #run-metrics-events → #run-metrics-change and #run-metrics-z-score-change-automations → #run-metrics-z-score-change (both now resolve; mint broken-links passes clean). Also fixed the "webhoook" typo you flagged in Next steps.
Comment on lines
+20
to
+22
| Automation history is available for automations at any scope. From the global **Automations** hub in the left navigation, click an automation's name to view its execution history alongside its configuration, including for Team-scoped and Organization-scoped automations. See [Automations hub](/models/automations#automations-hub). | ||
|
|
||
| You can also view history from a registry's or project's **Automations** tab. Select the **Registry** or **Project** tab for detailed instructions. |
Contributor
Author
There was a problem hiding this comment.
Agreed. Reworded in a7f01cb to lead with the registry/project tabs ("On any deployment type…") and gate the hub guidance to Multi-tenant Cloud and Dedicated Cloud (Server v0.83.0 and later), since the Automations hub isn't on Self-Managed yet even though execution history is.
Comment on lines
+8
to
+14
| An automation can start when a specific event occurs within an Organization, a Team, a Registry, a Registry collection, or a project. This page describes the events that can trigger an automation within each scope, so you can choose the right trigger when you configure an automation. Learn more about automations in the [Automations overview](/models/automations) or [Create an automation](/models/automations/create-automations). | ||
|
|
||
| Scopes are hierarchical: an Organization contains Teams, which contain projects and registries, which contain collections. An automation observes its event across everything in its scope, including projects, registries, and collections created later. A single event can match automations at more than one scope. Each matching automation triggers independently. | ||
|
|
||
| <Note> | ||
| To protect against excessive triggering at broad scopes, W&B applies a rate limit and a cooldown per automation. These safeguards can delay or skip repeated triggers of the same automation. | ||
| </Note> |
Contributor
Author
There was a problem hiding this comment.
Added in a7f01cb: an availability note on this page stating the Team and Organization scopes are available on Multi-tenant Cloud and Dedicated Cloud (Server v0.83.0+), while Registry and Project scopes are available on all deployment types.
Contributor
|
Preview deployment for your docs. Learn more about Mintlify Previews.
|
Contributor
📚 Mintlify Preview Links📝 Changed (7 total)📄 Pages (7)
🤖 Generated automatically when Mintlify deployment succeeds |
Contributor
🔗 Link Checker ResultsPreview: https://wb-21fd5541-automation-updates-docs-2928-docs-2829.mintlify.site |
- Fix broken anchors in automations.mdx Limitations (run-metrics-change, run-metrics-z-score-change) and fix "webhoook" typo in Next steps. - Add a Team/Org scope availability note to automation-events.mdx. - Qualify hub-based history guidance in view-automation-history.mdx: lead with the always-available registry/project tabs and gate the Automations hub to Multi-tenant/Dedicated (Server v0.83.0+). Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
Contributor
|
Preview deployment for your docs. Learn more about Mintlify Previews.
|
| ## Create an automation | ||
|
|
||
| You can create an automation from the project or registry's **Automations** tab, or directly from a line plot panel in the workspace. | ||
| You can create an automation from the global **Automations** hub in the left navigation, from a project or registry's **Automations** tab, or directly from a line plot panel in the workspace. When you create an automation from the hub, you choose its scope (Organization, Team, Registry, Registry collection, or project). See [Automations hub](/models/automations#automations-hub). |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Description
Docs for Automations Hub, team-scoped automations, and org-scoped automations
Available for early technical review
Fixes DOCS-2928
Fixes DOCS-2929
Testing
mint dev)mint broken-links)