From 90d2caa1d53aff94757b1325a503b2ba7441c02e Mon Sep 17 00:00:00 2001 From: Rango Meadows Date: Fri, 8 Sep 2023 08:59:58 -0700 Subject: [PATCH 1/4] Fix Document Translation README.md links --- .../Azure.AI.Translation.Document/README.md | 14 +++++++------- 1 file changed, 7 insertions(+), 7 deletions(-) diff --git a/sdk/translation/Azure.AI.Translation.Document/README.md b/sdk/translation/Azure.AI.Translation.Document/README.md index 913a427b0569c..4252d6370c6f1 100644 --- a/sdk/translation/Azure.AI.Translation.Document/README.md +++ b/sdk/translation/Azure.AI.Translation.Document/README.md @@ -27,11 +27,11 @@ dotnet add package Azure.AI.Translation.Document Document Translation supports [single-service access][single_service] only. To access the service, create a Translator resource. -You can create either resource using: +You can create either resource using: **Option 1:** [Azure Portal][azure_portal_create_DT_resource]. -**Option 2:** [Azure CLI][cognitive_resource_cli]. +**Option 2:** [Azure CLI][cognitive_resource_cli]. Below is an example of how you can create a Translator resource using the CLI: @@ -85,7 +85,7 @@ var client = new DocumentTranslationClient(new Uri(endpoint), new AzureKeyCreden Client API key authentication is used in most of the examples in this getting started guide, but you can also authenticate with Azure Active Directory using the [Azure Identity library][azure_identity]. Note that regional endpoints do not support AAD authentication. -Create a [custom subdomain][custom_subdomain] for your resource in order to use this type of authentication. +Create a [custom subdomain][custom_subdomain] for your resource in order to use this type of authentication. To use the [DefaultAzureCredential][DefaultAzureCredential] provider shown below, or other credential providers provided with the Azure SDK, please install the Azure.Identity package: @@ -120,7 +120,7 @@ A `DocumentTranslationClient` is the primary interface for developers using the - Identifying supported glossary and document formats. ### Translation Input -To start a translation operation you need to create one instance or a list of `DocumentTranslationInput`. +To start a translation operation you need to create one instance or a list of `DocumentTranslationInput`. A single source URL to documents can be translated to many different languages: @@ -169,7 +169,7 @@ We guarantee that all client instance methods are thread-safe and independent of [Accessing the response](https://github.com/Azure/azure-sdk-for-net/blob/main/sdk/core/Azure.Core/README.md#accessing-http-response-details-using-responset) | [Handling failures](https://github.com/Azure/azure-sdk-for-net/blob/main/sdk/core/Azure.Core/README.md#reporting-errors-requestfailedexception) | [Diagnostics](https://github.com/Azure/azure-sdk-for-net/blob/main/sdk/core/Azure.Core/samples/Diagnostics.md) | -[Mocking](https://learn.microsoft.com/dotnet/azure/sdk/unit-testing-mocking) | +[Mocking](https://github.com/Azure/azure-sdk-for-net/blob/main/sdk/core/Azure.Core/README.md#mocking) | [Client lifetime](https://devblogs.microsoft.com/azure-sdk/lifetime-management-and-thread-safety-guarantees-of-azure-sdk-net-clients/) @@ -455,12 +455,12 @@ This project has adopted the [Microsoft Open Source Code of Conduct][code_of_con [documenttranslation_nuget_package]: https://www.nuget.org/packages/Azure.AI.Translation.Document [documenttranslation_samples]: https://github.com/Azure/azure-sdk-for-net/tree/main/sdk/translation/Azure.AI.Translation.Document/samples/README.md [documenttranslation_rest_api]: https://github.com/Azure/azure-rest-api-specs/blob/master/specification/cognitiveservices/data-plane/TranslatorText/stable/v1.0/TranslatorBatch.json -[custom_domain_endpoint]: https://learn.microsoft.com/azure/ai-services/translator/document-translation/how-to-guides/use-rest-api-programmatically?tabs=csharp#retrieve-your-key-and-custom-domain-endpoint +[custom_domain_endpoint]: https://learn.microsoft.com/en-us/azure/ai-services/translator/document-translation/quickstarts/document-translation-rest-api?pivots=programming-language-csharp#what-is-the-custom-domain-endpoint [single_service]: https://docs.microsoft.com/azure/cognitive-services/cognitive-services-apis-create-account?tabs=singleservice%2Cwindows [azure_portal_create_DT_resource]: https://ms.portal.azure.com/#create/Microsoft.CognitiveServicesTextTranslation [cognitive_resource_cli]: https://docs.microsoft.com/azure/cognitive-services/cognitive-services-apis-create-account-cli [dotnet_lro]: https://github.com/Azure/azure-sdk-for-net/blob/main/sdk/core/Azure.Core/README.md#consuming-long-running-operations-using-operationt -[source_containers]: https://docs.microsoft.com/azure/cognitive-services/translator/document-translation/get-started-with-document-translation?tabs=csharp#create-your-azure-blob-storage-containers +[source_containers]: https://learn.microsoft.com/en-us/azure/ai-services/translator/document-translation/quickstarts/document-translation-rest-api?pivots=programming-language-csharp#create-azure-blob-storage-containers [custom_model]: https://docs.microsoft.com/azure/cognitive-services/translator/custom-translator/quickstart-build-deploy-custom-model [glossary]: https://docs.microsoft.com/azure/cognitive-services/translator/document-translation/overview#supported-glossary-formats [sas_token]: https://docs.microsoft.com/azure/cognitive-services/translator/document-translation/create-sas-tokens?tabs=Containers#create-your-sas-tokens-with-azure-storage-explorer From 2d78544f0937f6ba6f5a69b38362d5c142f05502 Mon Sep 17 00:00:00 2001 From: Rango Meadows Date: Fri, 8 Sep 2023 15:54:54 -0700 Subject: [PATCH 2/4] Remove extra whitespace and remove en-us from links --- .../Azure.AI.Translation.Document/README.md | 13 +++++++------ 1 file changed, 7 insertions(+), 6 deletions(-) diff --git a/sdk/translation/Azure.AI.Translation.Document/README.md b/sdk/translation/Azure.AI.Translation.Document/README.md index 4252d6370c6f1..14923952d83bd 100644 --- a/sdk/translation/Azure.AI.Translation.Document/README.md +++ b/sdk/translation/Azure.AI.Translation.Document/README.md @@ -27,11 +27,11 @@ dotnet add package Azure.AI.Translation.Document Document Translation supports [single-service access][single_service] only. To access the service, create a Translator resource. -You can create either resource using: +You can create either resource using: **Option 1:** [Azure Portal][azure_portal_create_DT_resource]. -**Option 2:** [Azure CLI][cognitive_resource_cli]. +**Option 2:** [Azure CLI][cognitive_resource_cli]. Below is an example of how you can create a Translator resource using the CLI: @@ -85,7 +85,7 @@ var client = new DocumentTranslationClient(new Uri(endpoint), new AzureKeyCreden Client API key authentication is used in most of the examples in this getting started guide, but you can also authenticate with Azure Active Directory using the [Azure Identity library][azure_identity]. Note that regional endpoints do not support AAD authentication. -Create a [custom subdomain][custom_subdomain] for your resource in order to use this type of authentication. +Create a [custom subdomain][custom_subdomain] for your resource in order to use this type of authentication. To use the [DefaultAzureCredential][DefaultAzureCredential] provider shown below, or other credential providers provided with the Azure SDK, please install the Azure.Identity package: @@ -120,7 +120,7 @@ A `DocumentTranslationClient` is the primary interface for developers using the - Identifying supported glossary and document formats. ### Translation Input -To start a translation operation you need to create one instance or a list of `DocumentTranslationInput`. +To start a translation operation you need to create one instance or a list of `DocumentTranslationInput`. A single source URL to documents can be translated to many different languages: @@ -455,12 +455,13 @@ This project has adopted the [Microsoft Open Source Code of Conduct][code_of_con [documenttranslation_nuget_package]: https://www.nuget.org/packages/Azure.AI.Translation.Document [documenttranslation_samples]: https://github.com/Azure/azure-sdk-for-net/tree/main/sdk/translation/Azure.AI.Translation.Document/samples/README.md [documenttranslation_rest_api]: https://github.com/Azure/azure-rest-api-specs/blob/master/specification/cognitiveservices/data-plane/TranslatorText/stable/v1.0/TranslatorBatch.json -[custom_domain_endpoint]: https://learn.microsoft.com/en-us/azure/ai-services/translator/document-translation/quickstarts/document-translation-rest-api?pivots=programming-language-csharp#what-is-the-custom-domain-endpoint +[custom_domain_endpoint]: https://learn.microsoft.com/azure/ai-services/translator/document-translation/quickstarts/document-translation-rest-api?pivots=programming-language-csharp#what-is-the-custom-domain-endpoint [single_service]: https://docs.microsoft.com/azure/cognitive-services/cognitive-services-apis-create-account?tabs=singleservice%2Cwindows [azure_portal_create_DT_resource]: https://ms.portal.azure.com/#create/Microsoft.CognitiveServicesTextTranslation [cognitive_resource_cli]: https://docs.microsoft.com/azure/cognitive-services/cognitive-services-apis-create-account-cli [dotnet_lro]: https://github.com/Azure/azure-sdk-for-net/blob/main/sdk/core/Azure.Core/README.md#consuming-long-running-operations-using-operationt -[source_containers]: https://learn.microsoft.com/en-us/azure/ai-services/translator/document-translation/quickstarts/document-translation-rest-api?pivots=programming-language-csharp#create-azure-blob-storage-containers +[source_containers]: https://learn.microsoft.com/azure/ai-services/translator/document-translation/quickstarts/document-translation-rest-api?pivots=programming-language-csharp#create-azure-blob-storage-containers +[source_containers]: https://learn.microsoft.com/azure/ai-services/translator/document-translation/quickstarts/document-translation-rest-api?pivots=programming-language-csharp#create-azure-blob-storage-containers [custom_model]: https://docs.microsoft.com/azure/cognitive-services/translator/custom-translator/quickstart-build-deploy-custom-model [glossary]: https://docs.microsoft.com/azure/cognitive-services/translator/document-translation/overview#supported-glossary-formats [sas_token]: https://docs.microsoft.com/azure/cognitive-services/translator/document-translation/create-sas-tokens?tabs=Containers#create-your-sas-tokens-with-azure-storage-explorer From 981fa58c310516a228731547da1de1cc2948706b Mon Sep 17 00:00:00 2001 From: Rango Meadows Date: Mon, 11 Sep 2023 09:30:28 -0700 Subject: [PATCH 3/4] Revert mocking link change --- sdk/translation/Azure.AI.Translation.Document/README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/sdk/translation/Azure.AI.Translation.Document/README.md b/sdk/translation/Azure.AI.Translation.Document/README.md index 14923952d83bd..9050dc875554d 100644 --- a/sdk/translation/Azure.AI.Translation.Document/README.md +++ b/sdk/translation/Azure.AI.Translation.Document/README.md @@ -169,7 +169,7 @@ We guarantee that all client instance methods are thread-safe and independent of [Accessing the response](https://github.com/Azure/azure-sdk-for-net/blob/main/sdk/core/Azure.Core/README.md#accessing-http-response-details-using-responset) | [Handling failures](https://github.com/Azure/azure-sdk-for-net/blob/main/sdk/core/Azure.Core/README.md#reporting-errors-requestfailedexception) | [Diagnostics](https://github.com/Azure/azure-sdk-for-net/blob/main/sdk/core/Azure.Core/samples/Diagnostics.md) | -[Mocking](https://github.com/Azure/azure-sdk-for-net/blob/main/sdk/core/Azure.Core/README.md#mocking) | +[Mocking](https://learn.microsoft.com/dotnet/azure/sdk/unit-testing-mocking) | [Client lifetime](https://devblogs.microsoft.com/azure-sdk/lifetime-management-and-thread-safety-guarantees-of-azure-sdk-net-clients/) From 1ba12c6155f6b08133311d8d90b98f226bd0923c Mon Sep 17 00:00:00 2001 From: Rango Meadows Date: Wed, 13 Sep 2023 09:25:59 -0700 Subject: [PATCH 4/4] Remove duplicate URL --- sdk/translation/Azure.AI.Translation.Document/README.md | 1 - 1 file changed, 1 deletion(-) diff --git a/sdk/translation/Azure.AI.Translation.Document/README.md b/sdk/translation/Azure.AI.Translation.Document/README.md index 9050dc875554d..e40d6ee87627c 100644 --- a/sdk/translation/Azure.AI.Translation.Document/README.md +++ b/sdk/translation/Azure.AI.Translation.Document/README.md @@ -461,7 +461,6 @@ This project has adopted the [Microsoft Open Source Code of Conduct][code_of_con [cognitive_resource_cli]: https://docs.microsoft.com/azure/cognitive-services/cognitive-services-apis-create-account-cli [dotnet_lro]: https://github.com/Azure/azure-sdk-for-net/blob/main/sdk/core/Azure.Core/README.md#consuming-long-running-operations-using-operationt [source_containers]: https://learn.microsoft.com/azure/ai-services/translator/document-translation/quickstarts/document-translation-rest-api?pivots=programming-language-csharp#create-azure-blob-storage-containers -[source_containers]: https://learn.microsoft.com/azure/ai-services/translator/document-translation/quickstarts/document-translation-rest-api?pivots=programming-language-csharp#create-azure-blob-storage-containers [custom_model]: https://docs.microsoft.com/azure/cognitive-services/translator/custom-translator/quickstart-build-deploy-custom-model [glossary]: https://docs.microsoft.com/azure/cognitive-services/translator/document-translation/overview#supported-glossary-formats [sas_token]: https://docs.microsoft.com/azure/cognitive-services/translator/document-translation/create-sas-tokens?tabs=Containers#create-your-sas-tokens-with-azure-storage-explorer