diff --git a/docs-ref-services/sdk-template-readme-pre.md b/docs-ref-services/sdk-template-readme-pre.md index 125195b698856..db4d80a2cfb5a 100644 --- a/docs-ref-services/sdk-template-readme-pre.md +++ b/docs-ref-services/sdk-template-readme-pre.md @@ -1,25 +1,24 @@ --- title: Azure Batch client library for Python -keywords: Azure, java, SDK, API, azure-sdk-template, +keywords: Azure, java, SDK, API, azure-sdk-template, templatetemplate author: maggiepint ms.author: magpint -ms.date: 07/29/2020 +ms.date: 09/15/2020 ms.topic: article ms.prod: azure ms.technology: azure ms.devlang: java -ms.service: +ms.service: templatetemplate --- # README.md template -Use the guidelines in each section of this template to ensure consistency and readability of your README. The README resides in your package's GitHub repository at the root of its directory within the repo. It's also used as the package distribution page (NuGet, PyPi, npm, etc.) and as a Quickstart on docs.microsoft.com. See [README-EXAMPLE.md](README-EXAMPLE.md) for an example following this template. +Use the guidelines in each section of this template to ensure consistency and readability of your README. The README resides in your package's GitHub repository at the root of its directory within the repo. It's also used as the package distribution page (NuGet, PyPi, npm, etc.) and as a Quickstart on docs.microsoft.com. **Title**: The H1 of your README should be in the format: `# [Product Name] client library for [Language]` -* All headings, including the H1, should use **sentence-style capitalization**. Refer to the [Microsoft Style Guide][style-guide-msft] and [Microsoft Cloud Style Guide][style-guide-cloud] for more information. - -* Example: `# Azure Batch client library for Python - Version 1.0.4-beta.25 +* All headings, including the H1, should use **sentence-style capitalization**. Refer to the [Microsoft Style Guide][style-guide-msft]. +* Example: `# Azure Batch client library for Python - Version 1.2.1-beta.3 ` **Introduction**: The introduction appears directly under the title (H1) of your README. @@ -27,9 +26,6 @@ Use the guidelines in each section of this template to ensure consistency and re * **DO NOT** use an "Introduction" or "Overview" heading (H2) for this section. * First sentence: **Describe the service** briefly. You can usually use the first line of the service's docs landing page for this (Example: [Cosmos DB docs landing page](https://docs.microsoft.com/azure/cosmos-db/)). * 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. @@ -69,7 +65,7 @@ Each example in the *Examples* section starts with an H3 that describes the exam ### Create the thing -Use the [create_thing](not-valid-link) method to create a Thing reference; this method does not make a network call. To persist the Thing in the service, call [Thing.save](not-valid-link). +Use the `create_thing` method to create a Thing reference; this method does not make a network call. To persist the Thing in the service, call `Thing.save`. ```Python thing = client.create_thing(id, name) @@ -78,7 +74,7 @@ thing.save() ### Get the thing -The [get_thing](not-valid-link) method retrieves a Thing from the service. The `id` parameter is the unique ID of the Thing, not its "name" property. +The `get_thing` method retrieves a Thing from the service. The `id` parameter is the unique ID of the Thing, not its "name" property. ```Python thing = client.get_thing(id) @@ -86,7 +82,7 @@ thing = client.get_thing(id) ### List the things -Use [list_things](not-valid-link) to get one or more Thing objects from the service. If there are no Things available, a `404` exception is thrown (see [Troubleshooting](#troubleshooting) for details on handling exceptions). +Use `list_things` to get one or more Thing objects from the service. If there are no Things available, a `404` exception is thrown (see [Troubleshooting](#troubleshooting) for details on handling exceptions). ```Python things = client.list_things() @@ -108,7 +104,7 @@ If the package or a related package supports it, include tips for logging or ena [style-guide-msft]: https://docs.microsoft.com/style-guide/capitalization -[style-guide-cloud]: https://worldready.cloudapp.net/Styleguide/Read?id=2696&topicid=25357 ![Impressions](https://azure-sdk-impressions.azurewebsites.net/api/impressions/azure-sdk-for-java%2Fsdk%2Ftemplate%2Fazure-sdk-template%2FREADME.png) +https://github.com/Azure/azure-sdk-for-java/tree/azure-sdk-template_1.2.1-beta.3/sdk diff --git a/package.json b/package.json index 989f779f01c2c..fcf83298267e3 100644 --- a/package.json +++ b/package.json @@ -1114,6 +1114,14 @@ "excludePath": [], "packageArtifactId": "azure-data-tables", "packageVersion": "12.0.0-beta.1" + }, + { + "inputPath": [], + "packageDownloadUrl": "https://repo1.maven.org/maven2", + "excludePath": [], + "packageGroupId": "com.azure", + "packageArtifactId": "azure-sdk-template", + "packageVersion": "1.2.1-beta.3" } ] }