Skip to content
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

Updates to the azure_identity README #1990

Open
wants to merge 14 commits into
base: main
Choose a base branch
from

Conversation

ronniegeraghty
Copy link
Member

Frist draft for the Identity README.md.
Copied from Python identity README.md, updating syntax, examples and links.
Pretty much went through the credentials their README.md referenced and checked if we had that cred implemented yet.

Still many TODOs and ?(questions) in the doc.

@ronniegeraghty
Copy link
Member Author

It looks like the checks are failing because in the README.md I put an example that uses azure_data_cosmos::CosmosClient. I believe the check is trying to run the example, but the identity crate workspace doesn't include the cosmos crate. Is that right? Not sure how to resolve this. Looks like the old README.md uses a StorageAccountClient in its example but it had to create and impl the struct in the example. I feel like that adds a lot of code to the example that users won't and shouldn't bring into their projects.

@ronniegeraghty
Copy link
Member Author

Fixes #1967

@heaths heaths changed the title Ronniegeraghty identity readme update Updates to the azure_identity README Jan 14, 2025
@LarryOsterman
Copy link
Member

Note to self: The markdown is NOT the content - look at the rendered output before leaving feedback.

sdk/identity/azure_identity/README.md Outdated Show resolved Hide resolved
sdk/identity/azure_identity/README.md Outdated Show resolved Hide resolved
sdk/identity/azure_identity/README.md Outdated Show resolved Hide resolved
sdk/identity/azure_identity/README.md Outdated Show resolved Hide resolved
sdk/identity/azure_identity/README.md Outdated Show resolved Hide resolved
sdk/identity/azure_identity/README.md Outdated Show resolved Hide resolved
@ronniegeraghty ronniegeraghty requested a review from heaths January 30, 2025 20:11
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants