Sync reference resources for released v3.2.0 - #411
Conversation
This comment was marked as outdated.
This comment was marked as outdated.
This comment was marked as outdated.
This comment was marked as outdated.
There was a problem hiding this comment.
Pull request overview
This PR syncs the DSC v3.2.0 “built-in resources” reference docs by updating the resources TOC, refreshing existing reference pages, and adding new reference + example content for newly released resources/adapters.
Changes:
- Updated the reference TOC and the “Built-in DSC resources” index to reflect v3.2.0 released resources.
- Added new reference documentation (and examples) for multiple Windows resources (for example Service, OptionalFeatureList, FeatureOnDemandList) and adapters (PowerShell / WindowsPowerShell).
- Refreshed/normalized various existing resource reference pages and examples (dates, links, wording, formatting).
Reviewed changes
Copilot reviewed 65 out of 65 changed files in this pull request and generated 12 comments.
Show a summary per file
| File | Description |
|---|---|
| dsc/docs-conceptual/dsc-3.0/reference/resources/toc.yml | Updates the navigation structure for built-in resources (adds/removes/renames entries). |
| dsc/docs-conceptual/dsc-3.0/reference/resources/Microsoft/Windows/WMI/index.md | Updates WMI adapter reference page content/formatting. |
| dsc/docs-conceptual/dsc-3.0/reference/resources/Microsoft/Windows/WMI/examples/query-operating-system-info.md | Refreshes WMI example front matter formatting/dates. |
| dsc/docs-conceptual/dsc-3.0/reference/resources/Microsoft/Windows/WMI/examples/query-filtered-disk-info.md | Refreshes WMI example metadata and wording/line-wrapping. |
| dsc/docs-conceptual/dsc-3.0/reference/resources/Microsoft/Windows/WindowsPowerShell/index.md | Updates WindowsPowerShell adapter reference content/links/formatting. |
| dsc/docs-conceptual/dsc-3.0/reference/resources/Microsoft/Windows/WindowsPowerShell/examples/manage-a-windows-service.md | Refreshes WindowsPowerShell adapter example formatting/content. |
| dsc/docs-conceptual/dsc-3.0/reference/resources/Microsoft/Windows/Service/index.md | Adds new Service resource reference page. |
| dsc/docs-conceptual/dsc-3.0/reference/resources/Microsoft/Windows/Service/examples/service.config.dsc.yaml | Adds a config-document example for Service resource usage. |
| dsc/docs-conceptual/dsc-3.0/reference/resources/Microsoft/Windows/Service/examples/get-service-status.md | Adds a dsc resource get example for Service. |
| dsc/docs-conceptual/dsc-3.0/reference/resources/Microsoft/Windows/Service/examples/configure-windows-service.md | Adds an end-to-end config/test/set example for Service. |
| dsc/docs-conceptual/dsc-3.0/reference/resources/Microsoft/Windows/Registry/index.md | Updates Registry reference content (dates, link normalization, casing). |
| dsc/docs-conceptual/dsc-3.0/reference/resources/Microsoft/Windows/Registry/examples/configure-registry-keys-and-values.md | Fixes a step numbering issue in a Registry example. |
| dsc/docs-conceptual/dsc-3.0/reference/resources/Microsoft/Windows/RebootPending/index.md | Updates RebootPending reference (dates, links, wording/layout). |
| dsc/docs-conceptual/dsc-3.0/reference/resources/Microsoft/Windows/RebootPending/examples/use-rebootpending-in-configuration.md | Refreshes RebootPending configuration example formatting. |
| dsc/docs-conceptual/dsc-3.0/reference/resources/Microsoft/Windows/RebootPending/examples/check-for-pending-reboot.md | Refreshes RebootPending example formatting and fixes typos/links. |
| dsc/docs-conceptual/dsc-3.0/reference/resources/Microsoft/Windows/OptionalFeatureList/index.md | Adds new OptionalFeatureList resource reference page. |
| dsc/docs-conceptual/dsc-3.0/reference/resources/Microsoft/Windows/OptionalFeatureList/examples/get-optional-feature.md | Adds OptionalFeatureList “get” examples. |
| dsc/docs-conceptual/dsc-3.0/reference/resources/Microsoft/Windows/OptionalFeatureList/examples/export-optional-features.md | Adds OptionalFeatureList “export/filter” examples. |
| dsc/docs-conceptual/dsc-3.0/reference/resources/Microsoft/Windows/OptionalFeatureList/examples/enable-disable-optional-features.md | Adds OptionalFeatureList “set” + configuration-document examples. |
| dsc/docs-conceptual/dsc-3.0/reference/resources/Microsoft/Windows/FirewallRuleList/examples/get-firewall-rules.md | Adds FirewallRuleList “get/set/export” examples. |
| dsc/docs-conceptual/dsc-3.0/reference/resources/Microsoft/Windows/FirewallRuleList/examples/firewall.config.dsc.yaml | Adds a FirewallRuleList configuration document example. |
| dsc/docs-conceptual/dsc-3.0/reference/resources/Microsoft/Windows/FirewallRuleList/examples/firewall.cleanup.config.dsc.yaml | Adds a FirewallRuleList cleanup configuration document example. |
| dsc/docs-conceptual/dsc-3.0/reference/resources/Microsoft/Windows/FirewallRuleList/examples/configure-firewall-rules.md | Adds an end-to-end FirewallRuleList configuration example (test/set/cleanup). |
| dsc/docs-conceptual/dsc-3.0/reference/resources/Microsoft/Windows/FeatureOnDemandList/index.md | Adds new FeatureOnDemandList resource reference page. |
| dsc/docs-conceptual/dsc-3.0/reference/resources/Microsoft/Windows/FeatureOnDemandList/examples/install-remove-feature-on-demand.md | Adds FeatureOnDemandList “set” examples. |
| dsc/docs-conceptual/dsc-3.0/reference/resources/Microsoft/Windows/FeatureOnDemandList/examples/get-feature-on-demand.md | Adds FeatureOnDemandList “get” examples. |
| dsc/docs-conceptual/dsc-3.0/reference/resources/Microsoft/Windows/FeatureOnDemandList/examples/export-features-on-demand.md | Adds FeatureOnDemandList “export/filter” examples. |
| dsc/docs-conceptual/dsc-3.0/reference/resources/Microsoft/OSInfo/index.md | Updates OSInfo reference semantics (test support, casing, schema/type notes). |
| dsc/docs-conceptual/dsc-3.0/reference/resources/Microsoft/OSInfo/examples/validate-with-dsc-resource.md | Updates OSInfo examples to reflect updated test behavior/output. |
| dsc/docs-conceptual/dsc-3.0/reference/resources/Microsoft/OSInfo/examples/validate-minimum-version.md | Adds a new OSInfo minimum-version assertion example. |
| dsc/docs-conceptual/dsc-3.0/reference/resources/Microsoft/OSInfo/examples/validate-minimum-version.config.dsc.yaml | Adds the config document used by the minimum-version example. |
| dsc/docs-conceptual/dsc-3.0/reference/resources/Microsoft/OSInfo/examples/validate-in-a-configuration.md | Minor formatting updates in OSInfo configuration example page. |
| dsc/docs-conceptual/dsc-3.0/reference/resources/Microsoft/DSC/Transitional/WindowsPowerShellScript/examples/winpsscript.config.dsc.yaml | Adds a WindowsPowerShellScript example configuration document. |
| dsc/docs-conceptual/dsc-3.0/reference/resources/Microsoft/DSC/Transitional/WindowsPowerShellScript/examples/configure-with-script.md | Adds a full walkthrough example for WindowsPowerShellScript. |
| dsc/docs-conceptual/dsc-3.0/reference/resources/Microsoft/DSC/Transitional/PowerShellScript/examples/psscript.config.dsc.yaml | Adds a PowerShellScript example configuration document. |
| dsc/docs-conceptual/dsc-3.0/reference/resources/Microsoft/DSC/Transitional/PowerShellScript/examples/configure-with-script.md | Adds a full walkthrough example for PowerShellScript. |
| dsc/docs-conceptual/dsc-3.0/reference/resources/Microsoft/DSC/Transitional/RunCommandOnSet/index.md | Adds RunCommandOnSet reference page. |
| dsc/docs-conceptual/dsc-3.0/reference/resources/Microsoft/DSC/Transitional/RunCommandOnSet/examples/run-powershell-command.md | Adds a RunCommandOnSet example for invoking PowerShell. |
| dsc/docs-conceptual/dsc-3.0/reference/resources/Microsoft/DSC/Transitional/RunCommandOnSet/examples/run-a-simple-command.md | Adds a RunCommandOnSet example for invoking a simple command. |
| dsc/docs-conceptual/dsc-3.0/reference/resources/Microsoft/DSC/PowerShell/index.md | Updates Microsoft.DSC/PowerShell adapter reference page content/links/formatting. |
| dsc/docs-conceptual/dsc-3.0/reference/resources/Microsoft/DSC/Include/index.md | Adds Microsoft.DSC/Include resource reference page. |
| dsc/docs-conceptual/dsc-3.0/reference/resources/Microsoft/DSC/Include/examples/include-inline-configuration-content.md | Adds Include example showing inline configuration/parameters content. |
| dsc/docs-conceptual/dsc-3.0/reference/resources/Microsoft/DSC/Include/examples/include-a-configuration-file.md | Adds Include example showing file-based config + parameters. |
| dsc/docs-conceptual/dsc-3.0/reference/resources/Microsoft/DSC/Debug/echo/index.md | Updates Echo debug resource reference page formatting/links. |
| dsc/docs-conceptual/dsc-3.0/reference/resources/Microsoft/DSC/Debug/echo/examples/basic-echo-example.md | Updates Echo example formatting and line wrapping. |
| dsc/docs-conceptual/dsc-3.0/reference/resources/Microsoft/Adapter/WindowsPowerShell/index.md | Adds Microsoft.Adapter/WindowsPowerShell adapter reference page. |
| dsc/docs-conceptual/dsc-3.0/reference/resources/Microsoft/Adapter/WindowsPowerShell/examples/manage-a-windows-service.md | Adds WindowsPowerShell adapter walkthrough example using PSDSC Service. |
| dsc/docs-conceptual/dsc-3.0/reference/resources/Microsoft/Adapter/PowerShell/index.md | Adds Microsoft.Adapter/PowerShell adapter reference page. |
| dsc/docs-conceptual/dsc-3.0/reference/resources/Microsoft/Adapter/PowerShell/examples/invoke-a-resource.md | Adds PowerShell adapter example for invoking a resource directly. |
| dsc/docs-conceptual/dsc-3.0/reference/resources/Microsoft/Adapter/PowerShell/examples/configure-a-machine.md | Adds PowerShell adapter example for multi-resource configuration. |
| dsc/docs-conceptual/dsc-3.0/reference/resources/DSC/PackageManagement/Brew/index.md | Adds Brew resource reference page. |
| dsc/docs-conceptual/dsc-3.0/reference/resources/DSC/PackageManagement/Brew/examples/remove-a-package.md | Adds Brew remove-package example. |
| dsc/docs-conceptual/dsc-3.0/reference/resources/DSC/PackageManagement/Brew/examples/install-a-package-with-brew.md | Adds Brew install-package example. |
| dsc/docs-conceptual/dsc-3.0/reference/resources/DSC/PackageManagement/APT/index.md | Updates Apt resource reference page formatting/dates. |
| dsc/docs-conceptual/dsc-3.0/reference/resources/DSC/PackageManagement/APT/examples/manage-packages-with-apt.md | Updates Apt example formatting/dates. |
| dsc/docs-conceptual/dsc-3.0/reference/resources/builtin.md | Expands built-in resources index with new resources, categories, and links. |
Suppressed comments (4)
dsc/docs-conceptual/dsc-3.0/reference/resources/Microsoft/OSInfo/examples/validate-in-a-configuration.md:285
- This section still states that
Microsoft/OSInfodoesn't implement the test operation, but other updates in this PR (for example, the OSInfo reference andvalidate-with-dsc-resource.md) say it now implementstest. This is internally inconsistent and likely incorrect for v3.2.0 docs.
dsc/docs-conceptual/dsc-3.0/reference/resources/Microsoft/Windows/WMI/index.md:40 - The instance definition syntax code block currently contains two conflicting YAML examples in a single document (duplicate
resources:keys and inconsistent indentation), so it isn't valid YAML if copied. Consider formatting it as two YAML documents separated by---(or split into two distinct examples) with consistent indentation.
dsc/docs-conceptual/dsc-3.0/reference/resources/Microsoft/Windows/WindowsPowerShell/index.md:40 - The instance definition syntax code block currently contains two conflicting YAML examples in a single document (duplicate
resources:keys and inconsistent indentation), so it isn't valid YAML if copied. Consider formatting it as two YAML documents separated by---(or split into two distinct examples) with consistent indentation.
dsc/docs-conceptual/dsc-3.0/reference/resources/Microsoft/DSC/PowerShell/index.md:40 - The instance definition syntax code block currently contains two conflicting YAML examples in a single document (duplicate
resources:keys and inconsistent indentation), so it isn't valid YAML if copied. Consider formatting it as two YAML documents separated by---(or split into two distinct examples) with consistent indentation.
# Required Properties
resources:
- name: <nested instance name>
type: <module name>/<class name>
properties: # adapted resource properties
# Or from v3.1.0-preview.2 onwards
resources:
- name: <instanceName>
type: <moduleName>/<class name>
properties: # adapted resource properties
💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.
This comment was marked as outdated.
This comment was marked as outdated.
This comment was marked as outdated.
This comment was marked as outdated.
|
Gijs Reijn (@Gijsreyn) are you still updating this PR or would you like me to address the build report issues? I know they can be a bit difficult to work through for external contributors. |
PoliCheck Scan ReportThe following report lists PoliCheck issues in PR files. Before you merge the PR, you must fix all severity-1 and severity-2 issues. The AI Review Details column lists suggestions for either removing or replacing the terms. If you find a false positive result, mention it in a PR comment and include this text: #policheck-false-positive. This feedback helps reduce false positives in future scans.
More information about PoliCheckInformation: PoliCheck | Severity Guidance | Term |
||||||||||||||||||||||||||||||||
1f07150
into
MicrosoftDocs:main
PR Summary
This pull request contains the reference documentation for released resources in v3.2.0
PR Checklist