Skip to content

Commit

Permalink
Jan Release readme fix/ changes (#7395)
Browse files Browse the repository at this point in the history
* readme fix/ hanges

* more read me changes and adding metadata
  • Loading branch information
hemanttanwar authored Jan 13, 2020
1 parent 7a16996 commit 72f8152
Show file tree
Hide file tree
Showing 10 changed files with 91 additions and 65 deletions.
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ This repository is for active development of the Azure SDK for Java. For consume

### Important

The Azure SDK team is pleased to make available the January 2020 client library General Availability (GA) release. We strongly recommend using the GA libraries in all production environments as these libraries are well tested and officially supported by Microsoft. More details, including installation instructions can be found here [here](https://azure.github.io/azure-sdk/releases/2019-11/java.html).
The Azure SDK team is pleased to make available the January 2020 client library General Availability (GA) release. We strongly recommend using the GA libraries in all production environments as these libraries are well tested and officially supported by Microsoft. More details, including installation instructions can be found here [here](https://azure.github.io/azure-sdk/releases/2020-01/java.html).

## Getting started

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ languages:
- java
products:
- azure
- azure-data-appconfiguration
- azure-app-configuration
urlFragment: appconfiguration-samples
---

Expand All @@ -14,9 +14,6 @@ This document explains samples and how to use them.
## Key concepts
Key concepts are explained in detail [here][SDK_README_KEY_CONCEPTS].

# Samples Azure App Configuration APIs
This document describes how to use samples and what is done in each sample.

## Getting started
Getting started explained in detail [here][SDK_README_GETTING_STARTED].

Expand All @@ -34,9 +31,6 @@ Maven dependency for Azure app configuration Client library. Add it to your proj
```
[//]: # ({x-version-update-end})

## How to run
These sample can be run in your IDE with default JDK.

## Examples
The following sections provide several code snippets covering some of the most common configuration service tasks, including:

Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,14 @@
---
page_type: sample
languages:
- java
products:
- azure
- azure-key-vault
urlFragment: keyvault-certificates-samples
---

## Azure Key Vault Certificate Samples client library for Java
# Azure Key Vault Certificate Samples client library for Java
This document explains samples and how to use them.

## Key concepts
Expand All @@ -9,9 +18,6 @@ Key concepts are explained in detail [here][SDK_README_KEY_CONCEPTS].

Getting started explained in detail [here][SDK_README_GETTING_STARTED].

## How to run
These sample can be run in your IDE with default JDK.

## Examples
Following section document various examples.

Expand Down
18 changes: 10 additions & 8 deletions sdk/keyvault/azure-security-keyvault-keys/src/samples/README.md
Original file line number Diff line number Diff line change
@@ -1,19 +1,21 @@

## Azure Key Vault Keys Samples client library for Java
---
page_type: sample
languages:
- java
products:
- azure
- azure-key-vault
urlFragment: keyvault-keys-samples
---
# Azure Key Vault Keys Samples client library for Java
This document explains samples and how to use them.

## Key concepts
Key concepts are explained in detail [here][SDK_README_KEY_CONCEPTS].

# Samples Azure Key Vault Keys APIs
This document describes how to use samples and what is done in each sample.

## Getting started
Getting started explained in detail [here][SDK_README_GETTING_STARTED].

## How to run
These sample can be run in your IDE with default JDK.

## Examples
Following section document various examples.

Expand Down
17 changes: 10 additions & 7 deletions sdk/keyvault/azure-security-keyvault-secrets/src/samples/README.md
Original file line number Diff line number Diff line change
@@ -1,19 +1,22 @@
---
page_type: sample
languages:
- java
products:
- azure
- azure-key-vault
urlFragment: keyvault-secrets-samples
---

## Azure Key Vault Secret Samples client library for Java
# Azure Key Vault Secret Samples client library for Java
This document explains samples and how to use them.

## Key concepts
Key concepts are explained in detail [here][SDK_README_KEY_CONCEPTS].

# Samples Azure Key Vault secrets APIs
This document describes how to use samples and what is done in each sample.

## Getting started
Getting started explained in detail [here][SDK_README_GETTING_STARTED].

## How to run
These sample can be run in your IDE with default JDK.

## Examples
Following section document various examples.

Expand Down
23 changes: 13 additions & 10 deletions sdk/storage/azure-storage-blob-batch/src/samples/README.md
Original file line number Diff line number Diff line change
@@ -1,20 +1,24 @@

## Azure Azure Storage Blob Batch Samples client library for Java
---
page_type: sample
languages:
- java
products:
- azure
- azure-blob-storage
- azure-storage
urlFragment: storage-blob-samples
---

# Azure Storage Blob Batch Samples client library for Java
This document explains samples and how to use them.

## Key concepts

Key concepts are explained in detail [here][SDK_README_KEY_CONCEPTS].

# Samples Azure Storage Blob Batch APIs
This document describes how to use samples and what is done in each sample.

## Getting started
Getting started explained in detail [here][SDK_README_GETTING_STARTED].

## How to run
These sample can be run in your IDE with default JDK.

## Examples
Following section document various examples.

Expand All @@ -25,7 +29,6 @@ These sample can be run in your IDE with default JDK.
5. [Advanced Batching Setting Tier Examples][samples_basic]

## Troubleshooting
### General
When interacting with blobs using this Java client library, errors returned by the service correspond to the same HTTP
status codes returned for [REST API][error_codes] requests. For example, if you try to retrieve a container or blob that
doesn't exist in your Storage Account, a `404` error is returned, indicating `Not Found`
Expand All @@ -40,7 +43,7 @@ For more extensive documentation on Azure Storage blob, see the [API reference d
This project welcomes contributions and suggestions. Find [more contributing][SDK_README_CONTRIBUTING] details here.

<!-- LINKS -->
[SDK_README_GETTING_STARTDED]: ../../README.md#getting-started
[SDK_README_GETTING_STARTED]: ../../README.md#getting-started
[SDK_README_KEY_CONCEPTS]: ../../README.md#key-concepts
[BATCH_SDK_README]: ../../README.md
[SDK_README_CONTRIBUTING]: ../../README.md#contributing
Expand Down
18 changes: 12 additions & 6 deletions sdk/storage/azure-storage-blob/src/samples/README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,15 @@
---
page_type: sample
languages:
- java
products:
- azure
- azure-storage
- azure-blob-storage
urlFragment: storage-blob-samples
---

## Azure Azure Storage Blob Samples client library for Java
# Azure Storage Blob Samples client library for Java
This document explains samples and how to use them.

## Key concepts
Expand All @@ -13,9 +23,6 @@ Getting started explained in detail [here][SDK_README_GETTING_STARTED].

For details on including this dependency in other build tools (Gradle, SBT, etc), refer [here](https://search.maven.org/artifact/com.azure/azure-core).

## How to run
These sample can be run in your IDE with default JDK.

## Examples
Following section document various examples.

Expand All @@ -27,7 +34,6 @@ These sample can be run in your IDE with default JDK.
6. [Azure Identity Examples][samples_identity]: Use `DefaultAzureCredential` to do the authentication.

## Troubleshooting
### General
When interacting with blobs using this Java client library, errors returned by the service correspond to the same HTTP
status codes returned for [REST API][error_codes] requests. For example, if you try to retrieve a container or blob that
doesn't exist in your Storage Account, a `404` error is returned, indicating `Not Found`
Expand All @@ -44,7 +50,7 @@ This project welcomes contributions and suggestions. Find [more contributing][SD
<!-- LINKS -->
[BLOB_SDK_README]: ../../README.md
[SDK_README_CONTRIBUTING]:../../README.md#contributing
[SDK_README_GETTING_STARTDED]: ../../README.md#getting-started
[SDK_README_GETTING_STARTED]: ../../README.md#getting-started
[SDK_README_KEY_CONCEPTS]: ../../README.md#key-concepts
[samples_basic]: java/com/azure/storage/blob/BasicExample.java
[samples_file_transfer]: java/com/azure/storage/blob/FileTransferExample.java
Expand Down
20 changes: 12 additions & 8 deletions sdk/storage/azure-storage-file-share/src/samples/README.md
Original file line number Diff line number Diff line change
@@ -1,21 +1,25 @@

## Azure Azure Storage File Samples client library for Java
---
page_type: sample
languages:
- java
products:
- azure
- azure-file
- azure-storage
urlFragment: storage-file-share-samples
---

# Azure Storage File Samples client library for Java
This document explains samples and how to use them.

## Key concepts
More detail is defined at [file key concept][file_key_concept].

# Samples Azure Storage Blob Batch APIs
This document describes how to use samples and what is done in each sample.

## Getting started
Getting started explained in detail [here][SDK_README_GETTING_STARTED].

For details on including this dependency in other build tools (Gradle, SBT, etc), refer [here](https://search.maven.org/artifact/com.azure/azure-core).

## How to run
These sample can be run in your IDE with default JDK.

## Examples
Following are examples for some common use-cases.

Expand Down
23 changes: 13 additions & 10 deletions sdk/storage/azure-storage-queue/src/samples/README.md
Original file line number Diff line number Diff line change
@@ -1,21 +1,25 @@

## Azure Azure Storage Queue Samples client library for Java
---
page_type: sample
languages:
- java
products:
- azure
- azure-storage
- azure-queue-storage
urlFragment: storage-queue-samples
---

# Azure Storage Queue Samples client library for Java
This document explains samples and how to use them.

## Key concepts
More detail is defined at [queue key concept][queue_key_concept].

# Samples Azure Storage Blob Batch APIs
This document describes how to use samples and what is done in each sample.

## Getting started
Getting started explained in detail [here][SDK_README_GETTING_STARTED].

For details on including this dependency in other build tools (Gradle, SBT, etc), refer [here](https://search.maven.org/artifact/com.azure/azure-core).

## How to run
These sample can be run in your IDE with default JDK.

## Examples

Get started with our samples:
Expand All @@ -25,7 +29,6 @@ Get started with our samples:
- [AsyncSample][samples_async]: Create queue and enqueue message using async queue client call.

## Troubleshooting
### General
When interacting with blobs using this Java client library, errors returned by the service correspond to the same HTTP
status codes returned for [REST API][error_codes] requests. For example, if you try to retrieve a container or blob that
doesn't exist in your Storage Account, a `404` error is returned, indicating `Not Found`
Expand All @@ -41,7 +44,7 @@ This project welcomes contributions and suggestions. Find [more contributing][SD

<!-- LINKS -->
[SDK_README]: ../../README.md
[SDK_README_GETTING_STARTDED]: ../../README.md#getting-started
[SDK_README_GETTING_STARTED]: ../../README.md#getting-started
[SDK_README_CONTRIBUTING]: ../../README.md#contributing
[samples_queue_service]: java/com/azure/storage/queue/QueueServiceSamples.java
[samples_message]: java/com/azure/storage/queue/MessageSamples.java
Expand Down
13 changes: 9 additions & 4 deletions sdk/textanalytics/azure-ai-textanalytics/src/samples/README.md
Original file line number Diff line number Diff line change
@@ -1,15 +1,20 @@
---
topic: sample
languages:
- java
products:
- azure
- azure-cognitive-service
---

## Azure Text Analytics client library for Java Samples
# Azure Text Analytics client library for Java Samples

Azure Text Analytics samples are a set of self-contained Java programs that demonstrate interacting with Azure Text Analytics service
using the client library. Each sample focuses on a specific scenario and can be executed independently.

## Key concepts
Key concepts are explained in detail [here][SDK_README_KEY_CONCEPTS].

# Samples Azure Text Analytics APIs
This document describes how to use samples and what is done in each sample.

## Getting started
Getting started explained in detail [here][SDK_README_GETTING_STARTED].

Expand Down

0 comments on commit 72f8152

Please sign in to comment.