Powershell: `Get-Help Clear-Host -Online` gives broken link

[YogurtTheHorse]

Steps to reproduce

get-help clear-host -Online

Expected behavior

Should give proper links for help

Actual behavior

Gives https://go.microsoft.com/fwlink/?LinkID=225747, which produces 404

Environment data

> $PSVersionTable

Name                           Value
----                           -----
PSVersion                      6.1.0
PSEdition                      Core
GitCommitId                    6.1.0
OS                             Linux 4.15.0-34-generic #37~16.04.1-Ubuntu SMP Tue Aug 28 10:44:06 UTC 2018
Platform                       Unix
PSCompatibleVersions           {1.0, 2.0, 3.0, 4.0...}
PSRemotingProtocolVersion      2.3
SerializationVersion           1.1.0.1
WSManStackVersion              3.0

Running on Elementary Loki

[YogurtTheHorse]

I just found, that any Get-Help output produces broken links :(
So Get-Help Get-Process -Online opens https://go.microsoft.com/fwlink/?linkid=821590

[doctordns]

Both Get-Help Clear-Host and Get-Help Clear-Host -Detailed work here.

What does NOT work is using -Online.

Using -Online with ANY Get-Help command fails with a 404 error. It has been reported. But it's still broken.

I think the PowerShell team area aware - but I'll tag Joey just in case!

@joeyaiello

[YogurtTheHorse]

Yeah. Problem in -Online. Edited, so it will be clear

[doctordns]

Thanks for the update.

The -ONLINE issue is known about. It seems to affect ANY call to Get-Help that uses -online.

[YogurtTheHorse]

Yeah. Seems like that. So, is that duplicate?

[doctordns]

Interestingly - this bug does NOT exist in PowerShell v6.

[MaximoTrinidad]

This is a known issue and seems it will take some time to fix as they are doing some updates.
Makes Microsoft Online Docs Great Again!!

Patience Is Golden!!

[doctordns]

I agree, but only up to a point. That it works in 6.1 but fails in 5.1 is curious.

A blog post on the PowerShell blog might help.

[YogurtTheHorse]

But I use 6.1 and bug exists in my configuration

[MaximoTrinidad]

Hi @doctordns (Thomas)

Yeah! You're right. But, they are handling it.
:)

[KalleOlaviNiemitalo]

Get-Help Clear-Host -Online in PowerShell 7.1.0-preview.3 opens https://go.microsoft.com/fwlink/?LinkID=2096480, which correctly redirects to https://docs.microsoft.com/powershell/module/Microsoft.PowerShell.Core/Clear-Host?view=powershell-7. It was fixed in https://github.com/PowerShell/PowerShell/pull/11071.

However, Get-Help prompt -Online in PowerShell 7.1.0-preview.3 opens https://go.microsoft.com/fwlink/?LinkID=225750, which uselessly redirects to https://www.microsoft.com?ref=go. That should redirect to https://docs.microsoft.com/powershell/module/microsoft.powershell.core/about/about_prompts?view=powershell-7, instead.

I don't know whether the online links have been fixed for PowerShell Core 6.2, which is still supported until September 2020.

Clear-Host (Microsoft.PowerShell.Core)

The Clear-Host function removes all text from the current display, including commands and output that might have accumulated. When complete, it displays the command prompt. You can use the function name or its alias, cls. Clear-Host affects only the current display. It does not delete saved results or remove any items from the session. Session-specific items, such as variables and functions, are not affected by this function. Because the behavior of the Clear-Host function is determined by the host program, Clear-Host might work differently in different host programs.

Clear-Host (Microsoft.PowerShell.Core)

The Clear-Host function removes all text from the current display, including commands and output that might have accumulated. When complete, it displays the command prompt. You can use the function name or its alias, cls. Clear-Host affects only the current display. It does not delete saved results or remove any items from the session. Session-specific items, such as variables and functions, are not affected by this function. Because the behavior of the Clear-Host function is determined by the host program, Clear-Host might work differently in different host programs.

Microsoft - Official Home Page

At Microsoft our mission and values are to help people and businesses throughout the world realize their full potential.

about_Prompts - PowerShell

[yecril71pl]

However, Get-Help prompt -Online in PowerShell 7.1.0-preview.3 opens https://go.microsoft.com/fwlink/?LinkID=225750, which uselessly redirects to https://www.microsoft.com?ref=go. That should redirect to https://docs.microsoft.com/powershell/module/microsoft.powershell.core/about/about_prompts?view=powershell-7, instead.

Duplicate of https://github.com/MicrosoftDocs/PowerShell-Docs/issues/2939#issuecomment-657233237

[KalleOlaviNiemitalo]

Duplicate of MicrosoftDocs/PowerShell-Docs#2939 (comment)

No, that comment says "there is no HelpURI for about topics." For Get-Help prompt -Online, there actually is a HelpURI, but it redirects to the wrong page:

PS Temp:\> (Get-Command prompt).HelpUri
https://go.microsoft.com/fwlink/?LinkID=225750

It is defined here: https://github.com/PowerShell/PowerShell/blob/dd73c303a86ee04afca54a2be949c18299f2d8ed/src/System.Management.Automation/engine/InitialSessionState.cs#L4766-L4771

[yecril71pl]

However, Get-Help prompt -Online in PowerShell 7.1.0-preview.3 opens https://go.microsoft.com/fwlink/?LinkID=225750, which uselessly redirects to https://www.microsoft.com?ref=go. That should redirect to https://docs.microsoft.com/powershell/module/microsoft.powershell.core/about/about_prompts?view=powershell-7, instead.

I do not think it should, as HELP PROMPT does not.

Microsoft - Official Home Page

At Microsoft our mission and values are to help people and businesses throughout the world realize their full potential.

about_Prompts - PowerShell

[KalleOlaviNiemitalo]

I do not think it should, as HELP PROMPT does not.

Do you mean that, because HELP PROMPT does not show the same offline help as HELP about_prompts, they should not have the same online help URI? If that is what you mean, I agree.

[yecril71pl]

Neither does HELP CONFIGURATION -O. I do not have local help for the module.

GMO PSDesiredStateConfiguration | % HelpInfoUri | % { START $_ }

The specified blob does not exist.

[ThomasNieto]

Get-Help Clear-Host -Online works on 7.1 rc1.

[vexx32]

Marked as fixed for now. If there are other issues around help, please open separate issues for those cases. Thanks!

[msftbot[bot]]

This issue has been marked as fixed and has not had any activity for 1 day. It has been closed for housekeeping purposes.

[rjmholt]

Reopening, due to the reversion of https://github.com/PowerShell/PowerShell/pull/13176 in https://github.com/PowerShell/PowerShell/pull/14107

[msftbot[bot]]

This issue has been marked as fixed and has not had any activity for 1 day. It has been closed for housekeeping purposes.

[rjmholt]

Whoops, didn't realise the bot would do that