[DOCS-1453] Docs for run status change automations #1329
Conversation
Deploying docs with
|
| Latest commit: |
2064576
|
| Status: | ✅ Deploy successful! |
| Preview URL: | https://5927935f.docodile.pages.dev |
| Branch Preview URL: | https://docs-1453.docodile.pages.dev |
619f488 to
4506ff0
Compare
Noah's feedback Typos Co-authored-by: Noah Luna <15202580+ngrayluna@users.noreply.github.com>
There was a problem hiding this comment.
Some minor comments.
Also, the link at the bottom of this _index.md page (In Limitations) redirects to /guides/core/automations/automation-events/#run-metrics-events but that doesn't exit. I think we mean to redirect to /guides/core/automations/automation-events/#run-metrics-change?
| @@ -83,7 +94,7 @@ For **Run metrics threshold met** events, you configure: | |||
|
|
|||
| For example, trigger an automation when average `accuracy` is above `.6`. | |||
|
|
|||
| #### Change threshold | |||
| ##### Change threshold | |||
There was a problem hiding this comment.
This font looks really small...maybe we bump up the size in the CSS?
There was a problem hiding this comment.
We rarely need an H5. I dithered just making them bold but thought it would be useful to have a section-level link. Let me see how the sizes are defined and see if it is feasible to adjust it.
There was a problem hiding this comment.
Yeah that's what I was afraid of, we really don't have much room to adjust the size of H5. I suspect that H4-H5 is more important to get right than H5-H6, visually. WDYT?
// Heading sizes
h1, .td-content h1 { font-size: 32px !important; }
h2, .td-content h2 { font-size: 24px !important; }
h3, .td-content h3 { font-size: 20px !important; }
h4, .td-content h4 { font-size: 16px !important; }
h5, .td-content h5 { font-size: 14px !important; }
h6, .td-content h6 { font-size: 12px !important; }There was a problem hiding this comment.
content/en/guides/core/automations/create-automations/webhook.md
Outdated
Show resolved
Hide resolved
Co-authored-by: Noah Luna <15202580+ngrayluna@users.noreply.github.com>
content/en/guides/core/automations/create-automations/webhook.md
Outdated
Show resolved
Hide resolved
Currently, H5 and H6 are each smaller than the content base font of 16px and this looks off.
| h4, .td-content h4 { font-size: 16px !important; } | ||
| h5, .td-content h5 { font-size: 14px !important; } | ||
| h6, .td-content h6 { font-size: 12px !important; } | ||
| h4, .td-content h4 { font-size: 18px !important; } |
There was a problem hiding this comment.
@johndmulhausen PTAL, context at https://github.com/wandb/docs/pull/1329/files#r2162679831.
There was a problem hiding this comment.
I think it looks give how you have it here :) The preview looks like you're striking the best balance you can. I leave Noah to do the final docs team approval though.
DOCS-1453 Docs for run status change automations
Filed https://wandb.atlassian.net/browse/DOCS-1550 to get an updated graphic as a fast follow.
Preview: https://docs-1453.docodile.pages.dev/guides/core/automations/automation-events/#run-events
Ready for peer review. Currently, marked DO-NOT-MERGE while the proposed CSS adjustments are under review.