dsccommunity / dsccommunity/CommonTasks
Missing attribute description for some resources in the YAML documentation
Nobody has claimed this yet.
- Dominant language
- PowerShell
- Stars
- 45
- Forks
- 27
- PR merge metrics
- No merged PRs in 30d
Description
After merge of Pull Request #193 alle available resources have an documentation sheet.
In some of these sheets the abstract and the detailed attribute description is missing or incomplete and should be completed by the authors (@raandree, @nyanhp) of these resources.
The abstract of an incomplete resource documentation file is marked with '###TBD###'.
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Search the YAML documentation files for abstracts marked '###TBD###', then inspect the corresponding abstract and detailed attribute sections. Complete the missing or incomplete descriptions for the affected resources and verify that no resource documentation still has an unfinished abstract or attribute description.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- powershell, yaml
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 38/100