-
Notifications
You must be signed in to change notification settings - Fork 4.1k
Add link to cmdlet help on docs site to support online help #4934
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Conversation
markcowl
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The changes loom good. We should update the changelog, as well as the changelog for each module to indicate this change.
|
on demand run here: https://azuresdkci.westus2.cloudapp.azure.com/view/PowerShell/job/powershell-demand/155/ packaging run here: http://azuresdkci.cloudapp.net/view/1-AzurePowerShell/job/posh-pack/97/ |
| --- | ||
| --- | ||
| external help file: Microsoft.Azure.Commands.AnalysisServices.Dataplane.dll-Help.xml | ||
| online version: |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
should be 'online version'
tools/AzureRM/AzureRM.psd1
Outdated
| @@ -163,6 +163,8 @@ PrivateData = @{ | |||
| # ReleaseNotes of this module | |||
| ReleaseNotes = '## 2017.11.8 - Version 5.0.0 | |||
| * NOTE: This is a breaking change release. Please see the migration guide (https://aka.ms/azps-migration-guide) for a full list of breaking changes introduced. | |||
| * All cmdlets in AzureRM now support online help | |||
| - Run Get-Help with the -Online parameter to open the online help in your default Internet | |||
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
... in your default Internet browser?
ChangeLog.md
Outdated
| ## 2017.11.8 - Version 5.0.0 | ||
| * NOTE: This is a breaking change release. Please see the migration guide (https://aka.ms/azps-migration-guide) for a full list of introduced breaking changes. | ||
| * All cmdlets in AzureRM now support online help | ||
| - Run Get-Help with the -Online parameter to open the online help in your default Internet |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
same here
|
on demand run here:https://azuresdkci.westus2.cloudapp.azure.com/job/powershell-demand/157/ packagign run here: https://azuresdkci.westus2.cloudapp.azure.com/view/PowerShell/job/posh-pack/9/ |
|
signing job here: http://azuresdkci.cloudapp.net/job/powershell-sign/1402/ |
Description
Fix for issue #667
For each cmdlet, add link to corresponding documentation on https://docs.microsoft.com to allow users to run the command
Get-Help <cmdlet> -Online.This checklist is used to make sure that common guidelines for a pull request are followed. You can find a more complete discussion of PowerShell cmdlet best practices here.
General Guidelines
Testing Guidelines
Cmdlet Signature Guidelines
ShouldProcessand haveSupportShouldProcess=truespecified in the cmdlet attribute. You can find more information onShouldProcesshere.OutputTypeattribute if any output is produced - if the cmdlet produces no output, it should implement aPassThruparameter.Cmdlet Parameter Guidelines