DscResource.DocGenerator

Author(s)

• DSC Community

Tags

DSC Modules documentation

Functions

New-DscResourcePowerShellHelp New-DscResourceWikiPage

Dependencies

This module has no dependencies.

Release Notes

## [0.4.0] - 2020-02-25

### Added

- Added build tasks `Generate_Wiki_Content` (that runs the cmdlet
 `New-DscResourceWikiPage`). The build task is primarily meant to be run by
 the project [Sampler's](https://github.com/gaelcolas/Sampler) `build.ps1`.
 To make the task available for `Invoke-Build` in a repository that is based
 on [Sampler](https://github.com/gaelcolas/Sampler) add this module to
 required modules, and then in the `build.yaml` add the following.
 ```yaml
 ModuleBuildTasks:
   DscResource.DocGenerator:
     - 'Task.*'
 ```
 
### Fixed

- Fixes the build task `Generate_Conceptual_Help` to use the correct
 module version folder name for the built module path ([issue #17](https://github.com/dsccommunity/DscResource.DocGenerator/issues/17)).
- Fixes the build task `Generate_Conceptual_Help` to correctly evaluate
 the module version ([issue #21](https://github.com/dsccommunity/DscResource.DocGenerator/issues/21)).

## [0.3.0] - 2020-02-11

### Added

- Added build tasks `Generate_Conceptual_Help` (that runs the cmdlet
 `New-DscResourcePowerShellHelp`). The build task is primarily meant to
 be run by the project [Sampler's](https://github.com/gaelcolas/Sampler)
 `build.ps1`. To make the task available for `Invoke-Build` in a repository
 that is based on [Sampler](https://github.com/gaelcolas/Sampler) add this
 module to required modules, and then in the `build.yaml` add the following.
 ```yaml
 ModuleBuildTasks:
   DscResource.DocGenerator:
     - 'Task.*'
 ```

### Fixed

- Fix the description in the README.md.

## [0.2.0] - 2020-02-06

### Added

- New-DscResourcePowerShellHelp
 - Add new parameter `DestinationModulePath` to be able to set the path
   to a built module (for example) ([issue #9](https://github.com/dsccommunity/DscResource.DocGenerator/issues/9)).

### Fixes

- New-DscResourcePowerShellHelp
 - Fixed comment-based help for the parameter `OutputPath` ([issue #8](https://github.com/dsccommunity/DscResource.DocGenerator/issues/8)).

## [0.1.1] - 2020-02-02

### Added

- Add cmdlet `New-DscResourcePowerShellHelp` to generate conceptual help
 for DSC resources. *This was moved from repo PowerShell/DscResource.Tests.*

### Fixed

- Fixed unit tests to work cross platform.
- Fix status badges in README.md.
- Fix the description in the README.md.