PowerShell / PSResourceGet

PSResourceGet is the package manager for PowerShell
https://www.powershellgallery.com/packages/Microsoft.PowerShell.PSResourceGet
MIT License
485 stars 92 forks source link

Undateable help files aren't being published #1307

Closed anamnavi closed 1 year ago

anamnavi commented 1 year ago

Prerequisites

Steps to reproduce

Get-Help Find-PSResource

help info returned would be better for user help experience if it included: Examples Description Synopsis Parameters also lack descriptions

Expected behavior

See above

Actual behavior

Currently missing examples and other helpful info.

Error details

No response

Environment data

0.5.23-beta23

Visuals

No response

anamnavi commented 1 year ago

Also in this doc: https://learn.microsoft.com/en-us/powershell/module/microsoft.powershell.psresourceget/find-psresource?view=powershellget-3.x

It would be helpful if Example 3 had a description for how the VersionRange in that scenario operates, and link to the Package Versioning doc that is listed in -Version param section below. Or allude to it being there for more info (i.e "For more information on Version and accepted version range values/combinations, see the -Version parameter section below")

LaurentDardenne commented 1 year ago

Parameters also lack descriptions

See to -Priority https://github.com/MicrosoftDocs/PowerShell-Docs-PSGet/issues/47

sdwheeler commented 1 year ago

@anamnavi Two things:

  1. This issue should be in MicrosoftDocs/PowerShell-Docs-PSGet. The cmdlets are fully documented, but if there is room for improvement or needed examples, please add them to the docs repo.
  2. It looks like the updateable help files aren't being published. I need to investigate that.
SydneyhSmith commented 1 year ago
  1. It looks like the updateable help files aren't being published. I need to investigate that.

@sdwheeler should I open an issue for that in the PowerShellGet docs repo or do we want to track that here?

sdwheeler commented 1 year ago

The CI job was not configured since moving the Docs to the new repo. It's fixed now.