Skip to content

Commit 546d53d

Browse files
committed
Update docs metadata
1 parent 8361554 commit 546d53d

File tree

4 files changed

+14
-18
lines changed

4 files changed

+14
-18
lines changed

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

+6-8
Original file line numberDiff line numberDiff line change
@@ -5,12 +5,10 @@ author: hallipr
55
ms.author: pahallis
66
ms.date: 04/28/2022
77
ms.topic: reference
8-
ms.prod: azure
9-
ms.technology: azure
108
ms.devlang: java
119
ms.service: template
1210
---
13-
# Azure Template client library for Java - Version 1.2.1-beta.1535818
11+
# Azure Template client library for Java - Version 1.2.1-beta.1536237
1412

1513

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

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

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

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

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.
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.
5452

5553
> 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.
5654
@@ -160,8 +158,8 @@ This project has adopted the [Microsoft Open Source Code of Conduct][coc]. For m
160158
[Code of Conduct FAQ][coc_faq] or contact [[email protected]][coc_contact] with any additional questions or comments.
161159

162160
<!-- LINKS -->
163-
[style-guide-msft]: https://docs.microsoft.com/style-guide/capitalization
164-
[jdk]: https://docs.microsoft.com/java/azure/jdk/?view=azure-java-stable
161+
[style-guide-msft]: /style-guide/capitalization
162+
[jdk]: /java/azure/jdk/?view=azure-java-stable
165163
[logging]: https://github.com/Azure/azure-sdk-for-java/wiki/Logging-with-Azure-SDK
166164
[cla]: https://cla.microsoft.com
167165
[coc]: https://opensource.microsoft.com/codeofconduct/

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

+6-8
Original file line numberDiff line numberDiff line change
@@ -5,12 +5,10 @@ author: hallipr
55
ms.author: pahallis
66
ms.date: 04/28/2022
77
ms.topic: reference
8-
ms.prod: azure
9-
ms.technology: azure
108
ms.devlang: java
119
ms.service: template
1210
---
13-
# Azure Template Two client library for Java - Version 1.0.0-beta.1535818
11+
# Azure Template Two client library for Java - Version 1.0.0-beta.1536237
1412

1513

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

2220
* All headings, including the H1, should use **sentence-style capitalization**. Refer to the [Microsoft Style Guide][style-guide-msft].
23-
* Example: `# Azure Batch client library for Java - Version 1.0.0-beta.1535818
21+
* Example: `# Azure Batch client library for Java - Version 1.0.0-beta.1536237
2422
`
2523

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

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

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.
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.
5452

5553
> 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.
5654
@@ -160,8 +158,8 @@ This project has adopted the [Microsoft Open Source Code of Conduct][coc]. For m
160158
[Code of Conduct FAQ][coc_faq] or contact [[email protected]][coc_contact] with any additional questions or comments.
161159

162160
<!-- LINKS -->
163-
[style-guide-msft]: https://docs.microsoft.com/style-guide/capitalization
164-
[jdk]: https://docs.microsoft.com/java/azure/jdk/?view=azure-java-stable
161+
[style-guide-msft]: /style-guide/capitalization
162+
[jdk]: /java/azure/jdk/?view=azure-java-stable
165163
[logging]: https://github.com/Azure/azure-sdk-for-java/wiki/Logging-with-Azure-SDK
166164
[cla]: https://cla.microsoft.com
167165
[coc]: https://opensource.microsoft.com/codeofconduct/

metadata/preview/azure-sdk-template-two.json

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"Name": "azure-sdk-template-two",
3-
"Version": "1.0.0-beta.1535818",
3+
"Version": "1.0.0-beta.1536237",
44
"DevVersion": null,
55
"DirectoryPath": "sdk/template/azure-sdk-template-two",
66
"ServiceDirectory": "template",

metadata/preview/azure-sdk-template.json

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"Name": "azure-sdk-template",
3-
"Version": "1.2.1-beta.1535818",
3+
"Version": "1.2.1-beta.1536237",
44
"DevVersion": null,
55
"DirectoryPath": "sdk/template/azure-sdk-template",
66
"ServiceDirectory": "template",

0 commit comments

Comments
 (0)