Track 2 Mgmt Preview docs and readme update based on new namespace #12871
Conversation
nickzhums
requested review from
AlexanderSher,
AlexGhiondea,
amishra-dev,
amnguye,
annelo-msft,
heaths,
jsquire,
kasobol-msft,
kinelski,
schaabs,
seanmcc-msft,
serkantkaraca and
tg-msft
as code owners
| @@ -1,69 +1,51 @@ | |||
| # README.md template | |||
| # Azure Management EventHubs client library for .NET | |||
There was a problem hiding this comment.
nit: There should be a space in the product name: Event Hubs. Leaving one client here, but the same is true for the other non-code references below.
|
|
||
| For example, include details on obtaining an account key and endpoint URI, setting environment variables for each, and initializing the client object. | ||
| Various documentation is available to help you learn how to use this package |
There was a problem hiding this comment.
This reads a bit awkwardly. Perhaps something like various forms of documentation or various resources ?
| Issues](https://github.com/Azure/azure-sdk-for-net/issues) | ||
| - Check [previous | ||
| questions](https://stackoverflow.com/questions/tagged/azure+.net) | ||
| or ask new ones on StackOverflow using azure and .NET tags. |
There was a problem hiding this comment.
nit: "... using the azure and .net tags." (Stack Overflow tags are lower case)
| Issues](https://github.com/Azure/azure-sdk-for-net/issues) | ||
| - Check [previous | ||
| questions](https://stackoverflow.com/questions/tagged/azure+.net) | ||
| or ask new ones on StackOverflow using azure and .NET tags. |
There was a problem hiding this comment.
nit: "Stack Overflow" (missing space)
| ### Prerequisites | ||
|
|
||
| * You must have an [Azure subscription](https://azure.microsoft.com/free/) | ||
| Install the Azure Management EventHubs client library for .NET with [NuGet](https://www.nuget.org/): |
There was a problem hiding this comment.
Are we calling this a "client library?" My understanding was that we used the term "client" only with respect to the data plane.
There was a problem hiding this comment.
@AlexGhiondea, @KrzysztofCwalina: Would you be so kind as to offer your thoughts on the above?
|
|
||
| ### Authenticate the client | ||
| ```PowerShell | ||
| Install-Package Azure.ResourceManager.KeyVault |
There was a problem hiding this comment.
Aren't these packages still previews? This needs to include the --version <preview version number> and changed with each release like we do for the data-plane SDKs.
|
|
||
| For example, include details on obtaining an account key and endpoint URI, setting environment variables for each, and initializing the client object. | ||
| Various documentation is available to help you learn how to use this package |
There was a problem hiding this comment.
"documentation" is generally plural, so "Various documentation" doesn't read right. I'd just say "Documentation ..." and the list below works better.
|  | ||
| This project has adopted the Microsoft Open Source Code of Conduct. For | ||
| more information see the Code of Conduct FAQ or contact | ||
| <opencode@microsoft.com> with any additional questions or comments. |
There was a problem hiding this comment.
All these READMEs should probably have the impressions image we use for stats. See data-plane READMEs for examples.
There was a problem hiding this comment.
not all management RPs currently have data-plane counterpart, is there an impression image generation tool ?
Co-authored-by: erich-wang <eriwan@microsoft.com>
Co-authored-by: erich-wang <eriwan@microsoft.com>
Co-authored-by: erich-wang <eriwan@microsoft.com>
nickzhums
dismissed
jsquire’s stale review
Files updated based on the review comments and need to unblock for release
…12871) * Update compute readme * Update resources * Update storage readme * Update resources readme * Update network * Update event hubs * Update app configuration * Update key vault readme
No description provided.