New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Update readme with native auth content #2080
Update readme with native auth content #2080
Conversation
README.md
Outdated
The MSAL library for iOS and macOS gives your app the ability to begin using the [Microsoft Identity platform](https://aka.ms/aaddev) by supporting [Azure Active Directory](https://azure.microsoft.com/en-us/services/active-directory/) and [Microsoft Accounts](https://account.microsoft.com) in a converged experience using industry standard OAuth2 and OpenID Connect. The library also supports [Azure AD B2C](https://azure.microsoft.com/services/active-directory-b2c/) for those using our hosted identity management service. | ||
| Documentation | Sample Code | Library Reference | Support | Feedback| | ||
|-------------------------------|---------------------------|-------------------|---------|----------| | ||
| [MSAL iOS and macOS documentation](https://learn.microsoft.com/en-us/entra/msal/objc/) <br/> [Workforce apps tutorials](https://learn.microsoft.com/en-us/entra/identity-platform/tutorial-v2-ios)<br/> Customer apps tutorials <br/> • Browser-delegated <br/>• Native Authentication | [Workforce samples](https://learn.microsoft.com/en-us/entra/identity-platform/sample-v2-code?tabs=framework#ios) <br/> [Customer samples](https://learn.microsoft.com/en-us/entra/identity-platform/sample-v2-code?tabs=apptype#mobile) | [ MSAL iOS and macOS reference](https://azuread.github.io/microsoft-authentication-library-for-objc/) | [Support](https://github.com/AzureAD/microsoft-authentication-library-for-objc/blob/dev/README.md#community-help-and-support) | [Feedback](https://forms.office.com/r/xuBV0CzEih) | |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Edit: Ignore for now, just saw it's in Draft
Because the links are one under the other they aren't clear that they 2 different links.
There should be a way to differentiate them
Not sure how the name on Github "Workforce apps tutorials" connects to the name in the link "Tutorial: Sign in users and call Microsoft Graph from an iOS or macOS app" - https://learn.microsoft.com/en-us/entra/identity-platform/tutorial-v2-ios
Same for the links under "Workforce samples" which leads to https://learn.microsoft.com/en-us/entra/identity-platform/sample-v2-code?tabs=framework#ios and the MSAL iOS and macOS reference which leads to the Mobile - https://learn.microsoft.com/en-us/entra/identity-platform/sample-v2-code?tabs=apptype#mobile
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks @spetrescu84 for an early review here.
For the documentation updates and links:
- We point to the official MSAL ObjC docs on MS Learn - https://learn.microsoft.com/en-us/entra/msal/objc/
- Within the getting started section of the readme, we provide links to the different quickstarts/tutorials that devs can follow, based on their scenario and type of app they're building (workforce/customer)
- I've also removed much of the content that's duplicated in the official docs (configuration, initialize client app, and acquire tokens) and instead pointed to the guidance on MS Learn, i.e:
As for the code samples, we also need to differentiate the between workforce and customer sample apps, that's why we have two links. Eventually, the links will point to the code samples browser, such as (https://learn.microsoft.com/en-us/samples/browse/?products=microsoft-authentication-library) I'm working to get all code samples for iOS and macOS onboarded there.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Comments inline - thanks!
Co-authored-by: Brian Melton-Grace <iambmelton@gmail.com>
Co-authored-by: Danilo Raspa <105228698+nilo-ms@users.noreply.github.com>
Co-authored-by: Danilo Raspa <105228698+nilo-ms@users.noreply.github.com>
@iambmelt could you please merge this. Looks like I don't have the permissions . |
@Dickson-Mwendia I've requested another member of our team sign-off before I do /cc @fidelianawar @Veena11 |
Co-authored-by: Brian Melton-Grace <iambmelton@gmail.com>
Co-authored-by: Danilo Raspa <105228698+nilo-ms@users.noreply.github.com>
Reintroducing minimum version indicators that were [mistakenly?] removed in #2080
Proposed changes
Describe what this PR is trying to do.
Type of change
Risk
Additional information