docs: Update PSScript examples#1528
Open
Gijsreyn wants to merge 2 commits into
Open
Conversation
Contributor
There was a problem hiding this comment.
Pull request overview
This PR refreshes and expands the documentation examples for the transitional PowerShellScript and WindowsPowerShellScript DSC resources, aligning the resource reference pages with clearer, more complete sample scenarios.
Changes:
- Update resource index pages to point to the new/renamed example documents.
- Add a new
WindowsPowerShellScriptexample showing get/test/set patterns for Windows service state. - Add two new
PowerShellScriptexamples covering basic get/set/test behavior and input/output binding patterns.
Reviewed changes
Copilot reviewed 5 out of 5 changed files in this pull request and generated 2 comments.
Show a summary per file
| File | Description |
|---|---|
| docs/reference/resources/Microsoft/DSC/Transitional/WindowsPowerShellScript/index.md | Updates the “See also” example link to the new Windows service-state example page. |
| docs/reference/resources/Microsoft/DSC/Transitional/WindowsPowerShellScript/examples/manage-windows-service-state-with-powershell.md | New end-to-end example demonstrating inline Windows PowerShell scripts for service state management. |
| docs/reference/resources/Microsoft/DSC/Transitional/PowerShellScript/index.md | Updates the example link to the renamed “run a simple” example page. |
| docs/reference/resources/Microsoft/DSC/Transitional/PowerShellScript/examples/run-a-simple-powershell-script.md | New example illustrating basic get/set/test usage and stream/log-level mapping. |
| docs/reference/resources/Microsoft/DSC/Transitional/PowerShellScript/examples/powershell-script-with-input-output.md | New example illustrating input binding and error cases when input/param mismatch. |
Collaborator
|
Starting editorial pass, will be updating the commit directly and force pushing when completed. Please don't make any changes to this PR while I'm actively editing the documentation. Thank you! |
michaeltlombardi
force-pushed
the
update-ps-examples
branch
2 times, most recently
from
f23e8d4 to
da95e53
Compare
This change updates the reference docs for the `WindowsPowerShellScript` resource, including new examples and updates to the index page. It is largely a mirror of the `PowerShellScript` resource, as the resources share an implementation script.
michaeltlombardi
force-pushed
the
update-ps-examples
branch
from
da95e53 to
65b9a48
Compare
michaeltlombardi
approved these changes
Jun 8, 2026
Collaborator
|
Approved, pending final technical review - should only need to review one set of docs, as the content is largely mirrored across them. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
PR Summary
This pull request updates the already scaffolded examples for
Microsoft.DSC.Transitional/WindowsPowerShellandMicrosoft.DSC.Transitional/PowerShell.