PowerShell / PowerShell/DSC

Document built-in resources

Open
#665 6 comments 5 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Issue-Enhancement Needs Triage
Dominant language
Rust
Stars
523
Forks
75
Avg merge
3d 16h
Merged PRs (30d)
24

Description

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
  • DSC.PackageManagement/Apt
  • DSC.PackageManagement/Brew
  • Microsoft/OSInfo
  • 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.OpenSSH.SSHD/sshd_config
  • Microsoft.Windows/WMI
  • Microsoft.Windows/WindowsPowerShell

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start in the docs/reference folder and review the checked resource pages alongside the unchecked resource list in the issue. Use the existing example configurations, resource manifests, and linked work items as reference for each remaining built-in resource. Done means the unchecked resources have reference documentation drafted and the documentation is ready to sync online.

Written by the indexing model from the issue text.

Assessment

Tech stack
powershell
Domain
documentation
Issue type
Documentation
Difficulty
4/5
Estimated time
3-5 days
Activity status
Quiet
Clarity
Mostly clear
Newbie friendliness
55/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.