You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs-ref-services/preview/sdk-template-readme.md
+6-8
Original file line number
Diff line number
Diff line change
@@ -5,12 +5,10 @@ author: hallipr
5
5
ms.author: pahallis
6
6
ms.date: 04/28/2022
7
7
ms.topic: reference
8
-
ms.prod: azure
9
-
ms.technology: azure
10
8
ms.devlang: java
11
9
ms.service: template
12
10
---
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
14
12
15
13
16
14
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
20
18
**Title**: The H1 of your README should be in the format: `# [Product Name] client library for [Language]`
21
19
22
20
* 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
24
22
`
25
23
26
24
**Introduction**: The introduction appears directly under the title (H1) of your README.
27
25
28
26
***DO NOT** use an "Introduction" or "Overview" heading (H2) for this section.
29
27
* 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/)).
31
29
* Next, add a **bulleted list** of the **most common tasks** supported by the package or library, prefaced with
32
30
"Use the client library for [Product Name] to:". Then, provide code snippets for these tasks in the [Examples](#examples)
33
31
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
50
48
a developer can [authenticate](#authenticate-the-client) and test all the snippets in the [Examples](#examples) section.
51
49
For example, for Cosmos DB:
52
50
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.
54
52
55
53
> 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.
56
54
@@ -160,8 +158,8 @@ This project has adopted the [Microsoft Open Source Code of Conduct][coc]. For m
160
158
[Code of Conduct FAQ][coc_faq] or contact [[email protected]][coc_contact] with any additional questions or comments.
Copy file name to clipboardExpand all lines: docs-ref-services/preview/sdk-template-two-readme.md
+6-8
Original file line number
Diff line number
Diff line change
@@ -5,12 +5,10 @@ author: hallipr
5
5
ms.author: pahallis
6
6
ms.date: 04/28/2022
7
7
ms.topic: reference
8
-
ms.prod: azure
9
-
ms.technology: azure
10
8
ms.devlang: java
11
9
ms.service: template
12
10
---
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
14
12
15
13
16
14
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
20
18
**Title**: The H1 of your README should be in the format: `# [Product Name] client library for [Language]`
21
19
22
20
* 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
24
22
`
25
23
26
24
**Introduction**: The introduction appears directly under the title (H1) of your README.
27
25
28
26
***DO NOT** use an "Introduction" or "Overview" heading (H2) for this section.
29
27
* 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/)).
31
29
* Next, add a **bulleted list** of the **most common tasks** supported by the package or library, prefaced with
32
30
"Use the client library for [Product Name] to:". Then, provide code snippets for these tasks in the [Examples](#examples)
33
31
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
50
48
a developer can [authenticate](#authenticate-the-client) and test all the snippets in the [Examples](#examples) section.
51
49
For example, for Cosmos DB:
52
50
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.
54
52
55
53
> 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.
56
54
@@ -160,8 +158,8 @@ This project has adopted the [Microsoft Open Source Code of Conduct][coc]. For m
160
158
[Code of Conduct FAQ][coc_faq] or contact [[email protected]][coc_contact] with any additional questions or comments.
0 commit comments