(DOCS) Scaffold resource authoring docs #1027
Draft
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
theJasonHelmick
approved these changes
Aug 6, 2025
|
I recall seeing it mentioned in the documentation you wrote earlier, Mikey, but after our discussion yesterday, would it be worth pointing out a naming convention for a new DSC resource? |
This change adds conceptual documentation as the initial offering for a resource _design_ guide. It is intended to convey high-level implementation-agnostic guidance for defining DSC resources, including resource manifests and instance schemas. The guide doesn't cover any specifics for defining commands or the resource in a particular language. Those concerns are better covered in the resource development kits or the sample resource tutorials, not the conceptual guide.
michaeltlombardi
force-pushed
the
docs/main/resource-authoring
branch
from
012258b to
fea6566
Compare
michaeltlombardi
added a commit
to michaeltlombardi/PowerShell-Docs-DSC
that referenced
this pull request
Aug 21, 2025
This change drafts the conceptual documentation for guidance on how to author DSC resources from a design perspective. It does not include any specific guidance from a code or language perspective. Instead, it focuses on the high level concepts and on defining the resource manifest and instance JSON Schema. This change is a mirror of the one submitted to the source repository: - PowerShell/DSC#1027
7 tasks
Gijsreyn
reviewed
Aug 21, 2025
| Users can configure the trace level for DSC by specifying the | ||
| [--trace-level](../../../reference/cli/index.md#--trace-level) command option, setting the | ||
| [DSC_TRACE_LEVEL](../../../reference/cli/index.md#environment-variables) environmental variable, or | ||
| by modifying the settings for DSC. |
There was a problem hiding this comment.
You might have already seen it, but maybe you can reference the settings to the docs when it gets pulled in (#1044)?
Gijsreyn
reviewed
Aug 21, 2025
| When a user specifies the [--trace-format](../../../reference/cli/index.md#--trace-format) option | ||
| as `plaintext`, DSC emits the messages in the same format but without console colors. | ||
|
|
||
| When a user specifies the format as `json`, DSC emits each message as a JSON Line to stderr. |
There was a problem hiding this comment.
Nit: Perhaps make a reference towards: https://jsonlines.org/
michaeltlombardi
added a commit
to michaeltlombardi/PowerShell-Docs-DSC
that referenced
this pull request
Aug 21, 2025
This change drafts the conceptual documentation for guidance on how to author DSC resources from a design perspective. It does not include any specific guidance from a code or language perspective. Instead, it focuses on the high level concepts and on defining the resource manifest and instance JSON Schema. This change is a mirror of the one submitted to the source repository: - PowerShell/DSC#1027
michaeltlombardi
added a commit
to michaeltlombardi/PowerShell-Docs-DSC
that referenced
this pull request
Aug 21, 2025
This change drafts the conceptual documentation for guidance on how to author DSC resources from a design perspective. It does not include any specific guidance from a code or language perspective. Instead, it focuses on the high level concepts and on defining the resource manifest and instance JSON Schema. This change is a mirror of the one submitted to the source repository: - PowerShell/DSC#1027
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 change adds empty documents to suggest the structure and content of a resource authoring guide.
It is intended to convey high-level design guidance and implementation-agnostic guidance for authoring resource manifests and instance schemas.
It doesn't cover any specifics for defining commands or the resource in a particular language. Those concerns are better covered in the resource development kits or the sample resource tutorials, not the conceptual guide.
PR Context
A recurring ask from partners and community members is how to begin authoring a DSC resource. This high-level guide will provide a starting point for such development.