PalmEmanuel / AzAuth

A PowerShell module to handle authentication for Azure.
MIT License
29 stars 5 forks source link

Improve documentation with more examples #27

Open PalmEmanuel opened 1 year ago

PalmEmanuel commented 1 year ago

Examples of more use cases would be good, for example when working with multiple resources in the same script or session. How to get multiple tokens with only one interactive auth etc.

m-hanisch commented 2 months ago

@PalmEmanuel Would you consider to add two of your very own related blog articles as RELATED LINKS to the Get-AzToken cmdlet help file? Maybe also add a hint to the second link in the description of the switch parameter -WorkloadIdentity?

Especially the second one is a valuable source of information when using the Get-AzToken cmdlet with the -WorkloadIdentity switch parameter. I tried to figure out how to contribute to your repo myself. However, I do not feel comfortable enough how to proceed if I want to update an existing .md help file. Simply editing the .md file? Or using Update-MarkdownHelp?

PalmEmanuel commented 2 months ago

@PalmEmanuel Would you consider to add two of your very own related blog articles as RELATED LINKS to the Get-AzToken cmdlet help file? Maybe also add a hint to the second link in the description of the switch parameter -WorkloadIdentity?

Especially the second one is a valuable source of information when using the Get-AzToken cmdlet with the -WorkloadIdentity switch parameter. I tried to figure out how to contribute to your repo myself. However, I do not feel comfortable enough how to proceed if I want to update an existing .md help file. Simply editing the .md file? Or using Update-MarkdownHelp?

That's a very good idea, I'll be sure to do that!

PalmEmanuel commented 2 months ago

Added blog links, thanks for the suggestion @m-hanisch! It will show up in the next release 👍