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

Add HelpUri to functions #89

Open
JohnRoos opened this issue Mar 6, 2021 · 1 comment
Open

Add HelpUri to functions #89

JohnRoos opened this issue Mar 6, 2021 · 1 comment
Labels

Comments

@JohnRoos
Copy link
Member

JohnRoos commented Mar 6, 2021

Describe the solution you'd like
Since we have all the documentation as markdown we should add HelpUri for each function which would point to the markdown file for that function. In that way its possible to use the -Online parameter for Get-Help.

Example:

function Build-Bicep {
    [CmdletBinding(DefaultParameterSetName = 'Default',
        SupportsShouldProcess,
        HelpUri = 'https://github.com/StefanIvemo/BicepPowerShell/blob/v1.4.2/Docs/Help/Build-Bicep.md')]
    ...
}

However, this should be release-specific, so we should not add a generic Url. It should be for the version installed (as in the example above).

@JohnRoos JohnRoos added the enhancement New feature or request label Mar 6, 2021
@egullbrandsson
Copy link
Collaborator

I'll add a script to automatically do this and then we can re-use it for a GitHub action.

@StefanIvemo StefanIvemo linked a pull request May 20, 2021 that will close this issue
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging a pull request may close this issue.

4 participants