microsoft / finops-toolkit

Tools and resources to help you adopt and implement FinOps capabilities that automate and extend the Microsoft Cloud.
https://aka.ms/finops/toolkit
MIT License
282 stars 93 forks source link

Generate PowerShell docs from code #935

Open flanakin opened 1 month ago

flanakin commented 1 month ago

🛠️ Description

Generate PowerShell documentation from code comments.

📋 Checklist

🔬 How did you test this change?

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

🙋‍♀️ 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)
  • [x] ❎ Log not needed (small/internal change)

📖 Did you update documentation?

  • [x] ✅ Public docs in docs (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)
arthurclares commented 3 weeks ago

Removed assignment and "Needs Review" tag while the PR is still on Draft