Skip to content

docs: Add reference documentation for Microsoft.Adapter/PowerShell and Microsoft.Adapter/WindowsPowerShell#1444

Open
Gijsreyn wants to merge 6 commits intoPowerShell:mainfrom
Gijsreyn:update-adapter-docs
Open

docs: Add reference documentation for Microsoft.Adapter/PowerShell and Microsoft.Adapter/WindowsPowerShell#1444
Gijsreyn wants to merge 6 commits intoPowerShell:mainfrom
Gijsreyn:update-adapter-docs

Conversation

@Gijsreyn
Copy link
Copy Markdown
Collaborator

PR Summary

Adds reference documentation for the two new DSC 3.2 adapter resources and updates existing examples and docs to use the new directives.requireAdapter syntax.

New documentation:

  • docs/reference/resources/microsoft/adapter/powershell/index.md — Reference doc for Microsoft.Adapter/PowerShell
  • docs/reference/resources/microsoft/adapter/powershell/examples/invoke-a-resource.md
  • docs/reference/resources/microsoft/adapter/powershell/examples/configure-a-machine.md
  • docs/reference/resources/microsoft/adapter/windowspowershell/index.md — Reference doc for Microsoft.Adapter/WindowsPowerShell
  • docs/reference/resources/microsoft/adapter/windowspowershell/examples/manage-a-windows-service.md

Updated files

  • docs/reference/resources/overview.md — Added new adapters to the all-resources and adapter sections; added deprecation warning for Microsoft.DSC/PowerShell and Microsoft.Windows/WindowsPowerShell
  • docs/get-started/index.md — Updated YAML snippet to use new adapter syntax
  • dsc/examples/winget.dsc.yaml, winps_script.dsc.yaml, timezone.dsc.yaml — Migrated from old nested adapter pattern to directives.requireAdapter
  • dsc/examples/multiline.dsc.yaml — Fixed instance names to comply with ^[a-zA-Z0-9 ]+$ schema

Notes

  • The directives.requireAdapter syntax requires DSC 3.2.0 or later, noted throughout the new docs (preperation for GA release)
  • Old adapter docs (Microsoft.DSC/PowerShell, Microsoft.Windows/WindowsPowerShell) are marked as deprecated with links to the new replacements

Copilot AI review requested due to automatic review settings March 23, 2026 00:29
Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull request overview

Adds new reference documentation for the DSC 3.2+ adapter resources Microsoft.Adapter/PowerShell and Microsoft.Adapter/WindowsPowerShell, and updates several docs/examples to use the directives.requireAdapter syntax instead of the older nested adapter pattern.

Changes:

  • Added new reference pages + examples for the two new adapter resources.
  • Migrated multiple example configuration documents to directives.requireAdapter.
  • Updated CLI/docs references to point to the new adapter type names and marked older adapters as deprecated.

Reviewed changes

Copilot reviewed 17 out of 17 changed files in this pull request and generated 8 comments.

Show a summary per file
File Description
dsc/examples/winps_script.dsc.yaml Migrates the Windows PowerShell script example to directives.requireAdapter.
dsc/examples/winget.dsc.yaml Migrates WinGet example instances to directives.requireAdapter.
dsc/examples/timezone.dsc.yaml Migrates TimeZone example to directives.requireAdapter.
dsc/examples/parallel.dsc.yaml Removes the parallel/groups example config file.
dsc/examples/multiline.dsc.yaml Updates instance names to comply with the instance name schema.
dsc/examples/groups.dsc.yaml Updates config metadata key name for security context.
docs/reference/resources/overview.md Adds the new adapters to the resource overview and includes a deprecation warning for old adapters.
docs/reference/resources/Microsoft/adapter/powershell/index.md New reference doc for Microsoft.Adapter/PowerShell.
docs/reference/resources/Microsoft/adapter/powershell/examples/invoke-a-resource.md New example showing usage of the PowerShell adapter.
docs/reference/resources/Microsoft/adapter/powershell/examples/configure-a-machine.md New multi-resource example using the PowerShell adapter.
docs/reference/resources/Microsoft/adapter/windowspowershell/index.md New reference doc for Microsoft.Adapter/WindowsPowerShell.
docs/reference/resources/Microsoft/adapter/windowspowershell/examples/manage-a-windows-service.md New example showing usage of the Windows PowerShell adapter.
docs/reference/cli/resource/list.md Updates dsc resource list --adapter examples to the new adapter name.
docs/overview.md Updates overview text to reference the new adapter resources.
docs/get-started/index.md Deleted in this PR (per diff).
docs/concepts/resources/overview.md Updates adapter resource naming in concepts doc.
docs/concepts/output-accessibility.md Updates adapter name in PowerShell examples.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

@Gijsreyn Gijsreyn marked this pull request as draft March 23, 2026 16:17
@Gijsreyn Gijsreyn force-pushed the update-adapter-docs branch from 51ccc6e to 7b42129 Compare April 3, 2026 05:36
@Gijsreyn Gijsreyn marked this pull request as ready for review April 3, 2026 05:44
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.

2 participants