(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
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.
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? |
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.