Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

New-DscResourcePowerShellHelp and Composite resources does not work #115

Open
ChristophHannappel opened this issue Mar 11, 2022 · 1 comment
Labels
enhancement The issue is an enhancement request. help wanted The issue is up for grabs for anyone in the community.

Comments

@ChristophHannappel
Copy link

Details of the scenario you tried and the problem that is occurring

Trying to use the command New-DscResourcePowerShellHelp with a composite resource.
Composite sits in source\DSCResources\CompositeName\ with two files

  • CompositeName.psd1
  • CompositeName.Schema.psd1

After looking at the function New-DscResourcePowerShellHelp it seams there is no code for composites

Steps to reproduce the problem

PS> New-DscResourcePowerShellHelp -ModulePath .\source\ -Verbose

Expected behavior

It creates some files.

Current behavior

It creates nothing

Suggested solution to the issue

It creates PowerShell compatible help files or the help file is updated, that the command can only do mof and class based.

The operating system the target node is running

Windows 10

Version and build of PowerShell the target node is running

Name Value
PSVersion 5.1.19041.1320
PSEdition Desktop
PSCompatibleVersions {1.0, 2.0, 3.0, 4.0...}
BuildVersion 10.0.19041.1320
CLRVersion 4.0.30319.42000
WSManStackVersion 3.0
PSRemotingProtocolVersion 2.3
SerializationVersion 1.1.0.1

Version of the module that was used

Name Version Path
DscResource.DocGenerator 0.10.3 C:\Users\<Username>\git Repositories\<ModuleName>\output\RequiredModules\DscResource.DocGenerator\0.10.3\DscResource.DocGenerator.psd1
@johlju
Copy link
Member

johlju commented Mar 13, 2022

That is correct that the module is missing support for conceptual help for composites. Wiki documentation is generated for composites, but not conceptual help yet. Happy to review a PR that adds that.

@johlju johlju added enhancement The issue is an enhancement request. help wanted The issue is up for grabs for anyone in the community. labels Mar 13, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement The issue is an enhancement request. help wanted The issue is up for grabs for anyone in the community.
Projects
None yet
Development

No branches or pull requests

2 participants