Missing attribute description for some resources in the YAML documentation

Open
#194 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
3/5
Estimated time
1-2 days
Newbie friendliness
38/100
Issue type
Documentation
Clarity
Mostly clear
Activity status
Stale
Tech stack
powershell, yaml
Domain
documentation

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.

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###'.

Dominant language
PowerShell
Stars
45
Forks
27
No merged PRs in 30d

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.

More from dsccommunity/CommonTasks

All issues in dsccommunity/CommonTasks

Similar issues

More Documentation issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.