-
Notifications
You must be signed in to change notification settings - Fork 10
New DscResourceWikiPage
New-DscResourceWikiPage generates wiki pages that can be uploaded to GitHub to use as public documentation for a module.
New-DscResourceWikiPage [-OutputPath] <String> [-SourcePath] <String> [-BuiltModulePath] <String> [-Force]
[<CommonParameters>]
The New-DscResourceWikiPage cmdlet will review all of the MOF-based, class-based and composite resources in a specified module directory and will output the Markdown files to the specified directory. These help files include details on the property types for each resource, as well as a text description and examples where they exist.
Generate documentation that can be manually uploaded to the GitHub repository Wiki.
It is possible to use markdown code in the schema MOF parameter descriptions.
If markdown code is used and conceptual help is also to be generated, configure
the task Generate_Conceptual_Help to parse the
markdown code.
See the cmdlet New-DscResourcePowerShellHelp and the task
Generate_Conceptual_Help for more information.
New-DscResourceWikiPage `
-SourcePath C:\repos\MyResource\source `
-BuiltModulePath C:\repos\MyResource\output\MyResource\1.0.0 `
-OutputPath C:\repos\MyResource\output\WikiContent
This example shows how to generate wiki documentation for a specific module.
The path to the root of the built DSC resource module, e.g. 'output/MyResource/1.0.0'.
Type: String
Parameter Sets: (All)
Aliases:
Required: True
Position: 3
Default value: None
Accept pipeline input: False
Accept wildcard characters: FalseOverwrites any existing file when outputting the generated content.
Type: SwitchParameter
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: FalseWhere should the files be saved to.
Type: String
Parameter Sets: (All)
Aliases:
Required: True
Position: 1
Default value: None
Accept pipeline input: False
Accept wildcard characters: FalseThe path to the root of the DSC resource module (where the PSD1 file is found, not the folder for and individual DSC resource).
Type: String
Parameter Sets: (All)
Aliases:
Required: True
Position: 2
Default value: None
Accept pipeline input: False
Accept wildcard characters: FalseThis cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.