From 923900011a0a99ef52bcc1d438fb688f53e62872 Mon Sep 17 00:00:00 2001 From: "Erich(Renyong) Wang" Date: Tue, 9 Jun 2020 11:10:47 +0800 Subject: [PATCH] update readmes --- .../Azure.ResourceManager.AppConfiguration/README.md | 5 +++-- sdk/compute/Azure.ResourceManager.Compute/README.md | 4 ++-- sdk/eventhub/Azure.ResourceManager.EventHubs/README.md | 4 ++-- sdk/keyvault/Azure.ResourceManager.KeyVault/README.md | 4 ++-- sdk/network/Azure.ResourceManager.Network/README.md | 4 ++-- sdk/resources/Azure.ResourceManager.Resources/README.md | 4 ++-- sdk/storage/Azure.ResourceManager.Storage/README.md | 4 ++-- 7 files changed, 15 insertions(+), 14 deletions(-) diff --git a/sdk/appconfiguration/Azure.ResourceManager.AppConfiguration/README.md b/sdk/appconfiguration/Azure.ResourceManager.AppConfiguration/README.md index 8f2ff80ff8e9..5cd4c6261230 100644 --- a/sdk/appconfiguration/Azure.ResourceManager.AppConfiguration/README.md +++ b/sdk/appconfiguration/Azure.ResourceManager.AppConfiguration/README.md @@ -14,6 +14,7 @@ Use the guidelines in each section of this template to ensure consistency and re * Next, add a **bulleted list** of the **most common tasks** supported by the package or library, prefaced with "Use the client library for [Product Name] to:". Then, provide code snippets for these tasks in the [Examples](#examples) section later in the document. Keep the task list short but include those tasks most developers need to perform with your package. * Include this single line of links targeting your product's content at the bottom of the introduction, making any adjustments as necessary (for example, NuGet instead of PyPi): + [Source code](https://github.com/Azure/azure-sdk-for-python/tree/master/azure-batch) | [Package (PyPi)](https://pypi.org/project/azure-batch/) | [API reference documentation](https://docs.microsoft.com/python/api/overview/azure/batch?view=azure-python) | [Product documentation](https://docs.microsoft.com/azure/batch/) > TIP: Your README should be as **brief** as possible but **no more brief** than necessary to get a developer new to Azure, the service, or the package up and running quickly. Keep it brief, but include everything a developer needs to make their first API call successfully. @@ -26,9 +27,9 @@ This section should include everything a developer needs to do to install and cr First, provide instruction for obtaining and installing the package or library. This section might include only a single line of code, like `pip install package-name`, but should enable a developer to successfully install the package from NuGet, pip, npm, Maven, or even cloning a GitHub repository. -Include a **Prerequisites** line after the install command that details any requirements that must be satisfied before a developer can [authenticate](#authenticate-the-client) and test all of the snippets in the [Examples](#examples) section. For example, for Cosmos DB: +### Prerequisites -**Prerequisites**: You must have an [Azure subscription](https://azure.microsoft.com/free/), [Cosmos DB account](https://docs.microsoft.com/azure/cosmos-db/account-overview) (SQL API), and [Python 3.6+](https://www.python.org/downloads/) to use this package. +* You must have an [Azure subscription](https://azure.microsoft.com/free/) ### Authenticate the client diff --git a/sdk/compute/Azure.ResourceManager.Compute/README.md b/sdk/compute/Azure.ResourceManager.Compute/README.md index d96af171ce9e..87028f10e725 100644 --- a/sdk/compute/Azure.ResourceManager.Compute/README.md +++ b/sdk/compute/Azure.ResourceManager.Compute/README.md @@ -26,9 +26,9 @@ This section should include everything a developer needs to do to install and cr First, provide instruction for obtaining and installing the package or library. This section might include only a single line of code, like `pip install package-name`, but should enable a developer to successfully install the package from NuGet, pip, npm, Maven, or even cloning a GitHub repository. -Include a **Prerequisites** line after the install command that details any requirements that must be satisfied before a developer can [authenticate](#authenticate-the-client) and test all of the snippets in the [Examples](#examples) section. For example, for Cosmos DB: +### Prerequisites -**Prerequisites**: You must have an [Azure subscription](https://azure.microsoft.com/free/), [Cosmos DB account](https://docs.microsoft.com/azure/cosmos-db/account-overview) (SQL API), and [Python 3.6+](https://www.python.org/downloads/) to use this package. +* You must have an [Azure subscription](https://azure.microsoft.com/free/) ### Authenticate the client diff --git a/sdk/eventhub/Azure.ResourceManager.EventHubs/README.md b/sdk/eventhub/Azure.ResourceManager.EventHubs/README.md index 8566094ea3b0..9dfec6e4102c 100644 --- a/sdk/eventhub/Azure.ResourceManager.EventHubs/README.md +++ b/sdk/eventhub/Azure.ResourceManager.EventHubs/README.md @@ -26,9 +26,9 @@ This section should include everything a developer needs to do to install and cr First, provide instruction for obtaining and installing the package or library. This section might include only a single line of code, like `pip install package-name`, but should enable a developer to successfully install the package from NuGet, pip, npm, Maven, or even cloning a GitHub repository. -Include a **Prerequisites** line after the install command that details any requirements that must be satisfied before a developer can [authenticate](#authenticate-the-client) and test all of the snippets in the [Examples](#examples) section. For example, for Cosmos DB: +### Prerequisites -**Prerequisites**: You must have an [Azure subscription](https://azure.microsoft.com/free/), [Cosmos DB account](https://docs.microsoft.com/azure/cosmos-db/account-overview) (SQL API), and [Python 3.6+](https://www.python.org/downloads/) to use this package. +* You must have an [Azure subscription](https://azure.microsoft.com/free/) ### Authenticate the client diff --git a/sdk/keyvault/Azure.ResourceManager.KeyVault/README.md b/sdk/keyvault/Azure.ResourceManager.KeyVault/README.md index 00272db1fafa..5c2635a1adb5 100644 --- a/sdk/keyvault/Azure.ResourceManager.KeyVault/README.md +++ b/sdk/keyvault/Azure.ResourceManager.KeyVault/README.md @@ -26,9 +26,9 @@ This section should include everything a developer needs to do to install and cr First, provide instruction for obtaining and installing the package or library. This section might include only a single line of code, like `pip install package-name`, but should enable a developer to successfully install the package from NuGet, pip, npm, Maven, or even cloning a GitHub repository. -Include a **Prerequisites** line after the install command that details any requirements that must be satisfied before a developer can [authenticate](#authenticate-the-client) and test all of the snippets in the [Examples](#examples) section. For example, for Cosmos DB: +### Prerequisites -**Prerequisites**: You must have an [Azure subscription](https://azure.microsoft.com/free/), [Cosmos DB account](https://docs.microsoft.com/azure/cosmos-db/account-overview) (SQL API), and [Python 3.6+](https://www.python.org/downloads/) to use this package. +* You must have an [Azure subscription](https://azure.microsoft.com/free/) ### Authenticate the client diff --git a/sdk/network/Azure.ResourceManager.Network/README.md b/sdk/network/Azure.ResourceManager.Network/README.md index 75799adf5df3..08f8195841f1 100644 --- a/sdk/network/Azure.ResourceManager.Network/README.md +++ b/sdk/network/Azure.ResourceManager.Network/README.md @@ -26,9 +26,9 @@ This section should include everything a developer needs to do to install and cr First, provide instruction for obtaining and installing the package or library. This section might include only a single line of code, like `pip install package-name`, but should enable a developer to successfully install the package from NuGet, pip, npm, Maven, or even cloning a GitHub repository. -Include a **Prerequisites** line after the install command that details any requirements that must be satisfied before a developer can [authenticate](#authenticate-the-client) and test all of the snippets in the [Examples](#examples) section. For example, for Cosmos DB: +### Prerequisites -**Prerequisites**: You must have an [Azure subscription](https://azure.microsoft.com/free/), [Cosmos DB account](https://docs.microsoft.com/azure/cosmos-db/account-overview) (SQL API), and [Python 3.6+](https://www.python.org/downloads/) to use this package. +* You must have an [Azure subscription](https://azure.microsoft.com/free/) ### Authenticate the client diff --git a/sdk/resources/Azure.ResourceManager.Resources/README.md b/sdk/resources/Azure.ResourceManager.Resources/README.md index 1b60647bdb4d..3c76339b7b52 100644 --- a/sdk/resources/Azure.ResourceManager.Resources/README.md +++ b/sdk/resources/Azure.ResourceManager.Resources/README.md @@ -26,9 +26,9 @@ This section should include everything a developer needs to do to install and cr First, provide instruction for obtaining and installing the package or library. This section might include only a single line of code, like `pip install package-name`, but should enable a developer to successfully install the package from NuGet, pip, npm, Maven, or even cloning a GitHub repository. -Include a **Prerequisites** line after the install command that details any requirements that must be satisfied before a developer can [authenticate](#authenticate-the-client) and test all of the snippets in the [Examples](#examples) section. For example, for Cosmos DB: +### Prerequisites -**Prerequisites**: You must have an [Azure subscription](https://azure.microsoft.com/free/), [Cosmos DB account](https://docs.microsoft.com/azure/cosmos-db/account-overview) (SQL API), and [Python 3.6+](https://www.python.org/downloads/) to use this package. +* You must have an [Azure subscription](https://azure.microsoft.com/free/) ### Authenticate the client diff --git a/sdk/storage/Azure.ResourceManager.Storage/README.md b/sdk/storage/Azure.ResourceManager.Storage/README.md index 6c66ea937ba6..debbc22408f2 100644 --- a/sdk/storage/Azure.ResourceManager.Storage/README.md +++ b/sdk/storage/Azure.ResourceManager.Storage/README.md @@ -26,9 +26,9 @@ This section should include everything a developer needs to do to install and cr First, provide instruction for obtaining and installing the package or library. This section might include only a single line of code, like `pip install package-name`, but should enable a developer to successfully install the package from NuGet, pip, npm, Maven, or even cloning a GitHub repository. -Include a **Prerequisites** line after the install command that details any requirements that must be satisfied before a developer can [authenticate](#authenticate-the-client) and test all of the snippets in the [Examples](#examples) section. For example, for Cosmos DB: +### Prerequisites -**Prerequisites**: You must have an [Azure subscription](https://azure.microsoft.com/free/), [Cosmos DB account](https://docs.microsoft.com/azure/cosmos-db/account-overview) (SQL API), and [Python 3.6+](https://www.python.org/downloads/) to use this package. +* You must have an [Azure subscription](https://azure.microsoft.com/free/) ### Authenticate the client