Fixing spelling mistakes. (#2927)

Author: fulmicoton

CONTRIBUTING.md

@@ -44,6 +44,7 @@ You will be notified by email from the CI system if any issues are discovered, b
 * `make -k test-all docker-compose-down` - the same as above, but tears down the Docker services after running all the tests.
 * `make fmt` - runs formatter, this command requires the nightly toolchain to be installed by running `rustup toolchain install nightly`.
 * `make fix` - runs formatter and clippy checks.
+* `make typos` - runs the spellcheck tool over the codebase. (Install by running `cargo install typos`)
 * `make build-docs` - builds docs.
 * `make docker-compose-up` - starts Docker services.
 * `make docker-compose-down` - stops Docker services.

Makefile

@@ -41,6 +41,9 @@ fmt:
 fix:
 	@$(MAKE) -C $(QUICKWIT_SRC) fix
 
+typos:
+	typos
+
 # Usage:
 # `make test-all` starts the Docker services and runs all the tests.
 # `make -k test-all docker-compose-down`, tears down the Docker services after running all the tests.

_typos.toml

@@ -0,0 +1,2 @@
+[files]
+extend-exclude = ["**/*.json"]

build/cross-images/aarch64-unknown-linux-gnu.dockerfile

@@ -4,7 +4,7 @@ ARG PBC_URL="https://github.com/protocolbuffers/protobuf/releases/download/v21.5
 
 #TODO: 
 # We can switch to static linking (remove `libsasl2-dev:arm64`) using 
-# `rdkafka/gssapi-vendored` feature when there is a release incuding: 
+# `rdkafka/gssapi-vendored` feature when there is a release including: 
 # https://github.com/MaterializeInc/rust-sasl/pull/48
 
 RUN dpkg --add-architecture arm64 && \

docs/concepts/querying.md

@@ -65,7 +65,7 @@ a few faulty documents.
 Quickwit allows you to configure how document are routed with a simple DSL. Here are some sample expression with a short description of their result:
 
 - `tenant_id`: create one partition per tenant\_id
-- `tenant_id,app_id`: create one partiton per unique combination of tenant\_id and app\_id
+- `tenant_id,app_id`: create one partition per unique combination of tenant\_id and app\_id
 - `tenant_id,hash_mod(app_id, 8)`: for each tenant, create up to 8 partitions containing each data related to some applications
 - `hash_mod((tenant_id,app_id), 50)`: create 50 partition in total, containing some combination of tenant and apps.
 

docs/guides/schemaless.md

@@ -9,7 +9,7 @@ Quickwit lets you place the cursor on how strict you would like your schema to b
 
 :::note
 
-To execute the CLI commands thoughout this guide, [install](/docs/get-started/installation.md) Quickwit and start a server in a terminal with the following command:
+To execute the CLI commands throughout this guide, [install](/docs/get-started/installation.md) Quickwit and start a server in a terminal with the following command:
 
 ```bash
 ./quickwit run

docs/internals/backward-compatibility.md

@@ -15,7 +15,7 @@ Stored in metastore only:
 - FileBackedIndex
 - SplitMetadata.
 
-Quickwit currently manages backward compatibiltiy of all of these resources but QuickwitConfig.
+Quickwit currently manages backward compatibility of all of these resources but QuickwitConfig.
 This document describes how to handle a change, and how to make test such a change,
 and spot eventual regression.
 

docs/reference/storage-uri.md

@@ -106,7 +106,7 @@ See our [Scaleway Setup Guide](../guides/storage-setup/scaleway-setup.md) for th
 
 ### Garage
 
-[Garage](https://garagehq.deuxfleurs.fr/) is an Open-Souce lightweight and efficient object storage.
+[Garage](https://garagehq.deuxfleurs.fr/) is an Open-Source lightweight and efficient object storage.
 
 To use it with Quickwit, you will need to setup the region, as mentioned in [Garage documentation](https://garagehq.deuxfleurs.fr/documentation/connect/), it's often set just to `garage`.
 

install.sh

@@ -4,7 +4,7 @@
 #
 # This is just a little script that can be downloaded from the internet to
 # install Quickwit.
-# It just does platform detection, fetches the lastest appropriate release version from github
+# It just does platform detection, fetches the latest appropriate release version from github
 # and execute the appropriate commands to download the binary.
 #
 # Heavily inspired by the Vector & Meilisearch installation scripts
@@ -199,7 +199,7 @@ get_latest_version() {
     latest=""
     current_tag=""
     for release_info in $releases; do
-        if [ $i -eq 0 ]; then # Cheking tag_name
+        if [ $i -eq 0 ]; then # Checking tag_name
             if echo "$release_info" | grep -q "$GREP_SEMVER_REGEXP"; then # If it's not an alpha or beta release
                 current_tag=$release_info
             else

quickwit/deny.toml

@@ -66,7 +66,7 @@ ignore = [
 [licenses]
 # The lint level for crates which do not have a detectable license
 unlicensed = "deny"
-# List of explictly allowed licenses
+# List of explicitly allowed licenses
 # See https://spdx.org/licenses/ for list of possible licenses
 # [possible values: any SPDX 3.11 short identifier (+ optional exception)].
 allow = [
@@ -85,7 +85,7 @@ allow = [
     "Zlib",
     "zlib-acknowledgement",
 ]
-# List of explictly disallowed licenses
+# List of explicitly disallowed licenses
 # See https://spdx.org/licenses/ for list of possible licenses
 # [possible values: any SPDX 3.11 short identifier (+ optional exception)].
 deny = [