Description
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
- Conceptual documentation around Authentication module #1411
- Add support in the Graph PS SDK to generate a new node in the reference documentation following the same pattern we have for all other modules #1412
- Link Get-Help for each Authentication module cmdlet to their respective content page in PowerShell docs. #1413