dsccommunity / dsccommunity/SqlServerDsc
SqlServerDsc: Reduce the amount of verbose messages generated in logs
Nobody has claimed this yet.
- Dominant language
- PowerShell
- Stars
- 385
- Forks
- 224
- PR merge metrics
- No merged PRs in 30d
Description
A suggestion was raised to change many Write-Verbose calls to Write-Debug and just keep relevant messages for the user as Write-Verbose. Basically that would mean changing all Write-Verbose to Write-Debug in helper functions.
We should also change the issue template telling users to run the configuration using the following to get both the verbose and debug output.
Start-DscConfiguration -Path C:\temp\SqlDscTest -Wait -Force -Debug -Verbose
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 locating the helper functions containing Write-Verbose calls and the issue template in the SqlServerDsc repository. Review which messages should remain user-facing, change the others to debug output, update the template with the supplied Start-DscConfiguration command, and verify that both verbose and debug output are available.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- powershell
- Domain
- devops, documentation
- Issue type
- Refactor
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100