Enhance documentation for Azure Optimization Engine - #2267
Enhance documentation for Azure Optimization Engine#2267Hélder Pinto (helderpinto) wants to merge 11 commits into
Conversation
There was a problem hiding this comment.
Pull request overview
This PR improves Microsoft Learn documentation for the Azure Optimization Engine (AOE) in the FinOps Toolkit by adding a dedicated reference page and wiring it into navigation and the changelog. It also includes a functional deployment template change removing a legacy Automation variable.
Changes:
- Added a new AOE “Reference” doc covering runbooks, schedules, variables, and data tables.
- Updated AOE customization guidance and the toolkit changelog/TOC to point to the new reference content.
- Removed the
AzureOptimization_LogAnalyticsWorkspaceKeyAutomation variable from the AOE nested deployment template.
Reviewed changes
Copilot reviewed 5 out of 5 changed files in this pull request and generated 5 comments.
Show a summary per file
| File | Description |
|---|---|
| src/optimization-engine/azuredeploy-nested.bicep | Removes a legacy Automation variable from the deployment template. |
| docs-mslearn/toolkit/optimization-engine/reference.md | Adds the new AOE reference documentation page. |
| docs-mslearn/toolkit/optimization-engine/customize.md | Links readers to the new reference page for the full variable list. |
| docs-mslearn/toolkit/changelog.md | Announces the new AOE reference page and updates ms.date. |
| docs-mslearn/TOC.yml | Adds the new reference page to the AOE documentation TOC. |
💡 Add a code-review agent skill for context-aware, tailored reviews. Learn more in the docs.
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
Brett Wilson (MSBrett)
left a comment
There was a problem hiding this comment.
Two publish-facing defects need correction: the page renders with "Runbooks" as its heading instead of a reference title, and its only in-page link is broken. The remaining comments are non-blocking Microsoft style and navigation improvements.
- Add missing page-level H1 so the reference page renders with its correct title instead of "Runbooks" - Fix broken #-variables anchor left over from emoji-heading cleanup - Improve title metadata for search/browser-tab clarity - Add serial commas in description/customer intent - Add Related content section matching sibling AOE articles - Make the customize.md variables cross-link meaningful out of context and deep-link to the Variables section - Fix changelog citation period placement to match file convention - Bump ms.date on touched files per repo convention Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>
…ation article (after MSBrett review)
…into/finops-toolkit into helderpinto/dev/docs2608
…into/finops-toolkit into helderpinto/dev/docs2608
🛠️ Description
This pull request introduces documentation improvements to the FinOps toolkit, primarily by adding a comprehensive reference for the Azure Optimization Engine (AOE) and updating related documentation to reflect this addition. These changes enhance the discoverability and usability of AOE configuration details.
Documentation enhancements:
toolkit/optimization-engine/reference.md) to the AOE section in the table of contents, providing comprehensive documentation for runbooks, schedules, variables, Log Analytics tables, and SQL Database tables.Deployment fixes:
AzureOptimization_LogAnalyticsWorkspaceKeyautomation variable from deployment (leftover of upgrade to DCR-based ingestion) and updated variables documentation accordingly.Changelog update:
ms.datefield inchangelog.mdto reflect the latest documentation update.Fixes #1271
📋 Checklist
🔬 How did you test this change?
📦 Deploy to test?
🙋♀️ Do any of the following that apply?
📑 Did you update
docs/changelog.md?📖 Did you update documentation?