Powershell: Update HelpInfoUri for all modules for v7 release

Created on 11 Dec 2019  路  15Comments  路  Source: PowerShell/PowerShell

Need to create new FWLinks for Update-Help for v7 for the following modules:

  • CimCmdlets
  • Microsoft.PowerShell.Archive
  • Microsoft.PowerShell.Core
  • Microsoft.PowerShell.Diagnostics
  • Microsoft.PowerShell.Host
  • Microsoft.PowerShell.Management
  • Microsoft.PowerShell.Security
  • Microsoft.PowerShell.Utility
  • Microsoft.WSMan.Management
  • PackageManagement
  • PowerShellGet
  • PSDesiredStateConfiguration
  • PSDiagnostics
  • PSReadLine
  • ThreadJob

NOTE: ThreadJob has never had an FWLink. We need this created for both v6 and v7.

Need to know new URLs so we can update the module pages in the docs.

Issue-Question WG-Interactive-HelpSystem

Most helpful comment

After upgrading to PS 7, Update-Help leads to below error

Update-Help: Failed to update Help for the module(s) 'PSDesiredStateConfiguration, ThreadJob' with UI culture(s) {en-GB} : One or more errors occurred. (Response status code does not indicate success: 404 (The specified blob does not exist.).).
English-US help content is available and can be installed using: Update-Help -UICulture en-US

On another machine fails for UI culture en-US as well

Is this related to this or requires a separate issue to be raised

All 15 comments

The current FWLink for PSDesiredStateConfiguration goes to download.microsoft.com. Do we own the content?

@sdwheeler #11389 was merged. Please update status of the issue.

@adityapatwardhan All HelpInfoURI FWLinks created prior PSv6 point to download.microsoft.com. We don't have access to update the content on the download center. That is why we use Azure blob store now.

11389 updates the following modules

  • CimCmdlets
  • Microsoft.PowerShell.Core
  • Microsoft.PowerShell.Diagnostics
  • Microsoft.PowerShell.Host
  • Microsoft.PowerShell.Management
  • Microsoft.PowerShell.Security
  • Microsoft.PowerShell.Utility
  • Microsoft.WSMan.Management
  • PSDiagnostics

The remaining modules are in other repos

  • Microsoft.PowerShell.Archive
  • PackageManagement
  • PowerShellGet
  • PSDesiredStateConfiguration
  • PSReadLine
  • ThreadJob

How do you want to track these?

These are external but somewhere these should be tracked. :-)

@iSazonov Why was this assigned to a release?

@TravisEz13 There was nothing more suitable, but it should not have been forgotten by accident.

After upgrading to PS 7, Update-Help leads to below error

Update-Help: Failed to update Help for the module(s) 'PSDesiredStateConfiguration, ThreadJob' with UI culture(s) {en-GB} : One or more errors occurred. (Response status code does not indicate success: 404 (The specified blob does not exist.).).
English-US help content is available and can be installed using: Update-Help -UICulture en-US

On another machine fails for UI culture en-US as well

Is this related to this or requires a separate issue to be raised

That definitely sounds related. Thanks for pointing that out! 馃挅

This task seems to be missing some modules:

Update-Help: Failed to update Help for the module(s) 'PSDesiredStateConfiguration, ThreadJob, WindowsUpdateProvider' with UI culture(s) {nb-NO} : One or more errors occurred. (Response status code does not indicate success: 404 (The specified blob does not exist.).).
Update-Help: Failed to update Help for the module(s) 'ConfigDefender, Defender, Microsoft.PowerShell.Operation.Validation, UEV, Whea, WindowsDeveloperLicense' with UI culture(s) {nb-NO} : A Help URI cannot contain more than 10 redirections.
Update-Help -UICulture en-US: Failed to update Help for the module(s) 'PSDesiredStateConfiguration, ThreadJob, WindowsUpdateProvider' with UI culture(s) {en-US} : One or more errors occurred. (Response status code does not indicate success: 404 (The specified blob does not exist.).).
Update-Help -UICulture en-US: Failed to update Help for the module(s) 'ConfigDefender, Defender, Microsoft.PowerShell.Operation.Validation, UEV, Whea, WindowsDeveloperLicense' with UI culture(s) {en-US} : A Help URI cannot contain more than 10 redirections.

Linking https://github.com/PaulHigin/PSThreadJob/issues/61 to this thread. Pre-installed modules really should have help available.

I can't help but feel that they should have somewhat robust help available before they become pre-installed. The help system in PowerShell is incredibly useful and it's really disappointing to write about high profile modules with incomplete or absent help content.

cc @PaulHigin

We have help but there may be a problem with the file naming that prevents Update-Help from working for ThreadJob. This will be fixed in the new publishing pipeline.

The ThreadJob help will be fixed when we publish the new build of the module. This should be fixed in 7.1 GA. PSDesiredStateConfiguration help works in Windows. There is an issue with this on Ubuntu 18.04.

See related:

I think this issue can be closed.

Was this page helpful?
0 / 5 - 0 ratings