platyPS icon indicating copy to clipboard operation
platyPS copied to clipboard

V2 Related links section has improper information

Open sdwheeler opened this issue 4 years ago • 4 comments

I ran PlatyPS v2 against PlatyPS v2.

New-MarkdownHelp.md has the following related links section:

## RELATED LINKS

[] (https://go.microsoft.com/fwlink/?LinkID=2096483)

There are 2 problems

  1. The link shown is the HelpURI for New-MarkdownHelp which should not be include in the related links of the markdown file.
  2. The link is not properly formed (extra space, no text in the [])

Get-MarkdownMetadata.md has the following:

## RELATED LINKS

Fill Related Links Here

In this case, the placeholder text is missing the {{ }}.

sdwheeler avatar May 24 '21 18:05 sdwheeler

It seems that for the help for New-MarkdownHelp cmdlet has the link in it:

get-help New-MarkdownHelp | Select-Object -ExpandProperty relatedLinks

navigationLink
--------------
{@{uri=https://go.microsoft.com/fwlink/?LinkID=2096483}}

There is nothing much we can do here in platyPS if the help content has this.

adityapatwardhan avatar Jul 08 '21 18:07 adityapatwardhan

Seeing this too: image

Translation of a link works fine with 0.14.1 In v2, the link text is removed and a space is introduced after the link

here the original code block:

  <#
  .SYNOPSIS
    Tests whether a specific ServicePlan is included in an AzureAd License
  [...]
  .FUNCTIONALITY
    Tests whether the ServicePlan is included in the specified Plan License
  .LINK
    https://github.com/DEberhardt/TeamsFunctions/tree/master/docs/Test-AzureAdLicenseContainsServicePlan.md
  .LINK
    https://github.com/DEberhardt/TeamsFunctions/tree/master/docs/about_Supporting_Functions.md
  .LINK
    https://github.com/DEberhardt/TeamsFunctions/tree/master/docs/
  #>

Desired behaviour

[Test-AzureAdLicenseContainsServicePlan](https://github.com/DEberhardt/TeamsFunctions/tree/master/docs/Test-AzureAdLicenseContainsServicePlan.md)

Get-Help delivers me this btw:

❯ get-help Test-AzureAdLicenseContainsServicePlan | Select-Object -ExpandProperty relatedLinks

https://github.com/DEberhardt/TeamsFunctions/tree/master/docs/Test-AzureAdLicenseContainsServicePlan.md
https://github.com/DEberhardt/TeamsFunctions/tree/master/docs/about_Supporting_Functions.md
https://github.com/DEberhardt/TeamsFunctions/tree/master/docs/

Have I misinterpreted how to record these links, or is this the bug in v2 that causing this?

DEberhardt avatar Jun 30 '22 16:06 DEberhardt

Don't know if this is related, but he OnlineVersion is removed after running it with v2:

image

DEberhardt avatar Jun 30 '22 16:06 DEberhardt

Need to discuss the design for this with Jim.

sdwheeler avatar May 24 '24 15:05 sdwheeler