Skip to content

Commit 8521e0b

Browse files
authored
docs: Update spelling to US English (#196)
1 parent 1e60dad commit 8521e0b

8 files changed

Lines changed: 11 additions & 11 deletions

File tree

docs/explanation/cryptography.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ All three charms in the Charmed Apache Spark solution employ pinned revisions of
1717
* Integration Hub for Apache Spark
1818
* Charmed Apache Kyuubi
1919

20-
The Spark History Server and Charmed Apache Kyuubi use different flavours of the
20+
The Spark History Server and Charmed Apache Kyuubi use different flavors of the
2121
[Charmed Apache Spark Rock image](https://github.com/canonical/charmed-spark-rock/) whereas the Integration Hub for
2222
Apache Spark uses the [Integration Hub for Apache Spark Rock image](https://github.com/canonical/spark-integration-hub-rock).
2323

@@ -166,4 +166,4 @@ For more information about the Kyuubi Client, see the
166166
The Spark History Server provides authentication integrated using the Canonical Identity Platform in combination
167167
with a custom design [servlet filter](https://code.launchpad.net/~data-platform/soss/+source/charmed-spark-servlet-filters/+git/charmed-spark-servlet-filters).
168168
This feature can be enabled by following the steps in the
169-
[Spark History Server authorisation How-to guide](https://charmhub.io/spark-k8s-bundle/docs/h-history-server-authorization).
169+
[Spark History Server authorization How-to guide](https://charmhub.io/spark-k8s-bundle/docs/h-history-server-authorization).

docs/explanation/security.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -80,7 +80,7 @@ Charmed Apache Spark K8s runs on top of a set of Rockcraft-based images, all bas
8080
available in the [Apache Spark release page](https://launchpad.net/spark-releases), on top of Ubuntu 22.04.
8181
The images that can be found in the [Charmed Apache Spark rock images GitHub repository](https://github.com/canonical/charmed-spark-rock) are used as the base
8282
images for pods both for Spark jobs and charms.
83-
The following table summarises the relation between the component and its underlying base image.
83+
The following table summarizes the relation between the component and its underlying base image.
8484

8585
| Component | Image |
8686
|------------------------------------|-------------------------------------------------------------------------------------------------------------|
@@ -195,7 +195,7 @@ a cloud native Identity & Access Proxy (IAP) and Access Control Decision API abl
195195
and mutate incoming HTTP(s) requests, fully-integrated with the Canonical Identity Platform.
196196

197197
Refer to the [how-to enable authorization in the Spark history server](how-to-spark-history-server-auth) guide
198-
for more information. From a permission-wise point of view, white lists of authorised users
198+
for more information. From a permission-wise point of view, white lists of authorized users
199199
can be provided using the Spark History Server
200200
[charm configuration option](https://charmhub.io/spark-history-server-k8s/configurations?channel=3.4/edge).
201201

@@ -214,7 +214,7 @@ Refer to the
214214
[COS production deployments best practices](https://charmhub.io/topics/canonical-observability-stack/reference/best-practices)
215215
page for more information.
216216

217-
For more information on how to enable and customise monitoring with COS,
217+
For more information on how to enable and customize monitoring with COS,
218218
see the [Monitoring](how-to-monitoring) guide.
219219

220220
## Additional resources

docs/how-to/enable-monitoring.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -165,7 +165,7 @@ Congratulations, the COS now monitors the two charms.
165165

166166
## Customize dashboards and alert rules
167167

168-
The `cos-configuration-k8s` charm included in the bundle can be used to customise the Grafana dashboards and alert rules.
168+
The `cos-configuration-k8s` charm included in the bundle can be used to customize the Grafana dashboards and alert rules.
169169
If needed, we provide a [default dashboard](https://github.com/canonical/spark-k8s-bundle/blob/main/releases/3.4/resources/grafana) as part
170170
of the bundle and dedicated dashboards for the [Spark History Server](https://github.com/canonical/spark-history-server-k8s-operator/tree/3/edge/src/grafana_dashboards)
171171
and [Charmed Apache Kyuubi](https://github.com/canonical/kyuubi-k8s-operator/tree/3.4/edge/src/grafana_dashboards) charms.

docs/how-to/index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -49,7 +49,7 @@ See our [Monitoring](how-to-monitoring) guide.
4949

5050
We have guides for using Spark History Server with Charmed Apache Spark:
5151

52-
* [Authentication and authorisation](how-to-spark-history-server-auth)
52+
* [Authentication and authorization](how-to-spark-history-server-auth)
5353
* [Expose web GUI](how-to-spark-history-server-expose-web-gui)
5454

5555
## Security

docs/how-to/spark-history-server/index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,6 @@ see the [Tutorial](tutorial-4-history-server) and the following guides:
1313
```{toctree}
1414
:titlesonly:
1515
16-
Authentication and authorisation<auth.md>
16+
Authentication and authorization<auth.md>
1717
Expose web GUI<expose-web-gui.md>
1818
```

docs/index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,7 @@ easy-to-use application integration, and monitoring.
3838
| **Apache Kyuubi** | [External connections](how-to-apache-kyuubi-external-connections)[Integrate](how-to-apache-kyuubi-integrate-with-applications)[Metastore](how-to-apache-kyuubi-external-metastore)[Backups](how-to-apache-kyuubi-back-up-and-restore)[Upgrades](how-to-apache-kyuubi-upgrade)[GPU support](how-to-apache-kyuubi-gpu) |
3939
| **Security** | [Overview](explanation-security)[Enable encryption (Apache Kyuubi)](how-to-apache-kyuubi-encryption-and-passwords)[Cryptography](explanation-cryptography)[Self-signed certificates](how-to-self-signed-certificates) |
4040

41-
## How the documentation is organised
41+
## How the documentation is organized
4242

4343
[Tutorial](tutorial-introduction): For new users needing to learn how to use Charmed Apache Kafka <br>
4444
[How-to guides](how-to-index): For users needing step-by-step instructions to achieve a practical goal <br>

docs/tutorial/2-distributed-data-processing.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -316,5 +316,5 @@ The result should look similar to the following:
316316
2025-04-07T11:32:44.872Z [sparkd] Number of tweets containing Ubuntu: 54
317317
```
318318

319-
By default, Apache Spark stores the logs of drivers and executors as pod logs in the local file systems, which are lost once the pods are deleted. Apache Spark can store these logs in a persistent object storage system, like S3, so that they can later be retrieved and visualised by a component called Spark History Server.
319+
By default, Apache Spark stores the logs of drivers and executors as pod logs in the local file systems, which are lost once the pods are deleted. Apache Spark can store these logs in a persistent object storage system, like S3, so that they can later be retrieved and visualized by a component called Spark History Server.
320320

docs/tutorial/6-apache-kyuubi.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -228,7 +228,7 @@ juju scale-application kyuubi-k8s 3
228228

229229
Wait for the deployment to complete and check the model status with the `juju status` command.
230230
The `kyuubi-k8s` units are all in the `blocked` state now, with a message “Missing ZooKeeper integration”.
231-
That is because multi-node Apache Kyuubi deployments require Apache ZooKeeper for synchronisation.
231+
That is because multi-node Apache Kyuubi deployments require Apache ZooKeeper for synchronization.
232232

233233
Now, deploy [Apache ZooKeeper K8s](https://charmhub.io/zookeeper-k8s) charm (three nodes, since we want high availability) and integrate it with Apache Kyuubi:
234234

0 commit comments

Comments
 (0)