DSC icon indicating copy to clipboard operation
DSC copied to clipboard

Document built-in resources

Open michaeltlombardi opened this issue 10 months ago • 1 comments

Summary of the new feature / enhancement

As a user, I want to be able to review reference documentation for the built-in resources provided with DSC instead of needing to review example configurations, the resource manifests, and GitHub work items to understand how to use those resources.

Proposed technical implementation details (optional)

Draft the documentation for the following resources in the docs/reference folder before syncing to the online documentation:

  • [ ] Resource reference overview
  • [ ] Microsoft/OSInfo
  • [ ] Microsoft/Process
  • [ ] Microsoft.DSC/Assertion
  • [ ] Microsoft.DSC/Group
  • [ ] Microsoft.DSC/Include
  • [ ] Microsoft.DSC/PowerShell
  • [ ] Microsoft.DSC.Debug/Echo
  • [ ] Microsoft.DSC.Transitional/RunCommandOnSet
  • [ ] Microsoft.Windows/RebootPending
  • [ ] Microsoft.Windows/WMI
  • [ ] Microsoft.Windows/WindowsPowerShell

michaeltlombardi avatar Feb 28 '25 16:02 michaeltlombardi

+1

dummys avatar Apr 14 '25 13:04 dummys

Hey @michaeltlombardi. For housekeeping purposes, I think the Microsoft.Windows/WindowsPowerShell, Microsoft.DSC/PowerShell, Microsoft/OSInfo, and Microsoft.Windows/RebootPending can be checked off. For the Microsoft.Windows/WMI, I just hit up a PR #900.

Gijsreyn avatar Jun 21 '25 13:06 Gijsreyn

I think the Microsoft/Process can be removed, as it's not being shipped. Rather, the apt, brew, and sshconfig can be added to the list.

Gijsreyn avatar Jun 30 '25 13:06 Gijsreyn

Related to #1295

EmperorArthur avatar Nov 26 '25 22:11 EmperorArthur