Skip to content

Commit

Permalink
Fix typos identified by IntelliJ (#118)
Browse files Browse the repository at this point in the history
Fix typos identified by IntelliJ

Co-authored-by: angelasimms <[email protected]>
  • Loading branch information
JackPGreen and angelasimms authored Aug 11, 2023
1 parent b96ea9f commit 4c2829b
Show file tree
Hide file tree
Showing 21 changed files with 35 additions and 35 deletions.
4 changes: 2 additions & 2 deletions docs/modules/ROOT/pages/api-reference.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ query {

=== Regions

Regions are geographic locations of where your cloud resources are located. Different cloud providers support different regions. Also, there may be some regions that we don't support yet. So that you need to check available regions before creating a Hazecast Cluster on Hazecast Cloud from our GraphQL API with `query regions`.
Regions are geographic locations of where your cloud resources are located. Different cloud providers support different regions. Also, there may be some regions that we don't support yet. So that you need to check available regions before creating a Hazelcast Cluster on Hazelcast Cloud from our GraphQL API with `query regions`.

[source,shell]
----
Expand Down Expand Up @@ -67,7 +67,7 @@ query {

=== Availability Zones

Availability zones are isolated locations within data center regions from which public cloud services originate and operate. In order to create Enterprise clusters, you need to select which availability zones should be used. This availability zones changes according to the cloud provider and region. Also, the number of instances you need, may not be available on this availability zones. So that you need to check available availability zones for your demand with `availabilityZones query`.
Availability zones are isolated locations within data center regions from which public cloud services originate and operate. In order to create Enterprise clusters, you need to select which availability zones should be used. This availability zones changes according to the cloud provider and region. Also, the number of instances you need, may not be available on this availability zone. So that you need to check available availability zones for your demand with `availabilityZones query`.

[source,shell]
----
Expand Down
6 changes: 3 additions & 3 deletions docs/modules/ROOT/pages/aws-vpc-peering.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@
:page-dedicated: true
:page-aliases: gcp-vpc-peering.adoc, azure-vnet-peering.adoc, aws-private-link.adoc

You can create an AWS VPC peering connection, using one of the following option:
You can create an AWS VPC peering connection, using one of the following options:

- Use the CLI (recommended)
- Create a manual connection
Expand All @@ -19,7 +19,7 @@ This option provides the easiest way of creating an AWS VPC Peering with your Ha

. Install the link:{page-url-github-cloud-cli}[Hazelcast {hazelcast-cloud} CLI].

. Set the following AWS envrionment variables:
. Set the following AWS environment variables:

** `AWS_ACCESS_KEY_ID`: Your access key ID.
** `AWS_SECRET_ACCESS_KEY`: Your secret access key.
Expand Down Expand Up @@ -195,7 +195,7 @@ WARNING: The CIDR of your {hazelcast-cloud} Dedicated cluster and the CIDR of yo
== Listing Peering Connections

You can list VPC peerings on your cluster by going to *Cluster Details > *Settings* > *VPC Peering* one by one as shown below.
You can check where the connection established by checking VPC ID and Subnet from the list.
You can check where the connection is established by checking VPC ID and Subnet from the list.

Also, you can easily use the Go SDK or Hazelcast {hazelcast-cloud} CLI for this.

Expand Down
2 changes: 1 addition & 1 deletion docs/modules/ROOT/pages/charts-and-stats.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ This chart shows the number of clients that are connected to your cluster.

== Map Metrics

Below the Cluster Metrics, you see the *Map Metrics* where the charts specific to maps are displayed. You can select the map that you want to monitor from the drop down just under the Map Metrics heading.
Below the Cluster Metrics, you see the *Map Metrics* where the charts specific to maps are displayed. You can select the map that you want to monitor from the drop-down just under the Map Metrics heading.

In the *Map Metrics* part of the Cluster Details page, you can see the charts described in the below sections.

Expand Down
2 changes: 1 addition & 1 deletion docs/modules/ROOT/pages/cluster-side-modules.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -137,7 +137,7 @@ The libraries in your project must not conflict with those that are built into H
Before you go into production with your cluster-side modules, it's best to test them on a development cluster to make sure that they work as expected. To test cluster-side modules, follow these best practices:

- Use a xref:serverless-cluster.adoc[{hazelcast-cloud} Serverless development cluster]: It's faster to test cluster-side modules in a development cluster.
- Use the xref:maven-plugin-hazelcast.adoc[Hazelcast {hazelcast-cloud} Maven plugin]: The Maven plugin allows you to package and deploy your cluster-side modules in a single command from your IDE. You can also debug you cluster-side modules by streaming cluster logs after deployment.
- Use the xref:maven-plugin-hazelcast.adoc[Hazelcast {hazelcast-cloud} Maven plugin]: The Maven plugin allows you to package and deploy your cluster-side modules in a single command from your IDE. You can also debug your cluster-side modules by streaming cluster logs after deployment.

[[deploy]]
== Moving to Production
Expand Down
2 changes: 1 addition & 1 deletion docs/modules/ROOT/pages/create-account.adoc
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
= Creating an Account
Creating an Account
:description: Before you create a cluster, you must create an account. You can create an account with your GitHub credentials, Google credentials, or you can provide an email address and password.
:toclevels: 3

Expand Down
2 changes: 1 addition & 1 deletion docs/modules/ROOT/pages/custom-classes-upload.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ Check the xref:cluster-side-modules.adoc#prereqs, [requirements and limitations]
[[package]]
== Uploading Cluster-Side Modules

Clusters expect all modules to be packaged into a single ZIP or JAR file. When youve built and packaged your cluster-side modules, the final step is to upload the resulting package file to the cluster.
Clusters expect all modules to be packaged into a single ZIP or JAR file. When you've built and packaged your cluster-side modules, the final step is to upload the resulting package file to the cluster.

You can upload custom classes, using the following options:

Expand Down
4 changes: 2 additions & 2 deletions docs/modules/ROOT/pages/delete-account.adoc
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
= Deleting an Account
:description: pass:q[If you no longer need to access your clusters, you can delete your account. If want to avoid additional charges while your clusters are not in use, consider xref:stop-and-resume.adoc[pausing] them instead.]
:description: pass:q[If you no longer need to access your clusters, you can delete your account. To avoid additional charges while your clusters are not in use, consider xref:stop-and-resume.adoc[pausing] them instead.]
:cloud-tags: Manage Accounts
:cloud-title: Deleting an Account
:cloud-order: 60
Expand All @@ -11,7 +11,7 @@
[[cluster-and-data-deletion]]
== Cluster and Data Deletion

Deleting an account _removes_ all of the following:
Deleting an account _removes_ all the following:

- Clusters linked to the account, including any associated data, such as data structures, custom classes, backups, and configuration.
- Account and payment details.
Expand Down
2 changes: 1 addition & 1 deletion docs/modules/ROOT/pages/deleting-a-cluster.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -12,4 +12,4 @@

. Click *Delete* and confirm your choice.

When you delete a cluster, all data related to the cluster, including the configuration is removed. You cannot recover any data from a deleted cluster.
When you delete a cluster, all data related to the cluster, including the configuration, is removed. You cannot recover any data from a deleted cluster.
8 changes: 4 additions & 4 deletions docs/modules/ROOT/pages/get-started.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -77,7 +77,7 @@ When you see `Connection Successful!` in the output, the client is successfully
.. Continue to the <<step-3, next step>> to query your sample data in the SQL browser.
TIP: Take a moment, to read the code in the link:https://github.com/hazelcast/hazelcast-cloud-java-sample-client/blob/5.1/src/main/java/com/hazelcast/cloud/ClientWithSsl.java[`ClientWithSSL.java`] file to understand how the client connected.
TIP: Take a moment to read the code in the link:https://github.com/hazelcast/hazelcast-cloud-java-sample-client/blob/5.1/src/main/java/com/hazelcast/cloud/ClientWithSsl.java[`ClientWithSSL.java`] file to understand how the client connected.
--
Python::
Expand Down Expand Up @@ -111,7 +111,7 @@ When you see `Connection Successful!` in the output, the client is successfully
.. Continue to the <<step-3, next step>> to query your sample data in the SQL browser.
TIP: Take a moment, to read the code in the link:https://github.com/hazelcast/hazelcast-cloud-python-sample-client/blob/5.1/client_with_ssl.py[`client_with_ssl.py`] file to understand how the client connected.
TIP: Take a moment to read the code in the link:https://github.com/hazelcast/hazelcast-cloud-python-sample-client/blob/5.1/client_with_ssl.py[`client_with_ssl.py`] file to understand how the client connected.
--
.NET::
Expand Down Expand Up @@ -145,7 +145,7 @@ When you see `Connection Successful!` in the output, the client is successfully
.. Continue to the <<step-3, next step>> to query your sample data in the SQL browser.
TIP: Take a moment, to read the code in the link:https://github.com/hazelcast/hazelcast-cloud-csharp-sample-client/blob/5.1/ClientWithSsl/Program.cs[`program.cs`] file to understand how the client connected.
TIP: Take a moment to read the code in the link:https://github.com/hazelcast/hazelcast-cloud-csharp-sample-client/blob/5.1/ClientWithSsl/Program.cs[`program.cs`] file to understand how the client connected.
--
SQL (CLI)::
Expand Down Expand Up @@ -197,7 +197,7 @@ You should see your installed version of the CLI client.
. From a command prompt, change into the root directory where you extracted the ZIP file.
. Execute the following command to connect the SQL shell to your cluster. You may need add a path to the hz-cli program.
. Execute the following command to connect the SQL shell to your cluster. You may need to add a path to the hz-cli program.
+
```bash
hz-cli -f hazelcast-client-with-ssl.yml sql
Expand Down
6 changes: 3 additions & 3 deletions docs/modules/ROOT/pages/jcache.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -7,11 +7,11 @@ You can also use wildcards to associate your configuration with multiple jcache

== Backup Count

Number of synchronous backups/replications. The higher number the more highly available cluster but performance decreases and memory cost of each entry increases. Synchronous backup operations have a blocking cost which may cause the higher latencies.
Number of synchronous backups/replications. The higher the number, the more highly available cluster but performance decreases and memory cost of each entry increases. Synchronous backup operations have a blocking cost which may cause higher latencies.

== Asynchronous Backup Count

Number of asynchronous backups/replications. The higher number the more highly available cluster but performance decreases and memory cost of each entry increases. Asynchronous backups are fire & forget and do not require the acknowledgements.
Number of asynchronous backups/replications. The higher the number, the more highly available cluster but performance decreases and memory cost of each entry increases. Asynchronous backups are fire & forget and do not require acknowledgements.

== Key Type

Expand All @@ -27,7 +27,7 @@ Eviction policy that compares values to find the best matching eviction candidat

== Max Size Policy

Maximum size policy. If maximum size is reached, the cache is evicted based on the eviction policy.
Maximum size policy. If the maximum size is reached, the cache is evicted based on the eviction policy.

== Maximum Size

Expand Down
4 changes: 2 additions & 2 deletions docs/modules/ROOT/pages/map-configurations.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ Hazelcast distributes the map entries onto multiple cluster members. Each member

* *Backup Count 0:* This means entries are not replicated to any member other than the primary one. This is the most cost-effective and best-performing option, but also the least safe. It is cost-effective because 100% of the total memory is reserved for your entries. So, set the backup count to 0 if you can tolerate data loss at some level (example use cases may include caching).
* *Backup Count 1:* This means entries are replicated to one member in addition to the primary one. 50% of the total memory is reserved for your entries. If you have a cluster with 10 GiB and your backup count is 1, then you can keep up to 5 GiB of entries because the other half of the cluster memory is used for the backups of those entries. This is the default option for Hazelcast maps and recommended for most use cases where you cannot tolerate data loss.
* *Backup Count 2:* This means entries are replicated to two member in addition to the primary one. 33.3% of the total memory is reserved for your entries. If you have a cluster with 30 GiB and your backup count is 2, then you can keep entries up to 10 GiB because the remaining cluster memory is used for two backups of those entries. This is recommended for the use cases where you keep mission-critical data with high data safety requirements. Note that this is the least cost-effective setup with the biggest performance overhead, but also has the highest data redundancy.
* *Backup Count 2:* This means entries are replicated to two members in addition to the primary one. 33.3% of the total memory is reserved for your entries. If you have a cluster with 30 GiB and your backup count is 2, then you can keep entries up to 10 GiB because the remaining cluster memory is used for two backups of those entries. This is recommended for the use cases where you keep mission-critical data with high data safety requirements. Note that this is the least cost-effective setup with the biggest performance overhead, but also has the highest data redundancy.

== Time To Live

Expand All @@ -25,7 +25,7 @@ Both Time-to-Live and Max Idle Seconds can be used simultaneously on the map ent

== Eviction Policy

Eviction policy to be applied when the size of map grows larger than the value specified by the Max Size element described below. Valid values are as follows:
Eviction policy to be applied when the size of the map grows larger than the value specified by the Max Size element described below. Valid values are as follows:

- NONE: Default policy. If set, no items are evicted and the property Max Size described below will be ignored. You still can combine it with TTL and Max Idle Seconds.
- LRU: Least Recently Used.
Expand Down
2 changes: 1 addition & 1 deletion docs/modules/ROOT/pages/maploader-and-mapstore.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -82,7 +82,7 @@ If the name of your MapStore class is the same as the one that you want to updat
. Optional: <<test-mapstore, Test your new MapStore>>.
. <<deploy, Deploy>> the new version of your MapStore.

If the name of your MapStore class is the different to the one that you want to update, do the following:
If the name of your MapStore class is different to the one that you want to update, do the following:

. Click *Upload Custom Classes* and remove the file that contains your MapStore.
. Optional: <<test-mapstore, Test your new MapStore>>.
Expand Down
2 changes: 1 addition & 1 deletion docs/modules/ROOT/pages/payment-methods.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ For xref:dedicated-cluster.adoc[{hazelcast-cloud} Dedicated clusters], a wider r

To set up automatic payments for your usage, add a payment card to your account. For {hazelcast-cloud} Serverless clusters, you are prompted to add your payment details after signing in for the first time.

NOTE: Hazelcast uses a third-party to store payment details and process payments. Payment details are not stored in Hazelcast.
NOTE: Hazelcast uses a third party to store payment details and process payments. Payment details are not stored in Hazelcast.

. Sign into the link:{page-cloud-console}[Hazelcast {hazelcast-cloud} console,window=_blank].
. Go to *Account* > *Billing & Payments*.
Expand Down
4 changes: 2 additions & 2 deletions docs/modules/ROOT/partials/architecture.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ image:architecture.png[Cloud architecture]
- Built on containerization and orchestration technologies: Docker and Kubernetes.
- Minimal Docker images are used for the sake of simplicity and security.
- User clusters are isolated from each other on the orchestration level.
- Resources (memory, CPU) are limited on the container level, so resource stealing is prevented.
- Resources (memory, CPU) are limited at the container level, so resource stealing is prevented.
- All accesses to Kubernetes clusters are closed by default, with the exception of client endpoints.
- All client endpoints to Kubernetes clusters and all endpoints to Hazelcast {hazelcast-cloud} console are encrypted via TLS.
- Authentication of Hazelcast {hazelcast-cloud} console is performed via the JSON Web Token (JWT) standard.
Expand All @@ -18,7 +18,7 @@ image:architecture.png[Cloud architecture]
== Components

{hazelcast-cloud} Dedicated creates a subaccount for each customer. Under this subaccount, the following components are created in the given order when you create a cluster:
{hazelcast-cloud} Dedicated creates a sub account for each customer. Under this sub account, the following components are created in the given order when you create a cluster:

- Virtual Private Cloud (VPC)
* Kubernetes cluster
Expand Down
2 changes: 1 addition & 1 deletion docs/modules/ROOT/partials/deprecated/credits.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,6 @@ To manage credits for a team, you must have either an xref:create-account.adoc#r
. Click *Credits*.
. Enter a promo code and click *Redeem*.

When you are running low on credits you will receive an email notification.
When you are running low on credits, you will receive an email notification.

When you have no credits, and no payment method set up in your account, your clusters will be stopped.
4 changes: 2 additions & 2 deletions docs/modules/ROOT/partials/list.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -16,10 +16,10 @@ If you set this value to zero, no capacity constraint will be applied.

== Backup Count

This value sets how many synchronous back-ups there will be. In this case, backup operations block operations until backups are successfully copied to backup members (or deleted from backup members in case of remove) and acknowledgements are received. Therefore, backups are updated before a put operation is completed, provided that the cluster is stable.
This value sets how many synchronous backups there will be. In this case, backup operations block operations until backups are successfully copied to backup members (or deleted from backup members in case of remove) and acknowledgements are received. Therefore, backups are updated before a put operation is completed, provided that the cluster is stable.
0 means there will be no backup, and 1 means there will be 1 backup of this set in another member of the cluster. When you set 2, two members will have the backup.

== Asynchronous Backup Count

This value sets how many asynchronous back-ups there will be. In contrast to asynchronous, synchronous backups doesn't block operations. They are fire & forget and do not require acknowledgements; the backup operations are performed at some point in time.
This value sets how many asynchronous backups there will be. In contrast to asynchronous, synchronous backups doesn't block operations. They are fire & forget and do not require acknowledgements; the backup operations are performed at some point in time.
0 means there will be no asynchronous backup, and 1 means there will be 1 asynchronous backup of this set in another member of the cluster. When you set 2, two members will have the asynchronous backup.
2 changes: 1 addition & 1 deletion docs/modules/ROOT/partials/multimap.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ Multimap is a specialized map, in which you can store multiple values for a sing

== Multimap Name

You can give to custom name to your multimap structure.
You can give a custom name to your multimap structure.

[source,java]
----
Expand Down
Loading

0 comments on commit 4c2829b

Please sign in to comment.