[DOCS] Update login command docs to include links to user-guide articles#1966
[DOCS] Update login command docs to include links to user-guide articles#1966YannickRe wants to merge 1 commit intopnp:masterfrom YannickRe:improve-login-documentation
Conversation
|
|
||
| Managed identity in Azure Cloud Shell is the identity of the user. It is neither system- nor user-assigned and it can't be configured. To log in to Microsoft 365 using managed identity in Azure Cloud Shell, set `authType` to `identity` and don't specify the `userName` option. | ||
|
|
||
| See the following pages for more detailed information: |
There was a problem hiding this comment.
Would these links be a good fit for the More information section that we typically use like: https://pnp.github.io/cli-microsoft365/cmd/aad/approleassignment/approleassignment-add/#more-information?
There was a problem hiding this comment.
Maybe, more information generally points to external links. These are links to three internal articles that describe some more detail the steps to take when doing the authentication. I went for the login command to find my information, if it wasn't for someone on twitter providing me with the link to the Caveats article, I wouldn't have found it.
I feel they fit in that section, but maybe as part of the text, not as a summary. Like some sort of intro that points to the first article, mentioning the caveats article somewhere in the flow of the text. It would take some more effort into rewriting this part and still keep the flow.
There was a problem hiding this comment.
Would you like to give it a try and rewrite the body to include the links in content?
There was a problem hiding this comment.
I'll put it on the list 😃. If anyone else wants to take a jab at it before I get around to it, I will not feel offended 😉
There was a problem hiding this comment.
@waldekmastykarz I made some effort to put the links in the flow of the text.
There was a problem hiding this comment.
Awesome! We'll go through your suggestions asap. Thank you 👏
…eats article, directly from the login command documentation and in the flow of the text
waldekmastykarz
left a comment
waldekmastykarz
left a comment
There was a problem hiding this comment.
Awesome work! Nothing to add. Thank you! 👏
|
Merged manually. Thank you! 👏 |
2 participants
Added links to the more generic documentation, and especially the caveats article directly from the login command documentation.
It helps users more easily discover the global user guide articles when struggling with a specific action in the login command.