Skip to content

Enhance documentation for Azure Optimization Engine - #2267

Open
Hélder Pinto (helderpinto) wants to merge 11 commits into
microsoft:devfrom
helderpinto:helderpinto/dev/docs2608
Open

Enhance documentation for Azure Optimization Engine#2267
Hélder Pinto (helderpinto) wants to merge 11 commits into
microsoft:devfrom
helderpinto:helderpinto/dev/docs2608

Conversation

@helderpinto

@helderpinto Hélder Pinto (helderpinto) commented Aug 18, 2026

Copy link
Copy Markdown
Member

🛠️ 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:

  • Added a new "Reference" page (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.
  • Announced the addition of the AOE reference documentation in the changelog, highlighting its coverage of runbooks, schedules, variables, and more.
  • Updated the AOE customization guide to direct users to the new reference page for a complete list of configuration variables.

Deployment fixes:

  • Removed AzureOptimization_LogAnalyticsWorkspaceKey automation variable from deployment (leftover of upgrade to DCR-based ingestion) and updated variables documentation accordingly.

Changelog update:

  • Updated the ms.date field in changelog.md to reflect the latest documentation update.

Fixes #1271

📋 Checklist

🔬 How did you test this change?

  • 🤏 Lint tests
  • 🤞 PS -WhatIf / az validate
  • 👍 Manually deployed + verified
  • 💪 Unit tests
  • 🙌 Integration tests

📦 Deploy to test?

  • Hubs + ADX (managed)
  • Hubs + Fabric (manual) — URI:
  • Hubs (manual)
  • Hubs (no data)
  • Workbooks
  • Alerts

🙋‍♀️ Do any of the following that apply?

  • 🚨 This is a breaking change.
  • 🤏 The change is less than 20 lines of code.

📑 Did you update docs/changelog.md?

  • ✅ Updated changelog (required for dev PRs)
  • ➡️ Will add log in a future PR (feature branch PRs only)
  • ❎ Log not needed (small/internal change)

📖 Did you update documentation?

  • ✅ Public docs in docs (required for dev)
  • ✅ Public docs in docs-mslearn (required for dev)
  • ✅ Internal dev docs in docs-wiki (required for dev)
  • ✅ Internal dev docs in src (required for dev)
  • ➡️ Will add docs in a future PR (feature branch PRs only)
  • ❎ Docs not needed (small/internal change)

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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_LogAnalyticsWorkspaceKey Automation 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.

Comment thread docs-mslearn/toolkit/optimization-engine/reference.md Outdated
Comment thread docs-mslearn/toolkit/optimization-engine/reference.md Outdated
Comment thread docs-mslearn/toolkit/optimization-engine/reference.md Outdated
Comment thread docs-mslearn/toolkit/optimization-engine/customize.md Outdated
Comment thread src/optimization-engine/azuredeploy-nested.bicep
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>

@MSBrett Brett Wilson (MSBrett) left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

Comment thread docs-mslearn/toolkit/optimization-engine/reference.md Outdated
Comment thread docs-mslearn/toolkit/optimization-engine/reference.md Outdated
Comment thread docs-mslearn/toolkit/optimization-engine/reference.md Outdated
Comment thread docs-mslearn/toolkit/optimization-engine/reference.md Outdated
Comment thread docs-mslearn/toolkit/optimization-engine/customize.md Outdated
Comment thread docs-mslearn/toolkit/changelog.md Outdated
@microsoft-github-policy-service microsoft-github-policy-service Bot added Needs: Attention 👋 Issue or PR needs to be reviewed by the author or it will be closed due to no activity and removed Needs: Review 👀 PR that is ready to be reviewed labels Aug 21, 2026
- 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>
@microsoft-github-policy-service microsoft-github-policy-service Bot added Needs: Review 👀 PR that is ready to be reviewed and removed Needs: Attention 👋 Issue or PR needs to be reviewed by the author or it will be closed due to no activity labels Aug 22, 2026
@MSBrett Brett Wilson (MSBrett) added Status: ▶️ Ready Issue is ready for a dev to start work and removed Needs: Review 👀 PR that is ready to be reviewed labels Aug 22, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Skill: Documentation Documentation updates Status: ▶️ Ready Issue is ready for a dev to start work Tool: Optimization Engine Azure Optimization Engine

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Document each Log Analytics table and the Automation runbooks contributing to the respective data ingestion

5 participants