dsccommunity / dsccommunity/SqlServerDsc
SqlServerDsc: Examples README.md should be moved to the repository Wiki
Open
Beginner friendly
Nobody has claimed this yet.
documentation
good first issue
help wanted
- Dominant language
- PowerShell
- Stars
- 385
- Forks
- 224
- PR merge metrics
- No merged PRs in 30d
Description
There is a README.md in source/Examples which should be moved to the repositpry Wiki. Also any unnecessary information should be removed, e.g. the links to examples folders.
This README.md is not updated, and is hard to find when it is deep in the folder structure.
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
Start by reading source/Examples/README.md and review its example-folder links and other information. Move the useful content to the repository Wiki, remove unnecessary information such as those links, and remove the outdated README from its deep folder location when the Wiki content is complete.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- powershell
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Clearly specified
- Newbie friendliness
- 65/100