PowerShell / SecretManagement

PowerShell module to consistent usage of secrets through different extension vaults
MIT License
317 stars 46 forks source link

Documentation is just the stock help template. #199

Open dlamkins opened 1 year ago

dlamkins commented 1 year ago

Prerequisites

Steps to reproduce

See the output of help:

PS C:\Users\user> help about_microsoft.powershell.secretmanagement
TOPIC
    about_microsoft.powershell.secretmanagement

    ABOUT TOPIC NOTE:
    The first header of the about topic should be the topic name.
    The second header contains the lookup name used by the help system.

    IE:
    # Some Help Topic Name
    ## SomeHelpTopicFileName

    This will be transformed into the text file
    as `about_SomeHelpTopicFileName`.
    Do not include file extensions.
    The second header should have no spaces.
    [...]

Expected behavior

Documentation should be filled out.

Actual behavior

Documentation is just the default template.

Error details

https://github.com/PowerShell/SecretManagement/blob/b1fbbd0e7f4c0e035e7a2d495472f8a2790fe04d/help/en-US/about_Microsoft.PowerShell.SecretManagement.help.txt

https://github.com/PowerShell/SecretManagement/blob/b1fbbd0e7f4c0e035e7a2d495472f8a2790fe04d/help/en-US/about_Microsoft.PowerShell.SecretManagement.md

https://github.com/PowerShell/SecretManagement/blob/b1fbbd0e7f4c0e035e7a2d495472f8a2790fe04d/ExtensionModules/CredManStore/help/en-US/about_Microsoft.PowerShell.CredManStore.md

These are all just the templates.

Environment data

Name                           Value
----                           -----
PSVersion                      7.1.3
PSEdition                      Core
GitCommitId                    7.1.3
OS                             Microsoft Windows 10.0.22000
Platform                       Win32NT
PSCompatibleVersions           {1.0, 2.0, 3.0, 4.0…}
PSRemotingProtocolVersion      2.3
SerializationVersion           1.1.0.1
WSManStackVersion              3.0

Version

7.1.3

Visuals

No response

OranguTech commented 8 months ago

This is still the case as of Microsoft.PowerShell.SecretManagement ver 1.1.2 , over a year later!