Skip to content

Commit 6a6e8c0

Browse files
committed
Update docs metadata
1 parent 6df7de4 commit 6a6e8c0

File tree

2 files changed

+11
-9
lines changed

2 files changed

+11
-9
lines changed

docs-ref-services/preview/sdk-template-readme.md

Lines changed: 9 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -3,12 +3,14 @@ title: Azure Template client library for Java
33
keywords: Azure, java, SDK, API, azure-sdk-template, template
44
author: hallipr
55
ms.author: pahallis
6-
ms.date: 04/27/2022
6+
ms.date: 04/28/2022
77
ms.topic: reference
8+
ms.prod: azure
9+
ms.technology: azure
810
ms.devlang: java
911
ms.service: template
1012
---
11-
# Azure Template client library for Java - Version 1.2.1-beta.1533463
13+
# Azure Template client library for Java - Version 1.2.1-beta.1535818
1214

1315

1416
Use the guidelines in each section of this template to ensure consistency and readability of your README.
@@ -18,14 +20,14 @@ It's also used as the package distribution page (NuGet, PyPi, npm, etc.) and as
1820
**Title**: The H1 of your README should be in the format: `# [Product Name] client library for [Language]`
1921

2022
* All headings, including the H1, should use **sentence-style capitalization**. Refer to the [Microsoft Style Guide][style-guide-msft].
21-
* Example: `# Azure Batch client library for Java - Version 1.2.1-beta.1533463
23+
* Example: `# Azure Batch client library for Java - Version 1.2.1-beta.1535818
2224
`
2325

2426
**Introduction**: The introduction appears directly under the title (H1) of your README.
2527

2628
* **DO NOT** use an "Introduction" or "Overview" heading (H2) for this section.
2729
* First sentence: **Describe the service** briefly. You can usually use the first line of the service's docs landing page
28-
for this (Example: [Cosmos DB docs landing page](/azure/cosmos-db/)).
30+
for this (Example: [Cosmos DB docs landing page](https://docs.microsoft.com/azure/cosmos-db/)).
2931
* Next, add a **bulleted list** of the **most common tasks** supported by the package or library, prefaced with
3032
"Use the client library for [Product Name] to:". Then, provide code snippets for these tasks in the [Examples](#examples)
3133
section later in the document. Keep the task list short but include those tasks most developers need to perform with your package.
@@ -48,7 +50,7 @@ Include a **Prerequisites** line after the install command that details any requ
4850
a developer can [authenticate](#authenticate-the-client) and test all the snippets in the [Examples](#examples) section.
4951
For example, for Cosmos DB:
5052

51-
**Prerequisites**: You must have an [Azure subscription](https://azure.microsoft.com/free/), [Cosmos DB account](/azure/cosmos-db/account-overview) (SQL API), and [Java Development Kit (JDK) with version 8 or above][jdk] to use this package.
53+
**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 [Java Development Kit (JDK) with version 8 or above][jdk] to use this package.
5254

5355
> TODO: Once the library has GA'ed include the instructions on how to include the BOM file directly. And the benefit of using the BOM file over adding a direct dependency to the project.
5456
@@ -158,8 +160,8 @@ This project has adopted the [Microsoft Open Source Code of Conduct][coc]. For m
158160
[Code of Conduct FAQ][coc_faq] or contact [[email protected]][coc_contact] with any additional questions or comments.
159161

160162
<!-- LINKS -->
161-
[style-guide-msft]: /style-guide/capitalization
162-
[jdk]: /java/azure/jdk/?view=azure-java-stable
163+
[style-guide-msft]: https://docs.microsoft.com/style-guide/capitalization
164+
[jdk]: https://docs.microsoft.com/java/azure/jdk/?view=azure-java-stable
163165
[logging]: https://github.com/Azure/azure-sdk-for-java/wiki/Logging-with-Azure-SDK
164166
[cla]: https://cla.microsoft.com
165167
[coc]: https://opensource.microsoft.com/codeofconduct/
Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"Name": "azure-sdk-template",
3-
"Version": "1.2.1-beta.1533463",
3+
"Version": "1.2.1-beta.1535818",
44
"DevVersion": null,
55
"DirectoryPath": "sdk/template/azure-sdk-template",
66
"ServiceDirectory": "template",
@@ -10,5 +10,5 @@
1010
"SdkType": "client",
1111
"IsNewSdk": true,
1212
"ArtifactName": "azure-sdk-template",
13-
"ReleaseStatus": "2022-04-27"
13+
"ReleaseStatus": "2022-04-28"
1414
}

0 commit comments

Comments
 (0)