[Tracking] Create documentation for the cmdlets Authentication module

[maisarissi]

We need to provide better documentation for the cmdlets we have in the Authentication module. Today the only information we provide lives in the README.md, in the app-only authentication and there are a few more in this PR.

There is no centralized information for the Authentication module and its cmdlets.

The goal is to add missing cmdlets/information in the PowerShell Browser documentation and link it in the Graph docs site. Which means the content will live in one place, facilitating maintenance, but it will be discoverable in various places.

For existing content as Find-MgGraphCommand and Find-MgGraphPermission, it should be possible to type and be redirect to the Powershell online docs when:

Get-Help Find-MgGraphCommand -Online

or

Get-Help Find-MgGraphPermission -Online

instead of getting an error:

Get-Help: The online version of this Help topic cannot be displayed because the Internet address (URI) of the Help topic is not specified in the command code or in the help file for the command.

After creating the content for the authentication module, it should also be possible to Get-Help online for each of the cmdlets. As an example:

Get-Help Connect-MgGraph -Online

and be redirect to the Graph PowerShell docs.

Tasks

• [x] #1411
• [ ] #1412
• [ ] #1413

[maisarissi]

Hi @lramosvea @jasonjoh Can you help us here? How do we manage the content creation? We should use the PowerShell Browser docs as the source of truth and link it to the Graph docs site. The reason why browser docs should be the main source is because when you call

Get-Help <cmdlet> -Online

you will be redirect to that docs page. As you can see, we already replicate the content that exists in the Graph docs site in the browser documentation thanks to @msewaweru . Now we need to have a plan to better suit what we need for the missing information.

What we need document are the following:

Connect-Graph

Disconnect-Graph

Get-MgContext

Get-MgProfile

Select-MgProfile

Invoke-GraphRequest

Add-MgEnvironment

Get-MgEnviroment

Remove-MgEnviroment

Set-MgEnviroment

[lramosvea]

Hi @maisarissi, so you will be adding a new element to the PowerShell browser docs under Reference, which will be called Microsoft.Graph.Authentication with the info on all these cmdlets, correct?

Then, will you need to update only this existing page? with the new info on these cmdlets or do you want to create a new page?

[maisarissi]

Hi @lramosvea . That's a good question.

I believe there is no way for us to create a new reference page called Microsoft.Graph.Authentication. Our reference documentation is created by an automated process using the AutoREST.PowerShell tool. If we create a new page manually, this will be overridden in the next run. We can only manually create content in the conceptual documentation, so they don't get overwritten.

@georgend can we investigate whether is it possible to add the Microsoft.Graph.Authentication module to the docs generation?

[peombwa]

As part of this task, we should add links to various online reference docs for relevant parameters. e.g., Connect-MgGraph -Scope should have a link to https://docs.microsoft.com/en-us/graph/permissions-reference in its description.