Skip to content
This repository has been archived by the owner on Feb 24, 2021. It is now read-only.

Improve Wiki Generation to Handle Example Format used in Gallery Publish #247

Closed
PlagueHO opened this issue Jul 7, 2018 · 0 comments
Closed
Labels
enhancement The issue is an enhancement request.

Comments

@PlagueHO
Copy link
Collaborator

PlagueHO commented Jul 7, 2018

The new Example Gallery publish function (https://github.com/PowerShell/DscResource.Tests#deploy) requires Example files to be in a slightly different format than the Wiki auto generation: https://github.com/PowerShell/DscResource.Tests/blob/dev/DscResource.DocumentationHelper/WikiPages.psm1

The Wiki Auto generation needs to be adjusted to also support the Example format required by the gallery publish function. This will require allowing .DESCRIPTION or .SYNOPSIS instead of .EXAMPLE and also to ignore the #requires lines.

@johlju johlju added enhancement The issue is an enhancement request. in progress The issue is being actively worked on by someone. labels Jul 7, 2018
@johlju johlju closed this as completed in e8e9fbe Jul 12, 2018
@johlju johlju removed the in progress The issue is being actively worked on by someone. label Jul 12, 2018
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
enhancement The issue is an enhancement request.
Projects
None yet
Development

No branches or pull requests

2 participants