Adding aliases to a few cmdlets and updating help documentation to match #4110

akromm-zz · 2017-06-09T20:46:37Z

Description

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.

I have read the contribution guidelines.
If changes were made to any cmdlet, the XML help was regenerated using the platyPSHelp module.
If any large changes are made to a service, they are reflected in the respective change log.

General Guidelines

Title of the pull request is clear and informative.
There are a small number of commits, each of which have an informative message. This means that previously merged commits do not appear in the history of the PR. For more information on cleaning up the commits in your PR, see this page.
The pull request does not introduce breaking changes (unless a major version change occurs in the assembly and module).

Testing Guidelines

Pull request includes test coverage for the included changes.
PowerShell scripts used in tests should do any necessary setup as part of the test or suite setup, and should not use hard-coded values for locations or existing resources.

Cmdlet Signature Guidelines

New cmdlets that make changes or have side effects should implement ShouldProcess and have SupportShouldProcess=true specified in the cmdlet attribute. You can find more information on ShouldProcess here.
Cmdlet specifies OutputType attribute if any output is produced - if the cmdlet produces no output, it should implement a PassThru parameter.

Cmdlet Parameter Guidelines

Parameter types should not expose types from the management library - complex parameter types should be defined in the module.
Complex parameter types are discouraged - a parameter type should be simple types as often as possible. If complex types are used, they should be shallow and easily creatable from a constructor or another cmdlet.
Cmdlet parameter sets should be mutually exclusive - each parameter set must have at least one mandatory parameter not in other parameter sets.

…tch.

cormacpayne

@akromm I believe you will need to add the aliases (and mapping to corresponding cmdlets) in the following files:

akromm-zz · 2017-06-09T21:25:01Z

@cormacpayne I'm only adding aliases to cmdlet parameters and not to any cmdlet name. Is it still required to modify those files (there is no cmdlet mapping)?

I mixed up cmdlet and parameter aliases - ignore my previous comment

cormacpayne · 2017-06-09T23:15:37Z

src/ResourceManager/Sql/Commands.Sql/help/AzureRM.Sql.md

@@ -8,7 +8,7 @@ Locale: en-US

 # AzureRM.Sql Module
 ## Description
-This topic displays help topics for the [Azure SQL Database](https://docs.microsoft.com/azure/sql-database/) Cmdlets.


@akromm I think this was a change that was recently made. Do we want to revert it?

Yes, thank you for catching. Where is the source for this comment? I'd like to change it at the source so that future re-generation of this file doesn't cause this.

@akromm I was under the impression that this was the source. Do you remember the command you used to regenerate the markdown help?

@cormacpayne I used platyPS:
$pathToHelpFolder = "E:\git\azure-powershell\src\ResourceManager\Sql\Commands.Sql\help"
Update-MarkdownHelpModule -Path $PathToHelpFolder -RefreshModulePage -AlphabeticParamsOrder

@akromm that's the correct command. I would assume this is an issue with how platyPS parses the markdown (maybe it can't handle links?). I can investigate myself and open an issue in their repository if necessary.

jaredmoo · 2017-06-09T23:26:40Z

src/ResourceManager/Sql/Commands.Sql/help/New-AzureRmSqlDatabase.md

@@ -169,7 +169,7 @@ Specifies the maximum size of the database in bytes.
 ```yaml
 Type: Int64
 Parameter Sets: (All)
-Aliases:
+Aliases: 


nit: remove?

This is auto generated so I'd rather leave it.

jaredmoo · 2017-06-09T23:27:57Z

src/ResourceManager/Sql/Commands.Sql/help/New-AzureRmSqlElasticPool.md

-100 DTUs
- Premium.
-125 DTUs
+For the current preview, the edition must be Standard.


obsolete comment? we have basic and premium edition pools now.

I have removed this.

akromm-zz · 2017-06-09T23:51:00Z

src/ResourceManager/Sql/Commands.Sql/help/New-AzureRmSqlDatabase.md

 ### CommonParameters
-
-This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216).
+This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).


@cormacpayne how do I make the generated markdown include the missing '[' and ']' ?

@akromm it does not appear to be platyPS intention to have the brackets around the link: https://github.com/PowerShell/platyPS/blob/b0c97c9de267d9ca46bfef17610a92648efa5069/src/Markdown.MAML/Resources/MarkdownStrings.resx#L175

@akromm I'd have to look, but I think a previously opened PR made the change to wrap the about_CommonParameters text in the '[' and ']' brackets

@cormacpayne correct, a previous PR added in the enclosed brackets to make the text a link. I would like to keep it that way during future re-generation of the doc files.

What are your thoughts?

@akromm I agree, it would make it much nicer to view in markdown. I can also talk to the platyPS team about how we can prevent this from getting overridden in the future, since it seems to be a hard-coded string that they use for when a cmdlet uses the above set of verbs.

Adding aliases to a few cmdlets and updating help documentation to ma…

d0252b5

…tch.

akromm-zz requested a review from jaredmoo June 9, 2017 20:46

msftclas added the cla-not-required label Jun 9, 2017

This was referenced Jun 9, 2017

0.9.7 ARM :: Rename -DatabaseName parameter to -Name on *SqlDatabase commands #819

Closed

Get-AzureRmSqlServer 'ServerName' parameter and property should be called 'Name' #4093

Closed

cormacpayne previously requested changes Jun 9, 2017

View reviewed changes

cormacpayne assigned akromm-zz Jun 9, 2017

cormacpayne added the needs-revision label Jun 9, 2017

azuresdkci added the needs-review label Jun 9, 2017

adding missing license header.

25d7fa5

cormacpayne previously approved these changes Jun 9, 2017

View reviewed changes

cormacpayne removed the needs-review label Jun 9, 2017

akromm-zz mentioned this pull request Jun 9, 2017

SQL: missing license headers #3662

Closed

jaredmoo previously approved these changes Jun 9, 2017

View reviewed changes

Updating obsolete documentation comment.

7052a61

akromm-zz dismissed stale reviews from jaredmoo and cormacpayne via 7052a61 June 9, 2017 23:47

akromm-zz commented Jun 9, 2017

View reviewed changes

cormacpayne approved these changes Jun 13, 2017

View reviewed changes

cormacpayne merged commit bc5354c into Azure:preview Jun 13, 2017

akromm-zz mentioned this pull request Jun 13, 2017

SQL documentation improvements reverted by platyPS #4124

Closed

akromm-zz mentioned this pull request Aug 10, 2017

Update-MarkdownHelp should preserve original formatting PowerShell/platyPS#292

Open

Adding aliases to a few cmdlets and updating help documentation to match #4110

Adding aliases to a few cmdlets and updating help documentation to match #4110

Uh oh!

Conversation

akromm-zz commented Jun 9, 2017 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description

Uh oh!

cormacpayne left a comment

Choose a reason for hiding this comment

Uh oh!

akromm-zz commented Jun 9, 2017

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

akromm-zz commented Jun 9, 2017 •

edited

Loading