forked from Azure/azure-sdk-for-java
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Updated README for azure-spring-data-cosmos-core and other cosmos spr…
…ing modules (Azure#13985) * Updated indexing policy tests based on V4 SDK mode * Updated readme files for azure-spring-data-cosmos-core, azure-spring-data-2-2-cosmos and azure-spring-data-2-3-cosmos * Fixed broken links * Fixed readme links * Fixed some links and code review comments
- Loading branch information
1 parent
b099d02
commit f0a55ae
Showing
11 changed files
with
401 additions
and
254 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,73 @@ | ||
| # Azure Spring Data 2.2 Cosmos client library for Java | ||
|
|
||
| ## Key concepts | ||
| **Azure Spring Data Cosmos** provides Spring Data 2.2.x support for Azure Cosmos DB using the [SQL API][sql_api_query], based on Spring Data framework. | ||
| [Azure Cosmos DB][cosmos_introduction] is a globally-distributed database service which allows developers to work with data using a variety of standard APIs, such as SQL, MongoDB, Cassandra, Graph, and Table. | ||
|
|
||
| [Source code][source_code] | [Package (Maven)][azure_spring_data_2_2_cosmos_maven] | [API reference documentation][api_documentation] | [Product documentation][azure_spring_data_cosmos_docs] | | ||
| [Samples][samples] | ||
|
|
||
| ## Spring data version support | ||
| This project supports [spring-data-commons 2.2.x][spring_data_2_2_commons] version. | ||
|
|
||
| ## Getting started | ||
| ### Include the package | ||
| If you are using Maven, add the following dependency. | ||
|
|
||
| [//]: # ({x-version-update-start;com.azure:azure-spring-data-2-2-cosmos;current}) | ||
| ```xml | ||
| <dependency> | ||
| <groupId>com.azure</groupId> | ||
| <artifactId>azure-spring-data-2-2-cosmos</artifactId> | ||
| <version>3.0.0-beta.1</version> | ||
| </dependency> | ||
| ``` | ||
| [//]: # ({x-version-update-end}) | ||
|
|
||
| ## Key concepts | ||
| ## Examples | ||
| Please refer to [Azure Spring Data Cosmos Core module][azure_spring_data_cosmos_core_readme_key_concepts] for key concepts. | ||
|
|
||
| ## Troubleshooting | ||
| Please refer to [Azure Spring Data Cosmos Core module][azure_spring_data_cosmos_core_readme_troubleshooting] for troubleshooting guide. | ||
|
|
||
| ## Examples | ||
| - Please refer to [sample project here][samples]. | ||
|
|
||
| ## Next steps | ||
| - Read more about [azure spring data cosmos][azure_spring_data_cosmos_docs]. | ||
| - Read more about [azure cosmosdb service][cosmos_docs]. | ||
|
|
||
| ## Contributing | ||
|
|
||
| This project welcomes contributions and suggestions. Most contributions require you to agree to a | ||
| [Contributor License Agreement (CLA)][cla] declaring that you have the right to, and actually do, grant us the rights | ||
| to use your contribution. | ||
|
|
||
| When you submit a pull request, a CLA-bot will automatically determine whether you need to provide a CLA and decorate | ||
| the PR appropriately (e.g., label, comment). Simply follow the instructions provided by the bot. You will only need to | ||
| do this once across all repos using our CLA. | ||
|
|
||
| This project has adopted the [Microsoft Open Source Code of Conduct][coc]. For more information see the [Code of Conduct FAQ][coc_faq] | ||
| or contact [[email protected]][coc_contact] with any additional questions or comments. | ||
|
|
||
| <!-- LINKS --> | ||
| [source_code]: https://github.com/Azure/azure-sdk-for-java/tree/master/sdk/cosmos/azure-spring-data-cosmos-core | ||
| [cosmos_introduction]: https://docs.microsoft.com/en-us/azure/cosmos-db/ | ||
| [cosmos_docs]: https://docs.microsoft.com/en-us/azure/cosmos-db/introduction | ||
| [jdk]: https://docs.microsoft.com/java/azure/java-supported-jdk-runtime?view=azure-java-stable | ||
| [maven]: https://maven.apache.org/ | ||
| [cla]: https://cla.microsoft.com | ||
| [coc]: https://opensource.microsoft.com/codeofconduct/ | ||
| [coc_faq]: https://opensource.microsoft.com/codeofconduct/faq/ | ||
| [coc_contact]: mailto:[email protected] | ||
| [samples]: https://github.com/Azure/azure-sdk-for-java/tree/master/sdk/cosmos/azure-spring-data-cosmos-core/src/samples/java/com/azure/cosmos | ||
| [sql_api_query]: https://docs.microsoft.com/en-us/azure/cosmos-db/sql-api-sql-query | ||
| [spring_data_2_2_commons]: https://mvnrepository.com/artifact/org.springframework.data/spring-data-commons/2.2.0.RELEASE | ||
| [api_documentation]: https://azure.github.io/azure-sdk-for-java/cosmos.html#azure-spring-data-2-2-cosmos | ||
| [maven]: https://maven.apache.org/ | ||
| [azure_spring_data_cosmos_core_readme_key_concepts]: https://github.com/Azure/azure-sdk-for-java/blob/master/sdk/cosmos/azure-spring-data-cosmos-core/README.md#key-concepts | ||
| [azure_spring_data_cosmos_core_readme_troubleshooting]: https://github.com/Azure/azure-sdk-for-java/blob/master/sdk/cosmos/azure-spring-data-cosmos-core/README.md#troubleshooting | ||
| [azure_spring_data_cosmos_docs]: https://docs.microsoft.com/en-us/azure/cosmos-db/sql-api-sdk-java-spring | ||
| [azure_spring_data_2_2_cosmos_maven]: https://search.maven.org/artifact/com.azure/azure-spring-data-2-2-cosmos | ||
| [azure_spring_data_2_2_cosmos_maven_svg]: https://img.shields.io/maven-central/v/com.azure/azure-spring-data-2-2-cosmos.svg | ||
|
|
||
|  |
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,73 @@ | ||
| # Azure Spring Data 2.3 Cosmos client library for Java | ||
|
|
||
| ## Key concepts | ||
| **Azure Spring Data Cosmos** provides Spring Data 2.3.x support for Azure Cosmos DB using the [SQL API][sql_api_query], based on Spring Data framework. | ||
| [Azure Cosmos DB][cosmos_introduction] is a globally-distributed database service which allows developers to work with data using a variety of standard APIs, such as SQL, MongoDB, Cassandra, Graph, and Table. | ||
|
|
||
| [Source code][source_code] | [Package (Maven)][azure_spring_data_2_3_cosmos_maven] | [API reference documentation][api_documentation] | [Product documentation][azure_spring_data_cosmos_docs] | | ||
| [Samples][samples] | ||
|
|
||
| ## Spring data version support | ||
| This project supports [spring-data-commons 2.3.x][spring_data_2_3_commons] version. | ||
|
|
||
| ## Getting started | ||
| ### Include the package | ||
| If you are using Maven, add the following dependency. | ||
|
|
||
| [//]: # ({x-version-update-start;com.azure:azure-spring-data-2-3-cosmos;current}) | ||
| ```xml | ||
| <dependency> | ||
| <groupId>com.azure</groupId> | ||
| <artifactId>azure-spring-data-2-3-cosmos</artifactId> | ||
| <version>3.0.0-beta.1</version> | ||
| </dependency> | ||
| ``` | ||
| [//]: # ({x-version-update-end}) | ||
|
|
||
| ## Key concepts | ||
| ## Examples | ||
| Please refer to [Azure Spring Data Cosmos Core module][azure_spring_data_cosmos_core_readme_key_concepts] for key concepts. | ||
|
|
||
| ## Troubleshooting | ||
| Please refer to [Azure Spring Data Cosmos Core module][azure_spring_data_cosmos_core_readme_troubleshooting] for troubleshooting guide. | ||
|
|
||
| ## Examples | ||
| - Please refer to [sample project here][samples]. | ||
|
|
||
| ## Next steps | ||
| - Read more about [azure spring data cosmos][azure_spring_data_cosmos_docs]. | ||
| - Read more about [azure cosmosdb service][cosmos_docs]. | ||
|
|
||
| ## Contributing | ||
|
|
||
| This project welcomes contributions and suggestions. Most contributions require you to agree to a | ||
| [Contributor License Agreement (CLA)][cla] declaring that you have the right to, and actually do, grant us the rights | ||
| to use your contribution. | ||
|
|
||
| When you submit a pull request, a CLA-bot will automatically determine whether you need to provide a CLA and decorate | ||
| the PR appropriately (e.g., label, comment). Simply follow the instructions provided by the bot. You will only need to | ||
| do this once across all repos using our CLA. | ||
|
|
||
| This project has adopted the [Microsoft Open Source Code of Conduct][coc]. For more information see the [Code of Conduct FAQ][coc_faq] | ||
| or contact [[email protected]][coc_contact] with any additional questions or comments. | ||
|
|
||
| <!-- LINKS --> | ||
| [source_code]: https://github.com/Azure/azure-sdk-for-java/tree/master/sdk/cosmos/azure-spring-data-cosmos-core | ||
| [cosmos_introduction]: https://docs.microsoft.com/en-us/azure/cosmos-db/ | ||
| [cosmos_docs]: https://docs.microsoft.com/en-us/azure/cosmos-db/introduction | ||
| [jdk]: https://docs.microsoft.com/java/azure/java-supported-jdk-runtime?view=azure-java-stable | ||
| [maven]: https://maven.apache.org/ | ||
| [cla]: https://cla.microsoft.com | ||
| [coc]: https://opensource.microsoft.com/codeofconduct/ | ||
| [coc_faq]: https://opensource.microsoft.com/codeofconduct/faq/ | ||
| [coc_contact]: mailto:[email protected] | ||
| [samples]: https://github.com/Azure/azure-sdk-for-java/tree/master/sdk/cosmos/azure-spring-data-cosmos-core/src/samples/java/com/azure/cosmos | ||
| [sql_api_query]: https://docs.microsoft.com/en-us/azure/cosmos-db/sql-api-sql-query | ||
| [spring_data_2_3_commons]: https://mvnrepository.com/artifact/org.springframework.data/spring-data-commons/2.3.0.RELEASE | ||
| [api_documentation]: https://azure.github.io/azure-sdk-for-java/cosmos.html#azure-spring-data-2-3-cosmos | ||
| [maven]: https://maven.apache.org/ | ||
| [azure_spring_data_cosmos_core_readme_key_concepts]: https://github.com/Azure/azure-sdk-for-java/blob/master/sdk/cosmos/azure-spring-data-cosmos-core/README.md#key-concepts | ||
| [azure_spring_data_cosmos_core_readme_troubleshooting]: https://github.com/Azure/azure-sdk-for-java/blob/master/sdk/cosmos/azure-spring-data-cosmos-core/README.md#troubleshooting | ||
| [azure_spring_data_cosmos_docs]: https://docs.microsoft.com/en-us/azure/cosmos-db/sql-api-sdk-java-spring | ||
| [azure_spring_data_2_3_cosmos_maven]: https://search.maven.org/artifact/com.azure/azure-spring-data-2-3-cosmos | ||
| [azure_spring_data_2_3_cosmos_maven_svg]: https://img.shields.io/maven-central/v/com.azure/azure-spring-data-2-3-cosmos.svg | ||
|
|
||
|  |
Oops, something went wrong.