Open emgarten opened 7 years ago
Can u explain user actions to see bad urls, so I can understand impact?
I see this: PM> get-help nuget TOPIC about_NuGet
SHORT DESCRIPTION Provides information about NuGet Package Manager commands.
LONG DESCRIPTION This topic describes the NuGet Package Manager commands. NuGet is an integrated package management tool for adding libraries and tools to .NET projects.
The following NuGet cmdlets are included.
Cmdlet Description
------------------ ----------------------------------------------
Find-Package Get the set of packages available from the package source,
based on the package Id/keyword. This is a new command that
will replace Get-Package -ListAvailable.
Get-Package Gets the set of installed packages. With -Updates switch,
gets the set of package updates available from the package source.
Install-Package Installs a package and its dependencies into the project.
Uninstall-Package Uninstalls a package. If other packages depend on this package,
the command will fail unless the –Force option is specified.
Update-Package Updates a package and its dependencies to a newer version.
Sync-Package Get the version of installed package from specified/default project
and sync the version to the rest of projects in the solution.
Add-BindingRedirect Examines all assemblies within the output path for a project
and adds binding redirects to the application (or web)
configuration file where necessary.
Get-Project Returns a reference to the DTE (Development Tools Environment)
for the specified project. If none is specifed, returns the
default project selected in the Package Manager Console.
Open-PackagePage Open the browser pointing to ProjectUrl, LicenseUrl or
ReportAbuseUrl of the specified package.
Register-TabExpansion Registers a tab expansion for the parameters of a command.
SEE ALSO Online documentation: http://go.microsoft.com/fwlink/?LinkID=206619 Find-Package Get-Package Install-Package Uninstall-Package Update-Package Sync-Package Add-BindingRedirect Get-Project Open-PackagePage Register-TabExpansion
@rrelyea these are under the command examples
get-help install-package
The impact is minor here, I've opened this issue for future tracking.
This Is what I see on latest VS 2022
PM> get-help install-package
NAME
Install-Package
SYNOPSIS
Installs a package.
SYNTAX
Install-Package [-Id] <string> [-IgnoreDependencies] [-ProjectName <string>] [[-Version] <string>] [[-Source] <string>] [-IncludePrerelease] [-FileConflictAction]
[-DependencyVersion] [-WhatIf] [<CommonParameters>]
DESCRIPTION
Installs a package and its dependencies into the project.
RELATED LINKS
Online version: https://docs.nuget.org/
Install-Package
REMARKS
To see the examples, type: "get-help Install-Package -examples".
For more information, type: "get-help Install-Package -detailed".
For technical information, type: "get-help Install-Package -full".
For online help, type: "get-help Install-Package -online"
PM> get-help install-package
NAME
Install-Package
SYNOPSIS
Installs a package.
SYNTAX
Install-Package [-Id] <string> [-IgnoreDependencies] [-ProjectName <string>] [[-Version] <string>] [[-Source] <string>] [-IncludePrerelease] [-FileConflictAction]
[-DependencyVersion] [-WhatIf] [<CommonParameters>]
DESCRIPTION
Installs a package and its dependencies into the project.
RELATED LINKS
Online version: https://docs.nuget.org/
Install-Package
REMARKS
To see the examples, type: "get-help Install-Package -examples".
For more information, type: "get-help Install-Package -detailed".
For technical information, type: "get-help Install-Package -full".
For online help, type: "get-help Install-Package -online"
When you use -online
flag, it opens https://docs.nuget.org ; do we want an specific page with detailed instructions on using install-package
?
PM> get-help install-package -Online
Ideally, if you type get-help find-package -online
, you should get pointed to command reference in docs https://docs.microsoft.com/en-us/nuget/reference/ps-reference/ps-ref-find-package
Update links in powershell help
The url in the install packages.config example is broken due to changes in the json-ld repository.
https://github.com/NuGet/NuGet.Client/blob/3a9e61a52f0e9bc47380031bcddc0a73ff3883ea/src/NuGet.Clients/VsConsole/PowerShellHost/Scripts/NuGet.PackageManagement.PowerShellCmdlets.dll-Help.xml#L181
The help also contains urls to the older docs.nuget.org site.
https://github.com/NuGet/NuGet.Client/blob/3a9e61a52f0e9bc47380031bcddc0a73ff3883ea/src/NuGet.Clients/VsConsole/PowerShellHost/Scripts/NuGet.PackageManagement.PowerShellCmdlets.dll-Help.xml#L212