[DOCS-1917][DOCS-1126] Automations doc revamp#2249
Conversation
📚 Mintlify Preview Links✨ Added (12 total)📄 Pages (12)
📝 Changed (29 total)📄 Pages (28)
⚙️ 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-docs-1917.mintlify.app |
mdlinville
changed the title
There was a problem hiding this comment.
I think that because that <View> component really only creates a switcher off to the right-hand side that it's fairly inadequate in terms of visibility for the Tutorial (as seen on https://wb-21fd5541-docs-1917.mintlify.app/models/automations/tutorial). Also being disembodied from the content that way severs the switcher's connection to what actually is getting changed.
Inline tabs that get linearly and predictably intercepted by screenreaders and reliably show up in mobile resolutions seem quite a lot better to me as a "switching" mechanism. And that's if we even want to use a switching mechanism really -- in my opinion it's always best to just have separate pages and use include files if something needs repeating, or longer pages with include files. It preserves printability, it advertises contents in the most visible/navigational way, it saves clicks, and it improves SEO to avoid hiding content behind expanders and switchers. But I'll climb down from my soapbox now :P :)
That all aside, <View> just has a way to go.
…page and individual tutorials
I agree with you about views. I reported some friction about the component to Mintlify. In this PR, I've made some adjustments:
PTAL and let me know what you think. Still to do: Get the example notebook approved and committed to the |
| @@ -0,0 +1,7 @@ | |||
| W&B Automations follow a simple pattern: when an **event** occurs and optional **conditions** are met, an **action** runs automatically. For example: | |||
| - When a run fails (event), notify a Slack channel (action). | |||
There was a problem hiding this comment.
Can we add a space between the diagram and text? It feels congested? (This applies to the next diagram, too).
|
|
||
| ## Create a project automation | ||
|
|
||
| This automation is scoped to a **project**. When a run in that project transitions to **Failed**, W&B sends a Slack notification. |
There was a problem hiding this comment.
Which automation? Suggest adding a word or two to clarify.
|
|
||
| ## Test the automation | ||
|
|
||
| Start a run in the project and mark it failed (for example, `run.finish(exit_code=1)`). Within a short time you should see a Slack message with the run link and status. |
There was a problem hiding this comment.
Nit: Add a dummy code snippet showing how to do this? Also, not sure what you mean by "start a run in the project"? Do you mean "create a run and log it to the project"?
|
|
||
| ## Create a registry automation | ||
|
|
||
| This automation is scoped to a **registry**. When an artifact in any collection in that registry gets a specific alias (for example, `production`), W&B sends a POST request to your webhook. |
|
|
||
| ## Test the automation | ||
|
|
||
| Add the alias (for example, `production`) to an artifact version in the registry (UI or API). Your webhook endpoint should receive a POST with the payload you configured. |
There was a problem hiding this comment.
Nit: Add code snippet showing how to do this.
| For more detail, see [Create a webhook automation](/models/automations/create-automations/webhook#create-an-automation) (Registry tab). | ||
| </Tab> | ||
| <Tab title="Python"> | ||
| Use the public API to create a registry-scoped automation that fires when an alias matching a pattern is added. You need the registry (or a collection in it) for scope and a webhook integration. |
There was a problem hiding this comment.
"fires" felt aggressive...suggest using another term?
| Use the public API to create a registry-scoped automation that fires when an alias matching a pattern is added. You need the registry (or a collection in it) for scope and a webhook integration. | |
| Use the public API to create a registry-scoped automation that starts when an alias matching a pattern is added. You need the registry (or a collection in it) for scope and a webhook integration. |
- Remove manual English-language support pages:
- support-tags.mdx
- models/support.mdx
- inference/api-reference/errors.mdx
- weave/guides/troubleshooting.mdx
- Update docs.json
- Remove models/support entry (English only)
- Add redirects to cover the removed English-language
support pages
- Fix existing now-broken redirects from old
/guides/ and /sweeps/faq pages
- Update redirect source 'models/support/rotate_revoke_access'
to '/models/support/rotate_revoke_access'
- Update the redirect destination for '/models/support/find_api_key'
to '/models/support/rotate_revoke_access'
- Update destination for redirect '/inference/support' to '/inference'
- Remove loopy redirect
- Remove unrelated changes that belong with PR #2249
4 participants
Description
Automations doc revamp
Depends on a Python notebook added in wandb/examples#618
Testing
mint dev)mint broken-links)Related issues