From 89a4045ad852e3c7f590f771d54d5e9704e6554d Mon Sep 17 00:00:00 2001 From: Christopher Scott Date: Tue, 8 Sep 2020 16:05:25 -0500 Subject: [PATCH 1/3] Reomve locale links and fix anchor links --- sdk/tables/Azure.Data.Tables/CHANGELOG.md | 2 +- .../{readme.md => README.md} | 20 +++++++++---------- .../Azure.Data.Tables/samples/README.md | 2 +- 3 files changed, 12 insertions(+), 12 deletions(-) rename sdk/tables/Azure.Data.Tables/{readme.md => README.md} (93%) diff --git a/sdk/tables/Azure.Data.Tables/CHANGELOG.md b/sdk/tables/Azure.Data.Tables/CHANGELOG.md index 58b6b762a4ef..1420b7c32336 100644 --- a/sdk/tables/Azure.Data.Tables/CHANGELOG.md +++ b/sdk/tables/Azure.Data.Tables/CHANGELOG.md @@ -7,5 +7,5 @@ This is the first beta of the `Azure.Data.Tables` client library. The Azure Tables client library can seamlessly target either Azure Table storage or Azure Cosmos DB table service endpoints with no code changes. -This package's [documentation](https://github.com/Azure/azure-sdk-for-net/blob/master/sdk/tables/Azure.Data.Tables/readme.md) +This package's [documentation](https://github.com/Azure/azure-sdk-for-net/blob/master/sdk/tables/Azure.Data.Tables/README.md) and [samples](https://github.com/Azure/azure-sdk-for-net/tree/master/sdk/tables/Azure.Data.Tables/samples) demonstrate the new API. diff --git a/sdk/tables/Azure.Data.Tables/readme.md b/sdk/tables/Azure.Data.Tables/README.md similarity index 93% rename from sdk/tables/Azure.Data.Tables/readme.md rename to sdk/tables/Azure.Data.Tables/README.md index d67b579c6954..01447e6cad9b 100644 --- a/sdk/tables/Azure.Data.Tables/readme.md +++ b/sdk/tables/Azure.Data.Tables/README.md @@ -68,14 +68,14 @@ Common uses of the Table service include: Learn more about options for authentication _(including Connection Strings, Shared Key, and Shared Key Signatures)_ [in our samples.](samples/Sample0Auth.md) ## Examples -- [Create the Table service client](#Create-the-Table-service-client) - - [Create an Azure table](#Create-an-Azure-table) - - [Get an Azure table](#Get-an-Azure-table) - - [Delete an Azure table](#Delete-an-Azure-table) -- [Create the Table client](#Create-the-Table-client) - - [Add table entities](#Add-table-entities) - - [Query table entities ](#Query-table-entities) - - [Delete table entities](#Delete-table-entities) +- [Create the Table service client](#create-the-table-service-client) + - [Create an Azure table](#create-an-azure-table) + - [Get an Azure table](#get-an-azure-table) + - [Delete an Azure table](#delete-an-azure-table) +- [Create the Table client](#create-the-table-client) + - [Add table entities](#add-table-entities) + - [Query table entities ](#query-table-entities) + - [Delete table entities](#delete-table-entities) ### Create the Table service client @@ -257,13 +257,13 @@ For more information see the [Code of Conduct FAQ][coc_faq] or contact [opencode@microsoft.com][coc_contact] with any additional questions or comments. -[tables_rest]: https://docs.microsoft.com/en-us/rest/api/storageservices/table-service-rest-api +[tables_rest]: https://docs.microsoft.com/rest/api/storageservices/table-service-rest-api [azure_cli]: https://docs.microsoft.com/cli/azure [azure_sub]: https://azure.microsoft.com/free/ [table_client_nuget_package]: https://www.nuget.org/packages?q=Azure.Data.Tables [table_client_samples]: https://github.com/Azure/azure-sdk-for-net/blob/master/sdk/tables/Azure.Data.Tables/samples [table_client_src]: https://github.com/Azure/azure-sdk-for-net/blob/master/sdk/tables/Azure.Data.Tables/src -[api_reference]: https://docs.microsoft.com/en-us/azure/cosmos-db/table-introduction +[api_reference]: https://docs.microsoft.com/azure/cosmos-db/table-introduction [logging]: https://github.com/Azure/azure-sdk-for-net/blob/master/sdk/core/Azure.Core/samples/Diagnostics.md [contrib]: ./CONTRIBUTING.md [cla]: https://cla.microsoft.com diff --git a/sdk/tables/Azure.Data.Tables/samples/README.md b/sdk/tables/Azure.Data.Tables/samples/README.md index d7a5c050d4f3..eab61d03e096 100644 --- a/sdk/tables/Azure.Data.Tables/samples/README.md +++ b/sdk/tables/Azure.Data.Tables/samples/README.md @@ -20,7 +20,7 @@ Description of Azure Tables. Covers following functions: * Authenticating the client You can find samples for each of this main functions below. -To get started you'll need an Azure Tables endpoint and credentials. See Azure Tables Client Library [Readme](../readme.md) for more information and instructions. +To get started you'll need an Azure Tables endpoint and credentials. See Azure Tables Client Library [Readme](../README.md) for more information and instructions. - [Create/delete tables](Sample1CreateDeleteTables.md) - [Query tables](Sample3QueryTables.md) From 398fb3044b8cec11aa1ad786f1ca81bf862134fc Mon Sep 17 00:00:00 2001 From: Christopher Scott Date: Tue, 8 Sep 2020 16:16:01 -0500 Subject: [PATCH 2/3] fixup relative links --- sdk/tables/Azure.Data.Tables/README.md | 1 - sdk/tables/Azure.Data.Tables/samples/README.md | 2 +- 2 files changed, 1 insertion(+), 2 deletions(-) diff --git a/sdk/tables/Azure.Data.Tables/README.md b/sdk/tables/Azure.Data.Tables/README.md index 01447e6cad9b..a3c797e5e623 100644 --- a/sdk/tables/Azure.Data.Tables/README.md +++ b/sdk/tables/Azure.Data.Tables/README.md @@ -265,7 +265,6 @@ For more information see the [Code of Conduct FAQ][coc_faq] or contact [table_client_src]: https://github.com/Azure/azure-sdk-for-net/blob/master/sdk/tables/Azure.Data.Tables/src [api_reference]: https://docs.microsoft.com/azure/cosmos-db/table-introduction [logging]: https://github.com/Azure/azure-sdk-for-net/blob/master/sdk/core/Azure.Core/samples/Diagnostics.md -[contrib]: ./CONTRIBUTING.md [cla]: https://cla.microsoft.com [coc]: https://opensource.microsoft.com/codeofconduct/ [coc_faq]: https://opensource.microsoft.com/codeofconduct/faq/ diff --git a/sdk/tables/Azure.Data.Tables/samples/README.md b/sdk/tables/Azure.Data.Tables/samples/README.md index eab61d03e096..a95fac3fb6c9 100644 --- a/sdk/tables/Azure.Data.Tables/samples/README.md +++ b/sdk/tables/Azure.Data.Tables/samples/README.md @@ -20,7 +20,7 @@ Description of Azure Tables. Covers following functions: * Authenticating the client You can find samples for each of this main functions below. -To get started you'll need an Azure Tables endpoint and credentials. See Azure Tables Client Library [Readme](../README.md) for more information and instructions. +To get started you'll need an Azure Tables endpoint and credentials. See Azure Tables Client Library [Readme](https://github.com/Azure/azure-sdk-for-net/blob/master/sdk/tables/Azure.Data.Tables/README.md) for more information and instructions. - [Create/delete tables](Sample1CreateDeleteTables.md) - [Query tables](Sample3QueryTables.md) From 9419987d4eddfa6771e8cb464e2a5888e70d7014 Mon Sep 17 00:00:00 2001 From: Christopher Scott Date: Tue, 8 Sep 2020 16:42:12 -0500 Subject: [PATCH 3/3] move auth section under getting started --- sdk/tables/Azure.Data.Tables/README.md | 7 ++++--- 1 file changed, 4 insertions(+), 3 deletions(-) diff --git a/sdk/tables/Azure.Data.Tables/README.md b/sdk/tables/Azure.Data.Tables/README.md index a3c797e5e623..f17fd567355b 100644 --- a/sdk/tables/Azure.Data.Tables/README.md +++ b/sdk/tables/Azure.Data.Tables/README.md @@ -49,6 +49,10 @@ az cosmosdb create --name MyCosmosDBDatabaseAccount --resource-group MyResourceG az cosmosdb table create --name MyTableName --resource-group MyResourceGroup --account-name MyCosmosDBDatabaseAccount ``` +### Authenticate the Client + +Learn more about options for authentication _(including Connection Strings, Shared Key, and Shared Key Signatures)_ [in our samples.](samples/Sample0Auth.md) + ## Key concepts - `TableServiceClient` - Client that provides methods to interact at the Table Service level such as creating, listing, and deleting tables @@ -63,9 +67,6 @@ Common uses of the Table service include: - Quickly querying data using a clustered index - Accessing data using the OData protocol and LINQ filter expressions -### Authenticate the Client - -Learn more about options for authentication _(including Connection Strings, Shared Key, and Shared Key Signatures)_ [in our samples.](samples/Sample0Auth.md) ## Examples - [Create the Table service client](#create-the-table-service-client)