[RUN-4907] Document Azure VM Stop deallocate option and reconcile Azure VM step docs - #1956
Conversation
There was a problem hiding this comment.
🟡 Changes recommended
A few newly introduced doc strings are misleading/typoed (notably the Workflow Steps tip referencing non-existent Create/List steps), and should be corrected for accuracy before merge.
Once you've addressed the issues Copilot identified, you can request another Copilot review.
Pull request overview
Updates the Rundeck Azure plugin documentation to match the current plugin set and behavior, including documenting the new Deallocate option for the Azure / VM / Stop node step and reconciling which steps are Node Steps vs Workflow Steps.
Changes:
- Updated Azure plugins overview table links/rows to match the actual Azure VM and Azure Storage step docs.
- Reworked Azure Workflow Steps docs to focus on the two snapshot workflow steps (and direct VM lifecycle actions to the Node Steps page).
- Updated Azure Node Steps docs headings/screenshots and added documentation for the VM Stop Deallocate option.
File summaries
| File | Description |
|---|---|
| docs/manual/plugins/azure-plugins-overview.md | Refreshes the Azure plugin inventory table to point at the correct step pages/anchors. |
| docs/manual/jobs/job-plugins/workflow-steps/azure.md | Removes non-existent/misplaced VM lifecycle content; documents VM snapshot workflow steps. |
| docs/manual/jobs/job-plugins/node-steps/azure.md | Renames sections to Azure / VM / * conventions, updates screenshots, and documents Stop “Deallocate”. |
Review details
- Files reviewed: 3/15 changed files
- Comments generated: 4
- Review effort level: Lite
💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.
There was a problem hiding this comment.
🟡 Changes recommended
The updated workflow-steps tip text currently points users to non-existent Create/List Node Steps and there are a few inconsistent field/VM label capitalizations that should be corrected to avoid confusing readers.
Once you've addressed the issues Copilot identified, you can request another Copilot review.
Review details
Suppressed comments (5)
Previously missed (3) — in code that hasn't changed since the last review.
docs/manual/jobs/job-plugins/workflow-steps/azure.md:12
- This tip points readers to Node Steps for "Create" and "List", but there are no Azure VM Create/List Node Step sections documented (and no Create/List headings exist under manual/jobs/job-plugins). This can mislead readers into looking for steps that don't exist.
docs/manual/jobs/job-plugins/workflow-steps/azure.md:48 - The field label "VHD prefix" is inconsistently capitalized compared to the surrounding labels (e.g., "Container Name").
docs/manual/jobs/job-plugins/workflow-steps/azure.md:87 - The field label "DISK ID" is inconsistently capitalized compared to other labels on the page and the definition text directly below it.
docs/manual/jobs/job-plugins/node-steps/azure.md:56
- The Async description uses lowercase "vm"; elsewhere this page uses "VM", so this should be capitalized for consistency.
: Should be set to true if the vm should be started asynchronously.
docs/manual/jobs/job-plugins/node-steps/azure.md:63
- The Async description uses lowercase "vm"; elsewhere this page uses "VM", so this should be capitalized for consistency.
: Should be set to true if the vm should be stopped asynchronously.
- Files reviewed: 3/15 changed files
- Comments generated: 1
- Review effort level: Lite
…e VM step docs - Add Deallocate property docs to the Node Steps and Workflow Steps pages for Azure VM Stop. - Correct node-steps/azure.md headings from "Azure / Node / X" to the plugins' real titles, "Azure / VM / X" (Delete/Start/Stop/Restart). - Move Capture Snapshot and add the previously-undocumented Managed Disk Capture Snapshot workflow step to workflow-steps/azure.md, matching their actual WorkflowStep plugin registration. - Remove Create/List and the duplicate Start/Stop sections from workflow-steps/azure.md; those plugins either don't exist in the codebase or are Node Steps, not Workflow Steps. - Fix broken/mislabeled anchors and rows in azure-plugins-overview.md, including the Storage Copy/Delete/List rows which pointed at nonexistent anchors. - Replace all screenshots for the 4 node steps with current ones, and add new screenshots for the 2 workflow steps (previously unillustrated). Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
1103211 to
1361fa2
Compare
Summary
Test plan
npm run docs:devand visually check node-steps/azure.md, workflow-steps/azure.md, and azure-plugins-overview.mdJira: RUN-4907
🤖 Generated with Claude Code