-
Notifications
You must be signed in to change notification settings - Fork 2k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Updating root readme to simplify messaging (#28157)
* Updating readme to simplify messaging
- Loading branch information
1 parent
7a80460
commit 1fb1676
Showing
1 changed file
with
16 additions
and
29 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,9 +1,9 @@ | ||
|
|
||
| # Azure SDK for Java | ||
|
|
||
| [](https://azure.github.io/azure-sdk/releases/latest/java.html) [](https://azuresdkartifacts.blob.core.windows.net/azure-sdk-for-java/staging/dependencies.html) [](https://azuresdkartifacts.blob.core.windows.net/azure-sdk-for-java/staging/InterdependencyGraph.html) [](https://azuresdkartifacts.blob.core.windows.net/azure-sdk-for-java/index.html) [](https://azuresdkartifacts.blob.core.windows.net/azure-sdk-for-java/staging/spotbugsXml.html) [](https://azuresdkartifacts.blob.core.windows.net/azure-sdk-for-java/staging/checkstyle-aggregate.html) | ||
| [](https://azure.github.io/azure-sdk/releases/latest/java.html) [](https://azure.github.io/azure-sdk-for-java) | ||
|
|
||
| This repository is for active development of the Azure SDK for Java. For consumers of the SDK we recommend visiting our [public developer docs](https://docs.microsoft.com/java/azure/) or our versioned [developer docs](https://azure.github.io/azure-sdk-for-java). | ||
| This repository is for active development of the Azure SDK for Java. For consumers of the SDK we recommend visiting our [public developer docs](https://docs.microsoft.com/azure/developer/java/sdk/) or our versioned [developer docs](https://azure.github.io/azure-sdk-for-java). | ||
|
|
||
| ## Getting started | ||
|
|
||
|
|
@@ -13,41 +13,32 @@ For tutorials, samples, quick starts and other documentation, visit [Azure for J | |
|
|
||
| ### Prerequisites | ||
|
|
||
| Java 8 or later is required to use libraries under the `com.azure` package, for libraries under the `com.microsoft.azure` package Java 7 or later is required. | ||
| All libraries are baselined on Java 8, with testing and forward support up until the latest Java long-term support release (currently Java 17). | ||
|
|
||
| ## Available packages | ||
|
|
||
| Each service might have a number of libraries available from each of the following categories: | ||
| Each service can have both 'client' and 'management' libraries. 'Client' libraries are used to consume the service, whereas 'management' libraries are used to configure and manage the service. | ||
|
|
||
| - [Client: New Releases](#client-new-releases) | ||
| - [Client: Previous Versions](#client-previous-versions) | ||
| - [Management: New Releases](#management-new-releases) | ||
| - [Management: Previous Versions](#management-previous-versions) | ||
| ### Client Libraries | ||
|
|
||
| ### Client: New Releases | ||
|
|
||
| New wave of packages that follow the [Azure SDK Design Guidelines for Java](https://azure.github.io/azure-sdk/java/guidelines/) and share a number of core features such as HTTP retries, logging, transport protocols, authentication protocols, etc., so that once you learn how to use these features in one client library, you will know how to use them in other client libraries. You can learn about these shared features [here](https://github.com/Azure/azure-sdk-for-java/blob/main/sdk/core/azure-core/README.md). | ||
| Our client libraries follow the [Azure SDK Design Guidelines for Java](https://azure.github.io/azure-sdk/java/guidelines/), and share a number of core features such as HTTP retries, logging, transport protocols, authentication protocols, etc., so that once you learn how to use these features in one client library, you will know how to use them in other client libraries. You can learn about these shared features [here](https://docs.microsoft.com/azure/developer/java/sdk/overview). | ||
| These libraries can be easily identified by folder, package, and namespaces names starting with `azure-`, e.g. `azure-keyvault`. | ||
|
|
||
| You can find the **[most up to date list of all of the new packages on our page](https://azure.github.io/azure-sdk/releases/latest/index.html#java)**. This list includes the most recent releases: both GA and preview. | ||
|
|
||
| > NOTE: If you need to ensure your code is ready for production use one of the stable, non-preview libraries. | ||
| You can find the **[most up to date list of all of the new packages on our page](https://azure.github.io/azure-sdk/releases/latest/index.html#java)**. This list includes the most recent releases: both stable and beta. | ||
|
|
||
| ### Client: Previous Versions | ||
| > NOTE: If you need to ensure your code is ready for production use one of the stable, non-beta libraries. | ||
| Last stable versions of packages that have been provided for usage with Azure and are production-ready. These libraries provide similar functionalities to the new libraries, as they allow you to use and consume existing resources and interact with them, for example: upload a blob. Previous library directories start with `microsoft-azure-`, e.g. `microsoft-azure-keyvault`. They might not implement the [guidelines](https://azure.github.io/azure-sdk/java_introduction.html) or have the same feature set as the new releases. They do however offer wider coverage of services. | ||
| ### Management Libraries | ||
|
|
||
| ### Management: New Releases | ||
| A new set of management libraries that follow the [Azure SDK Design Guidelines for Java](https://azure.github.io/azure-sdk/java/guidelines/) are now Generally Available (GA) and ready for production uses. These new libraries provide a higher-level, object-oriented API for _managing_ Azure resources, that is optimized for ease of use, succinctness and consistency. You can find the list of new packages **[on this page](https://azure.github.io/azure-sdk/releases/latest/mgmt/java.html)**. | ||
| Similar to our client libraries, the management libraries follow the [Azure SDK Design Guidelines for Java](https://azure.github.io/azure-sdk/java/guidelines/). These libraries provide a high-level, object-oriented API for _managing_ Azure resources, that are optimized for ease of use, succinctness, and consistency. You can find the list of management libraries **[on this page](https://azure.github.io/azure-sdk/releases/latest/mgmt/java.html)**. | ||
|
|
||
| **For general documentation on how to use the new libraries for Azure Resource Management, please [visit here](https://aka.ms/azsdk/java/mgmt)**. We have also prepared **[plenty of code samples](https://github.com/Azure/azure-sdk-for-java/blob/main/sdk/resourcemanager/docs/SAMPLE.md)** as well as **[migration guide](https://github.com/Azure/azure-sdk-for-java/blob/main/sdk/resourcemanager/docs/MIGRATION_GUIDE.md)** in case you are upgrading from previous versions. | ||
|
|
||
| New Management libraries can be identified by namespaces that start with `azure-resourcemanager`, e.g. `azure-resourcemanager-compute` | ||
| The management libraries can be identified by namespaces that start with `azure-resourcemanager`, e.g. `azure-resourcemanager-compute`. | ||
|
|
||
| ### Management: Previous Versions | ||
| For a complete list of management libraries which enable you to provision and manage Azure resources, please check [here](https://azure.github.io/azure-sdk/releases/latest/all/java.html). They might not have the same feature set as the new releases but they do offer wider coverage of services. | ||
| Previous versions of management libraries can be identified by namespaces that start with `azure-mgmt-`, e.g. `azure-mgmt-compute` | ||
| ### Historical Releases | ||
|
|
||
| Note that the latest libraries from Microsoft are in the `com.azure` Maven group ID, and have the package naming pattern of beginning with `com.azure`. If you're using libraries that are in `com.microsoft.azure` Maven group ID, or have this as the package structure, please consider migrating to the latest libraries. You can find a mapping table from these historical releases to their equivalent [here](https://azure.github.io/azure-sdk/releases/deprecated/index.html#java). | ||
|
|
||
| ## Need help? | ||
|
|
||
|
|
@@ -59,13 +50,13 @@ Previous versions of management libraries can be identified by namespaces that s | |
|
|
||
| ## Navigating the repository | ||
|
|
||
| ### Master branch | ||
| ### Main branch | ||
|
|
||
| The master branch has the most recent code with new features and bug fixes. It does **not** represent latest released **GA** SDK. See [above](#client-new-releases) for latest **GA** release.<br/> | ||
| The main branch has the most recent code with new features and bug fixes. It does **not** represent latest released **stable** SDK. | ||
|
|
||
| ### Release branches (Release tagging) | ||
|
|
||
| For each package we release there will be a unique git tag created that contains the name and the version of the package to mark the commit of the code that produced the package. This tag will be used for servicing via hotfix branches as well as debugging the code for a particular preview or stable release version. | ||
| For each package we release there will be a unique git tag created that contains the name and the version of the package to mark the commit of the code that produced the package. This tag will be used for servicing via hotfix branches as well as debugging the code for a particular beta or stable release version. | ||
| Format of the release tags are `<package-name>_<package-version>`. For more information please see [our branching strategy](https://github.com/Azure/azure-sdk/blob/main/docs/policies/repobranching.md#release-tagging). | ||
|
|
||
| ## Contributing | ||
|
|
@@ -87,10 +78,6 @@ Many people all over the world have helped make this project better. You'll wan | |
| - [How you can make a change happen!](https://github.com/Azure/azure-sdk-for-java/blob/main/CONTRIBUTING.md#pull-requests) | ||
| - Frequently Asked Questions (FAQ) and Conceptual Topics in the detailed [Azure SDK for Java wiki](https://github.com/azure/azure-sdk-for-java/wiki). | ||
|
|
||
| ### Community | ||
|
|
||
| Chat with other community members [](https://gitter.im/azure/azure-sdk-for-java?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge) | ||
|
|
||
| ### Reporting security issues and security bugs | ||
|
|
||
| Security issues and bugs should be reported privately, via email, to the Microsoft Security Response Center (MSRC) <[email protected]>. You should receive a response within 24 hours. If for some reason you do not, please follow up via email to ensure we received your original message. Further information, including the MSRC PGP key, can be found in the [Security TechCenter](https://www.microsoft.com/msrc/faqs-report-an-issue). | ||
|
|
||