dsccommunity / ActiveDirectoryDsc

This module contains DSC resources for deployment and configuration of Active Directory Domain Services.
MIT License
344 stars 142 forks source link

ActiveDirectoryDsc: Add CommonModule Markdown Help #603

Closed X-Guardian closed 4 years ago

X-Guardian commented 4 years ago

Pull Request (PR) description

This PR adds Markdown Help files for the ActiveDirectoryDsc.Common Module.

The Build-ReadMe.ps1 script is used to build the markdown documentation for the common module. this uses functions from the PlatyPS PowerShell Module to build the markdown from the PowerShell comment based help in the module.

This Pull Request (PR) fixes the following issues

Task list


This change is Reviewable

codecov[bot] commented 4 years ago

Codecov Report

Merging #603 into master will decrease coverage by 1%. The diff coverage is 21%.

Impacted file tree graph

@@          Coverage Diff          @@
##           master   #603   +/-   ##
=====================================
- Coverage      99%    98%   -2%     
=====================================
  Files          23     24    +1     
  Lines        3045   3091   +46     
=====================================
- Hits         3031   3030    -1     
- Misses         14     61   +47     
johlju commented 4 years ago

Either extending PlatyPS or roll are own in DocGenerator. I separate section in the Wiki would be great.

johlju commented 4 years ago

But agree that this is good as a first step! :)