DSC icon indicating copy to clipboard operation
DSC copied to clipboard

(DOCS) Scaffold resource authoring docs

Open michaeltlombardi opened this issue 4 months ago • 3 comments

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.

michaeltlombardi avatar Aug 05 '25 20:08 michaeltlombardi

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?

Gijsreyn avatar Aug 06 '25 16:08 Gijsreyn

Hi Mikey, I was going through this pull request again, and I was wondering if you wanted to add the same thing as they did in the winget-dsc repository because of the markdownlint.yaml file (including the spelling checker)?

Gijsreyn avatar Aug 29 '25 11:08 Gijsreyn

@Gijsreyn - not currently - we have more stringent checks and CI over in the docs repo. Here I'm mostly seeking feedback on technical content from the team/contributors, when I submit over to the docs repo we go through a separate editorial review for grammar/structure/spelling/formatting/etc.

michaeltlombardi avatar Aug 29 '25 14:08 michaeltlombardi