DscResource.DocGenerator

0.6.0

Functionality to help generate documentation for modules.

Minimum PowerShell version

5.0

There is a newer prerelease version of this module available.
See the version list below for details.

Installation Options

Copy and Paste the following command to install this package using PowerShellGet More Info

Install-Module -Name DscResource.DocGenerator -RequiredVersion 0.6.0

You can deploy this package directly to Azure Automation. Note that deploying packages with dependencies will deploy all the dependencies to Azure Automation. Learn More

Manually download the .nupkg file to your system's default download location. Note that the file won't be unpacked, and won't include any dependencies. Learn More

Author(s)

DSC Community

Copyright

(c) DSC Community contributors.

Owners

Tags

DSC Modules documentation

Functions

New-DscResourcePowerShellHelp New-DscResourceWikiPage Publish-WikiContent Set-WikiModuleVersion

Dependencies

This module has no dependencies.

Release Notes

## [0.6.0] - 2020-06-22

### Added

- Added cmdlet `Publish-WikiContent` that publishes the Wiki content
 generated by the cmdlet `New-DscResourceWikiPage`.
- Added build task `Publish_GitHub_Wiki_Content` that can publish content
 to a GitHub Wiki repository. This task runs the cmdlet `Publish-WikiContent`.
- Added a markdown page `Home.md` to the folder `source/WikiSource` that
 will be published to the GitHub Wiki for each PR that is merged. The
 module version number will be updated prior to pushing to the Wiki.
 This is done by the the build task `Publish_GitHub_Wiki_Content`.

### Removed

- The parameter `WikiSourcePath` was removed from the function `Copy-WikiFolder`.
- The parameter `WikiSourcePath` was removed from the function `Publish-WikiContent`.
- The parameter `WikiSourceFolderName` was removed from the build task
 `Publish_GitHub_Wiki_Content`.
- The function `Publish-WikiContent` will no longer call the function
 `Set-WikiModuleVersion` (it is now done by the task `Generate_Wiki_Content`).

### Changed

- Update the documentation style in the README.md.
- The repository is using the latest version of the module ModuleBuilder.
- The repository was pinned to use version 4.10.1 of the module Pester
 since this repository does not support Pester 5 tests yet.
- Updated `build.ps1` to be able to dogfood build tasks.
- Moved the Wiki source logic from `Publish-WikiContent` to the build task
 `Generate_Wiki_Content` to align with the other tasks that creates a
 build artifact that should be deployed. `Publish-WikiContent` no longer
 changes the build artifact during publishing. The build task
 `Generate_Wiki_Content` now first generates documentation for any existing
 DSC resources. Secondly if the Wiki source folder (defaults to `WikiSource`)
 exists in the source folder then the content of that folder will be copied
 to the Wiki output folder (defaults to `output/WikiOutput`). If there is a
 markdown file called `Home.md` then any module version placeholders (`#.#.#`)
 will be replaced by the built module version.
- The `Set-WikiModuleVersion` was made a public function to be able to
 use it in the build task `Generate_Wiki_Content`.

### Fixed

- Fixed issue with `New-DscResourceWikiPage` where Test-Path was case sensitive
 on Linux machines and therefore didn't find some Readme.md files.
- Minor style and documentation updates to the build tasks `Generate_Wiki_Content`
 and `Generate_Conceptual_Help`.
- Fixed example in comment-based help form cmdlet `New-DscResourceWikiPage`.
- Fixed a problem in the build task `Publish_GitHub_Wiki_Content` that
 made the Wiki output path to not shown correctly.

Version History

Version Downloads Last updated
0.10.1 241 10/19/2021
0.10.1-previ... 2 10/18/2021
0.10.1-previ... 3 8/7/2021
0.10.1-previ... 2 8/6/2021
0.10.0 584 8/5/2021
0.10.0-previ... 2 8/5/2021
0.9.1 340 7/14/2021
0.9.1-previe... 2 7/13/2021
0.9.0 46 7/8/2021
0.9.0-previe... 2 7/8/2021
0.9.0-previe... 2 7/8/2021
0.9.0-previe... 2 7/8/2021
0.9.0-previe... 2 7/7/2021
0.9.0-previe... 2 7/6/2021
0.9.0-previe... 2 7/6/2021
0.9.0-previe... 2 7/6/2021
0.9.0-previe... 2 6/26/2021
0.9.0-previe... 2 6/25/2021
0.9.0-previe... 2 6/20/2021
0.9.0-previe... 2 6/19/2021
0.9.0-previe... 2 6/16/2021
0.9.0-previe... 2 6/8/2021
0.8.4-previe... 2 6/3/2021
0.8.3 1,439 4/10/2021
0.8.2 498 3/19/2021
0.8.1 137 3/11/2021
0.8.1-previe... 4 3/11/2021
0.8.0 514 2/8/2021
0.8.0-previe... 7 2/7/2021
0.7.4 60 2/2/2021
0.7.4-previe... 4 2/2/2021
0.7.3 7 2/2/2021
0.7.3-previe... 4 2/2/2021
0.7.3-previe... 4 1/18/2021
0.7.2 203 1/17/2021
0.7.2-previe... 5 1/17/2021
0.7.1 1,179 8/5/2020
0.7.1-previe... 3 8/5/2020
0.7.0 245 7/8/2020
0.7.0-previe... 3 7/8/2020
0.6.1 117 7/1/2020
0.6.1-previe... 3 7/1/2020
0.6.1-previe... 3 6/26/2020
0.6.0 (current version) 100 6/22/2020
0.6.0-previe... 3 6/22/2020
0.6.0-previe... 3 6/20/2020
0.5.2-previe... 4 6/16/2020
0.5.1 1,258 5/1/2020
0.5.1-previe... 3 5/1/2020
0.5.0 609 3/28/2020
0.5.0-previe... 4 3/27/2020
0.4.1-previe... 5 2/26/2020
0.4.0 152 2/25/2020
0.4.0-previe... 5 2/25/2020
0.4.0-previe... 5 2/25/2020
0.4.0-previe... 5 2/18/2020
0.3.0 30 2/11/2020
0.3.0-previe... 5 2/11/2020
0.2.0 10 2/6/2020
0.1.1 7 2/2/2020
0.1.1-previe... 5 2/2/2020
Show less