Add cost governance page to best practices - #5145
Conversation
Publishes a new best-practices guide covering cost attribution via Namespace tagging, budget forecast/burn-rate tracking, and anomaly detection on usage, built on the Billing API and OpenMetrics.
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
There was a problem hiding this comment.
Pull request overview
Adds cost-governance guidance to Temporal Cloud best practices.
Changes:
- Documents cost attribution, forecasting, and anomaly detection.
- Adds the guide to navigation and the best-practices index.
- Clarifies which practices are Cloud-specific.
Reviewed changes
Copilot reviewed 3 out of 3 changed files in this pull request and generated 3 comments.
| File | Description |
|---|---|
sidebars.js |
Adds the guide to navigation. |
docs/best-practices/index.mdx |
Links and categorizes the guide. |
docs/best-practices/cost-governance.mdx |
Provides the cost-governance framework. |
💡 Configure MCP servers for context-aware, tailored reviews. Learn more in the docs.
📖 Docs PR preview links |
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
looks ok Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
|
|
looks ok Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
| | [Actions in Event History](/cloud/actions-usage#actions-in-workflows) | Per Workflow Execution | Estimating Actions for a specific execution | Account Owners, Global Admins, Namespace Admins, Developers, and Read-Only users | | ||
| | [Action metric](/cloud/metrics/openmetrics/metrics-reference#temporal_cloud_v1_billable_action_count) | 1-minute, by Workflow and Action type | Near-real-time usage behavior, alerting, debugging | Service account with the Metrics Read-Only role | | ||
|
|
||
| ### Actions |
There was a problem hiding this comment.
Do we need to have this section when we already have a much more detailed explanation linked /cloud/actions
I do feel like best practice documents should assume a basic knowledge of what an action is an doesn't need these conceptual sections
There was a problem hiding this comment.
Going to leave this one as-is for now — thinking this is a common point of confusion so Tlo likely included the repetition here on purpose, even with /cloud/actions one click away. Open to revisiting if it still feels redundant on another pass.
Drops the "where did this bill come from" framing in favor of a more neutral statement of the guide's goal, and renames the three use-case headings to state the recommendation directly, matching the verb-based heading style used elsewhere in best-practices.
Summary
sidebars.jsand links it from the best-practices index.Opened as a draft for docs-team review of tone/placement before merging.
Test plan
vale --config .vale-ci.ini docs/best-practices/cost-governance.mdx docs/best-practices/index.mdx— 0 issuesyarn build— succeedsyarn check-links— no new failures introduced by this page (remaining findings are pre-existing checker artifacts affecting every best-practices page: trailing-slash fragment-redirect noise, and live-site/GitHub-source 404s expected for any unmerged page)yarn check:orphans— clean