PowerShell-Docs-DSC
PowerShell-Docs-DSC copied to clipboard
Some of the builtin resources still need documenting & others need linked to
Prerequisites
- [x] Existing Issue: Search the existing issues for this repository. If there is an issue that fits your needs do not file a new one. Subscribe, react, or comment on that issue instead.
- [x] Descriptive Title: Write the title for this issue as a short synopsis. If possible, provide context. For example, "Typo in
Get-Foocmdlet" instead of "Typo." - [x] Verify Version: If there is a mismatch between documentation and the module on your system, ensure that the version you are using is the same as the documentation. Check this box if they match or the issue you are reporting is not version specific.
Version
v3.0
Links
builtin.md Source Doc https://github.com/MicrosoftDocs/PowerShell-Docs-DSC/blob/7f5526699c7ff08e54b5ac5b538482d1a640fad6/dsc/docs-conceptual/dsc-3.0/reference/resources/builtin.md?plain=1#L18-L75
Live Doc
- https://learn.microsoft.com/en-us/powershell/dsc/reference/resources/builtin?view=dsc-3.0#all-builtin-resources
toc.yml for these resources
- https://github.com/MicrosoftDocs/PowerShell-Docs-DSC/blob/main/dsc/docs-conceptual/dsc-3.0/reference/resources/toc.yml
Summary
The following resources seem to still seem to need documenting, linked to in the bultin.md & then added to the toc.yml file.
Microsoft.DSC/AssertionMicrosoft.DSC/GroupMicrosoft.DSC/IncludeMicrosoft.DSC.Transitional/RunCommandOnSet
The following seem like they just need the links added to each resoure in the builtin.md doc as the docs for these already seem to exist already.
Microsoft.DSC/PowerShellMicrosoft.DSC.Debug/EchoMicrosoft.Windows/RebootPendingMicrosoft.Windows/WindowsPowerShellMicrosoft.Windows/WMI
Details
This was raised in https://github.com/PowerShell/DSC/issues/1295 by @EmperorArthur about the lack of documentation for the builtin group resources & I noticed these files/pages may also need minor updates for links to existing documentation as well as other docs created.
Suggested Fix
No response