Skip to content

docs: simplify customer onboarding and require OSConfig 1.4.10 for MC packages - #142

Merged
Amir Bredy (ABMFST) merged 1 commit into
mainfrom
docs/customer-start-20261015
Oct 15, 2026
Merged

Amir Bredy (ABMFST) merged 1 commit into
mainfrom
docs/customer-start-20261015

Conversation

@ABMFST

Copy link
Copy Markdown
Contributor

Summary

Make the README and documentation site easier to follow without hiding
capabilities, experimental status, support limits, or deployment risks.

  • Lead with downloading the appropriate edition and creating a first
    baseline, rather than source builds and Azure packaging internals.
  • Separate Windows/Linux Full from Apple Silicon macOS Author, and make
    authoring without the OSConfig CLI, administrator rights, or Azure clear.
  • Present comparison, benchmark mapping, evidence exports, local device
    operations, and Azure Machine Configuration as optional next steps.
  • Distinguish a baseline/manifest, benchmark coverage, device Audit, and an
    Audit Pack so a report or matching score is not mistaken for device
    compliance.
  • Keep technical reference chapters and existing URLs, with clearer
    customer-oriented navigation.
  • Remove stale release contradictions and obsolete first-run instructions.

Machine Configuration packaging prerequisite

Microsoft.OSConfig PowerShell module 1.4.10 or newer is required on the
machine creating the MC package.
This is separate from the PowerShell 7
runtime, the GuestConfiguration packaging toolkit, and the oscfg CLI.

Installation and selection examples enforce the minimum module version and
fail clearly when it is absent. The exported MOF binds to the exact selected
installed module version. Preserve Audit-first validation and immutable
package/hash guidance; do not apply the historical 1.4.3 helper to newer
module versions or imply that all enforcement issues are fixed.

References:

Scope and validation

18 documentation/test files; no product runtime, workflow, dependency,
application-version, or flavor-capability changes.

Static checks completed:

  • Relative links and anchors (208 checks), with all 37 chapters retained.
  • PowerShell syntax parsing of 20 examples and mocked module-selection
    cases, including rejecting missing/outdated modules.
  • Documentation contracts and example YAML/schema validation.
  • Git whitespace checks.

Four Vitest documentation regression guards run with the normal hosted PR
checks, alongside the docs-site Markdown lint and mdBook build.
No local Node.js/npm commands, live package creation, or Azure deployment
were used for this documentation change.

After successful checks, the maintainer has authorized merging and porting
the reviewed documentation changes separately to mac-author-build.
No release or tag is created.

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
Copilot-Session: b57352bc-2fa6-4f21-bf28-d72b093d3c10
@ABMFST
Amir Bredy (ABMFST) merged commit 3781600 into main Oct 15, 2026
11 checks passed
@ABMFST
Amir Bredy (ABMFST) deleted the docs/customer-start-20261015 branch October 15, 2026 23:17
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