(DOCS) Add reference docs for expected resource operations stdout #1016
Conversation
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
Gijsreyn
reviewed
Jul 30, 2025
Gijsreyn
reviewed
Jul 30, 2025
Gijsreyn
reviewed
Jul 30, 2025
Gijsreyn
reviewed
Jul 30, 2025
michaeltlombardi
force-pushed
the
docs/main/output-docs
branch
from
49dd1d3 to
2aae198
Compare
michaeltlombardi
force-pushed
the
docs/main/output-docs
branch
2 times, most recently
from
1c868f0 to
7365877
Compare
michaeltlombardi
added a commit
to michaeltlombardi/PowerShell-Docs-DSC
that referenced
this pull request
Aug 21, 2025
This change: - Adds reference documentation for the expected output for resource operations - Mirrors the PR in the code repository (PowerShell/DSC#1016) - Fixes MicrosoftDocs#367 - Fixes MicrosoftDocs#368 - Fixes MicrosoftDocs#369
4 tasks
sdwheeler
pushed a commit
to MicrosoftDocs/PowerShell-Docs-DSC
that referenced
this pull request
Aug 21, 2025
This change: - Adds reference documentation for the expected output for resource operations - Mirrors the PR in the code repository (PowerShell/DSC#1016) - Fixes #367 - Fixes #368 - Fixes #369
michaeltlombardi
added a commit
to michaeltlombardi/PowerShell-Docs-DSC
that referenced
this pull request
Aug 21, 2025
This change: - Adds reference documentation for the expected output for resource operations - Mirrors the PR in the code repository (PowerShell/DSC#1016) - Fixes MicrosoftDocs#367 - Fixes MicrosoftDocs#368 - Fixes MicrosoftDocs#369
sdwheeler
added a commit
to MicrosoftDocs/PowerShell-Docs-DSC
that referenced
this pull request
Aug 21, 2025
* Add description to Microsoft.DSC metadata (#371) * (SYNC) Draft reference for expected resource stdout JSON Schemas (#373) This change: - Adds reference documentation for the expected output for resource operations - Mirrors the PR in the code repository (PowerShell/DSC#1016) - Fixes #367 - Fixes #368 - Fixes #369 * (MAINT) Fix bookmark links (#374) --------- Co-authored-by: Gijs Reijn <[email protected]> Co-authored-by: Mikey Lombardi (He/Him) <[email protected]>
michaeltlombardi
force-pushed
the
docs/main/output-docs
branch
from
7365877 to
3080b28
Compare
michaeltlombardi
force-pushed
the
docs/main/output-docs
branch
from
3080b28 to
1cfcd8a
Compare
|
@theJasonHelmick or @mgreenegit can one of you take a pass to review this? |
|
This looks great. It is a lot to review so we might find small iterative changes after publishing. Thank you for this effort. |
mgreenegit
approved these changes
Sep 15, 2025
Prior to this change, the reference documentation for the `kind` property of a resource was only partially updated to reflect the newly available kinds. This change corrects the documentation to reflect the available kinds.
Prior to this change, the resource capabilities documentation was only defined in the output for the `dsc resource list` command reference. This change extracts the useful information into a separate document, reflecting also the shared definition schema added in the last release. This supports referencing the schema from other schemas. A future change will address updating those reference documents as needed.
This change updates the `dsc resource list` output reference and the manifest root reference to reflect the updates to `kind` and `capabilities`.
This change adds documentation for the `stdout` JSON Schemas indicating how DSC validates the expected output for the resource operations.
michaeltlombardi
force-pushed
the
docs/main/output-docs
branch
from
1cfcd8a to
26bb232
Compare
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
5 participants
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 change adds reference documentation for the expected output for the resource operations. It also makes minor corrections to existing reference documentation and extracts the documentation for resource capabilities into a separate file to match the canonical schema.
PR Context
Documenting the expected stdout should help resource authors better understand how to implement and validate their resource design.