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

Get-Help -Online parameter, required functionality #58

Closed
jongeller opened this issue May 12, 2016 · 3 comments
Closed

Get-Help -Online parameter, required functionality #58

jongeller opened this issue May 12, 2016 · 3 comments
Assignees
Milestone

Comments

@jongeller
Copy link
Contributor

Creating this issue to ensure we test this functionality
When get-help is run against a cmdlets, if the -online parameter is used, an web page will be opened where the published version of the help can be seen.

The link data is available in the related links section, but the documentation authors need to be sure this will work once the conversion from MD to MAML is performed.

Get-Help Add-Computer -online
#links to: 
#https://technet.microsoft.com/library/712f3460-c5d0-4af8-8de6-6d06e4a1a838(v=wps.630).aspx

This link, is stored in the MAML related links section here, note the Online Version text:

    <maml:relatedLinks>
      <maml:navigationLink>
        <maml:linkText>Online Version:</maml:linkText>
        <maml:uri>http://go.microsoft.com/fwlink/p/?linkid=290488</maml:uri>
      </maml:navigationLink>
    </maml:relatedLinks>
@vors vors added this to the 0.4.0 milestone May 14, 2016
@vors vors self-assigned this May 14, 2016
@jongeller
Copy link
Contributor Author

After talking with @sankethka we agreed, that though this data populates in the Related Links section of the MAML. It does not make sense as something that should be seen in the Markdown.

@vors -
Can we add this to the metadata section at the top of each Cmdlet MD page?

something like this:

---
external help file: gShell.dll-Help.xml
schema: 2.0.0
online help URI: http://go.microsoft.com/fwlink/p/?linkid=290488
---

@vors
Copy link
Collaborator

vors commented May 16, 2016

We tried it out with @sankethka on Friday and found that it's just a regular relatedLink entry. There is nothing special about this link as far as maml concerns.

I already added a code in vors/new-markdown branch to expose this option for FromCommand parameter set. Let's keep it simple and as is.

@vors vors mentioned this issue May 17, 2016
@vors
Copy link
Collaborator

vors commented May 17, 2016

Fixed

@vors vors closed this as completed May 17, 2016
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants