Skip to content

Commit 645bca4

Browse files
authored
Typo fix in the docs (Azure#35210)
1 parent 1dca646 commit 645bca4

File tree

8 files changed

+20
-20
lines changed

8 files changed

+20
-20
lines changed

sdk/cosmos/README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# Azure CosmosDB Client library for Java
1+
# Azure Cosmos DB Client library for Java
22

33
[![Build Status](https://dev.azure.com/azure-sdk/public/_apis/build/status/17?branchName=master)](https://dev.azure.com/azure-sdk/public/_build/latest?definitionId=17) [![Build Documentation](https://img.shields.io/badge/documentation-published-blue.svg)](https://azuresdkartifacts.blob.core.windows.net/azure-sdk-for-java/index.html) [![Dependencies](https://img.shields.io/badge/dependencies-analyzed-blue.svg)](https://azuresdkartifacts.blob.core.windows.net/azure-sdk-for-java/staging/dependencies.html) [![SpotBugs](https://img.shields.io/badge/SpotBugs-Clean-success.svg)](https://azuresdkartifacts.blob.core.windows.net/azure-sdk-for-java/staging/spotbugsXml.html) [![CheckStyle](https://img.shields.io/badge/CheckStyle-Clean-success.svg)](https://azuresdkartifacts.blob.core.windows.net/azure-sdk-for-java/staging/checkstyle-aggregate.html)
44

@@ -12,7 +12,7 @@ To get started with a specific library, see the **README.md** file located in th
1212
- [Azure Spring Data Cosmos](https://github.com/Azure/azure-sdk-for-java/blob/main/sdk/spring/azure-spring-data-cosmos/README.md) provides Spring Data support for Azure Cosmos DB using the SQL API, based on Spring Data framework.
1313
- [Azure Cosmos Encryption](https://github.com/Azure/azure-sdk-for-java/blob/main/sdk/cosmos/azure-cosmos-encryption/README.md) supports encryption for Azure Cosmos DB using SQL API. This plugin library is still under development and not is not ready to be consumed yet.
1414
- [Azure Cosmos Benchmark](https://github.com/Azure/azure-sdk-for-java/blob/main/sdk/cosmos/azure-cosmos-benchmark/README.md) is the benchmarking tool which provides different kinds of benchmarking workloads including but not limited to `readLatency`, `readThroughput`, `writeThroughput`, `readMyWrites`, etc.
15-
- [Azure Cosmos DotNet Benchmark](https://github.com/Azure/azure-sdk-for-java/blob/main/sdk/cosmos/azure-cosmos-dotnet-benchmark/README.md) is the port of CosmosDB .NET benchmarking tool.
15+
- [Azure Cosmos DotNet Benchmark](https://github.com/Azure/azure-sdk-for-java/blob/main/sdk/cosmos/azure-cosmos-dotnet-benchmark/README.md) is the port of Cosmos DB .NET benchmarking tool.
1616
- [Azure Cosmos Examples](https://github.com/Azure/azure-sdk-for-java/blob/main/sdk/cosmos/azure-cosmos-examples/README.md) provides various examples / samples on how to use Azure Cosmos DB SDK for SQL API.
1717

1818
<!-- LINKS -->

sdk/cosmos/azure-cosmos-benchmark/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# Azure CosmosDB Client Library for Java
1+
# Azure Cosmos DB Client Library for Java
22

33
# Benchmarking Tool
44

sdk/cosmos/azure-cosmos-dotnet-benchmark/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# Azure CosmosDB client library for Java
1+
# Azure Cosmos DB client library for Java
22

33
# Port of the Microsoft Azure Cosmos DB .NET Benchmark tool for Java
44

sdk/cosmos/azure-cosmos-encryption/CHANGELOG.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -158,5 +158,5 @@
158158

159159
### 1.0.0-beta.1 (2021-04-06)
160160
#### New Features
161-
* Added Azure Cosmos encryption used for encrypting data with user provided key before saving into CosmosDB and decrypting it when reading back from the database.
161+
* Added Azure Cosmos encryption used for encrypting data with user provided key before saving into Cosmos DB and decrypting it when reading back from the database.
162162

sdk/cosmos/azure-cosmos-encryption/README.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
# Encryption plugin library for Azure Cosmos DB Java SDK for Java
2-
The Azure Cosmos Encryption Plugin is used for encrypting data with a user-provided key before saving into CosmosDB and decrypting it when reading back from the database.
2+
The Azure Cosmos Encryption Plugin is used for encrypting data with a user-provided key before saving into Cosmos DB and decrypting it when reading back from the database.
33

44
[Source code][encryption_source_code] | [Package (Maven)][cosmos_encryption_maven] | [API reference documentation][encryption_api_documentation] | [Product documentation][cosmos_docs] |
55
[Samples][getting_started_encryption]
@@ -36,7 +36,7 @@ The SDK provides Reactor Core-based async APIs. You can read more about Reactor
3636

3737
## Key concepts
3838

39-
The Azure Cosmos Encryption Plugin is used for encrypting data with a user-provided key before saving into CosmosDB and decrypting it when reading back from the database. Underneath it uses Azure Cosmos DB Java SDK which provides client-side logical representation to access the Azure Cosmos DB SQL API.
39+
The Azure Cosmos Encryption Plugin is used for encrypting data with a user-provided key before saving into Cosmos DB and decrypting it when reading back from the database. Underneath it uses Azure Cosmos DB Java SDK which provides client-side logical representation to access the Azure Cosmos DB SQL API.
4040
A Cosmos DB account contains zero or more databases, a database (DB) contains zero or more containers, and a container contains zero or more items.
4141
You may read more about databases, containers, and items [here](https://docs.microsoft.com/azure/cosmos-db/databases-containers-items).
4242
A few important properties are defined at the level of the container, among them are provisioned throughput and partition key.
@@ -190,8 +190,8 @@ log4j.appender.A1.layout.ConversionPattern=%d %5X{pid} [%t] %-5p %c - %m%n
190190
## Next steps
191191

192192
- Cosmos encryption sample program is [here][getting_started_encryption]
193-
- Quick start of CosmosDB core java sdk [quickstart][quickstart] - Building a java app to manage CosmosDB SQL API data
194-
- [Read more about Azure CosmosDB Service][cosmos_docs]
193+
- Quick start of Cosmos DB core java sdk [quickstart][quickstart] - Building a java app to manage Cosmos DB SQL API data
194+
- [Read more about Azure Cosmos DB Service][cosmos_docs]
195195

196196
## Contributing
197197

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
1-
# Azure CosmosDB Client Library for Java
1+
# Azure Cosmos DB Client Library for Java
22

33
## Example README
44

5-
Examples for Azure CosmosDB Java SDK for SQL API have been moved to a separate [github repository](https://github.com/Azure-Samples/azure-cosmos-java-sql-api-samples)
5+
Examples for Azure Cosmos DB Java SDK for SQL API have been moved to a separate [github repository](https://github.com/Azure-Samples/azure-cosmos-java-sql-api-samples)
66

77
![Impressions](https://azure-sdk-impressions.azurewebsites.net/api/impressions/azure-sdk-for-java%2Fsdk%2Fcosmos%2Fazure-cosmos-examples%2FREADME.png)

sdk/cosmos/azure-cosmos-spark_3_2-12/docs/configuration-reference.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -8,10 +8,10 @@
88
| `spark.cosmos.accountKey` | None | Cosmos DB Account Key |
99
| `spark.cosmos.database` | None | Cosmos DB database name |
1010
| `spark.cosmos.container` | None | Cosmos DB container name |
11-
| `spark.cosmos.account.subscriptionId` | None | The subscriptionId of the CosmosDB account. Required for `ServicePrinciple` authentication. |
12-
| `spark.cosmos.account.tenantId` | None | The tenantId of the CosmosDB account. Required for `ServicePrinciple` authentication. |
13-
| `spark.cosmos.account.resourceGroupName` | None | The resource group of the CosmosDB account. Required for `ServicePrinciple` authentication. |
14-
| `spark.cosmos.account.azureEnvironment` | `Azure` | The azure environment of the CosmosDB account: `Azure`, `AzureChina`, `AzureUsGovernment`, `AzureGermany`. |
11+
| `spark.cosmos.account.subscriptionId` | None | The subscriptionId of the Cosmos DB account. Required for `ServicePrinciple` authentication. |
12+
| `spark.cosmos.account.tenantId` | None | The tenantId of the Cosmos DB account. Required for `ServicePrinciple` authentication. |
13+
| `spark.cosmos.account.resourceGroupName` | None | The resource group of the Cosmos DB account. Required for `ServicePrinciple` authentication. |
14+
| `spark.cosmos.account.azureEnvironment` | `Azure` | The azure environment of the Cosmos DB account: `Azure`, `AzureChina`, `AzureUsGovernment`, `AzureGermany`. |
1515

1616
### AAD Auth Config
1717
| Config Property Name | Default | Description |

sdk/cosmos/azure-cosmos/README.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# Azure CosmosDB Client Library for Java
1+
# Azure Cosmos DB Client Library for Java
22

33
Azure Cosmos DB is Microsoft’s globally distributed, multi-model database service for operational and analytics workloads. It offers multi-mastering feature by automatically scaling throughput, compute, and storage.
44
This project provides SDK library in Java for interacting with [SQL API][sql_api_query] of [Azure Cosmos DB Database Service][cosmos_introduction].
@@ -68,7 +68,7 @@ The SDK provides Reactor Core based async APIs. You can read more about Reactor
6868

6969
### Authenticate the client
7070

71-
In order to interact with the Azure CosmosDB service you'll need to create an instance of the Cosmos Client class. To make this possible you will need an url and key of the Azure CosmosDB service.
71+
In order to interact with the Azure Cosmos DB service you'll need to create an instance of the Cosmos Client class. To make this possible you will need an url and key of the Azure Cosmos DB service.
7272

7373
The SDK provides two clients.
7474
1. `CosmosAsyncClient` for operations using asynchronous APIs.
@@ -123,7 +123,7 @@ You may learn more about partitioning [here](https://docs.microsoft.com/azure/co
123123

124124
## Examples
125125

126-
The following section provides several code snippets covering some of the most common CosmosDB SQL API tasks, including:
126+
The following section provides several code snippets covering some of the most common Cosmos DB SQL API tasks, including:
127127
* [Create Cosmos Client](#create-cosmos-client "Create Cosmos Client")
128128
* [Create Database](#create-database "Create Database")
129129
* [Create Container](#create-container "Create Container")
@@ -269,8 +269,8 @@ log4j.appender.A1.layout.ConversionPattern=%d %5X{pid} [%t] %-5p %c - %m%n
269269
## Next Steps
270270

271271
- Samples are explained in detail [here][samples_readme]
272-
- Go through [quickstart][quickstart] - Building a java app to manage CosmosDB SQL API data
273-
- [Read more about Azure CosmosDB Service][cosmos_docs]
272+
- Go through [quickstart][quickstart] - Building a java app to manage Cosmos DB SQL API data
273+
- [Read more about Azure Cosmos DB Service][cosmos_docs]
274274

275275
## Contributing
276276

0 commit comments

Comments
 (0)