Azure Identity October Release Doc Consistency Review

[joshfree]

tracking item for README, Samples, TROUBLESHOOT, and Changelog consistency review

[pvaneck]

Notable consistency updates:

README

• As a part of VSCodeCredential Improvements for Copper #27777, in the "DefaultAzureCredential" key concept section, add a disclaimer about VisualStudioCodeCredential and remove VSCodeCredential from diagram and list.
  • Example: https://github.com/Azure/azure-sdk-for-python/blob/main/sdk/identity/azure-identity/README.md#note-about-visualstudiocodecredential

General consistency + issues

• Add a "Cloud configuration" section (Example)
• Provide or link to example for ManagedIdentityCredential in "Managed Identity Support" section.
• Add a "Reference" column to "Credential Class" tables. See this example
• Sentence-case all headings
• Replace all occurrences of "docs.microsoft.com" with "learn.microsoft.com"
• In "Getting Started", "Credential classes", and "Examples", avoid starting headings with "-ing" words when possible
  • s/Authenticating/Authenticate/
  • s/Specifying/Specify/
  • s/Enabling/Enable/
• Update intro paragraph to one used here
• Replace subsequent instances of "Azure Active Directory" and "AAD" with "Azure AD" which is the preferred short form.
• Find and replace: "the Azure Cloud" -> "Azure"
• Verify if AAD B2C is supported. If so, remove from Known issues section.

TROUBLESHOOTING

• Update wording in "Troubleshoot Multi Tenant Authentication Issues"
  • "This error was added as part of functional a breaking change to multi tenant authentication..."
• Update "Troubleshoot environment credential authentication issues" section to include a reference to AZURE_CLIENT_CERTIFICATE_PASSWORD.
  • "...ensure the variables AZURE_CLIENT_ID, AZURE_TENANT_ID, AZURE_CLIENT_CERTIFICATE_PATH, and optionally AZURE_CLIENT_CERTIFICATE_PASSWORD are properly set."
• Create a "Troubleshoot ClientAssertionCredential Authentication Issues" section which was added by JS a few months ago.
  • Reference
• "Troubleshoot ManagedIdentityCredential authentication issues" section: order host environments in table alphabetically
• Replace all occurrences of ’ with ' (i.e. curly quotation mark with straight quotation mark)
• Replace all occurrences of "docs.microsoft.com" with "learn.microsoft.com"

Samples

• .NET seems to be the only SDK without Redis samples.

[pvaneck]

FYI, Reference readme + troubleshooting has been merged: Azure/azure-sdk-for-python#26483
I have notated the majority of the changes that should be made in the above comment. Let me know if additional assistance is needed.