Skip to content

docs: simplify MC packaging to two prerequisites and three steps - #148

Merged
Amir Bredy (ABMFST) merged 1 commit into
mainfrom
docs/mc-quickstart-20261028
Oct 28, 2026
Merged

Amir Bredy (ABMFST) merged 1 commit into
mainfrom
docs/mc-quickstart-20261028

Conversation

@ABMFST

@ABMFST Amir Bredy (ABMFST) commented Oct 28, 2026 •

Copy link
Copy Markdown
Contributor

Summary

  • Replace the long Machine Configuration walkthrough with a short Windows packaging guide: PowerShell 7, GuestConfiguration, and Microsoft.OSConfig >=1.4.10.
  • Reduce the guide from 667 to 122 lines (82% shorter).
  • Show only two module-install commands and three steps: export the MOF, resolve its module version on a copy, and create an Audit ZIP.
  • Correct the separate DSC-module installation requirement: ConfigForge already supplies a compiled MOF. Link the full authoring guidance for other scenarios.
  • Link testing and Azure deployment as optional follow-ups instead of embedding their setup, signing, Storage, and policy scripts in the basic path.
  • Preserve minimum-version enforcement, exact module binding, source-MOF preservation, Audit-only packaging, immutable-package guidance, troubleshooting anchors, and the historical-helper warning.
  • Update documentation contracts and the unreleased notes. No product, dependency, lockfile, release-version, or edition changes.

Validation

  • All three PowerShell examples parsed; six isolated scenarios passed: exact minimum/newest module selection, missing/outdated modules, missing MOF, and already-resolved input.
  • All three existing incoming section anchors remain valid; whitespace checks passed.
  • All hosted PR checks passed, including documentation contracts, lint, application tests/builds, Windows smoke, CodeQL, Markdown, and mdBook. No local Node.js/npm.
  • Real Windows packaging probe passed using the exact guide examples, the real ConfigForge MOF exporter, PowerShell 7.6.7, GuestConfiguration 4.12.0, and Microsoft.OSConfig 1.4.11. Zero PSDesiredStateConfiguration modules were visible or loaded in the isolated packaging session. The source MOF was unchanged, and the ZIP bundled exactly the resolved OSConfig version.
  • The disposable runner temporarily preapproved the noninteractive Gallery prompt, then restored that setting. No modules were installed on the user's machine; no remediation or Azure deployment was performed. The probe workflow is confined to a temporary verification branch, not this PR.

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>

Copilot-Session: b57352bc-2fa6-4f21-bf28-d72b093d3c10
@ABMFST
Amir Bredy (ABMFST) marked this pull request as ready for review October 28, 2026 13:40
@ABMFST
Amir Bredy (ABMFST) merged commit 31d8b05 into main Oct 28, 2026
11 checks passed
@ABMFST
Amir Bredy (ABMFST) deleted the docs/mc-quickstart-20261028 branch October 28, 2026 13:40
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant