Fix typos all over the codebase (#5259)

Author: rdettai

CONTRIBUTING.md

@@ -57,8 +57,8 @@ Run `make test-all` to run all tests.
 * `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 typos` - runs the spellcheck tool over the codebase. (Install by running `cargo install typos-cli`)
+* `make docs` - builds docs.
 * `make docker-compose-up` - starts Docker services.
 * `make docker-compose-down` - stops Docker services.
 * `make docker-compose-logs` - shows Docker logs.

_typos.toml

@@ -1,2 +1,6 @@
 [files]
 extend-exclude = ["**/*.json"]
+
+[default.extend-words]
+# Don't correct the surname "Teh"
+strat = "strat"

distribution/ecs/README.md

@@ -42,7 +42,7 @@ deployed, you should probably push the Quickwit image to ECR and use ECR
 interface VPC endpoints instead (approx. ~$0.01/hour/AZ).
 
 When using the default image, you will quickly run into the Docker Hub rate
-limiting. We recommand pushing the Quickwit image to ECR and configure that as
+limiting. We recommend pushing the Quickwit image to ECR and configure that as
 `quickwit_image`. Note that the architecture of the image that you push to ECR
 must match the `quickwit_cpu_architecture` variable (`ARM64` by default).
 

distribution/ecs/quickwit/variables.tf

@@ -65,7 +65,7 @@ variable "enable_cloudwatch_logging" {
 }
 
 variable "log_configuration" {
-  description = "Custom log configuraiton for Quickwit tasks"
+  description = "Custom log configuration for Quickwit tasks"
   default     = {}
 }
 

distribution/lambda/README.md

@@ -52,7 +52,7 @@ Provided demonstration setups:
 
 ### Deploy and run
 
-The Makefile is a usefull entrypoint to show how the Lambda deployment can used.
+The Makefile is a useful entrypoint to show how the Lambda deployment can used.
 
 Configure your shell and AWS account:
 ```bash

distribution/lambda/cdk/cli.py

@@ -382,7 +382,7 @@ def benchmark_hdfs_indexing():
         indexer_result = invoke_hdfs_indexer()
         bench_result["lambda_report"] = indexer_result.extract_report()
     except Exception as e:
-        bench_result["invokation_error"] = repr(e)
+        bench_result["invocation_error"] = repr(e)
         print(f"Failed to invoke indexer")
 
     with open(f"lambda-bench.log", "a+") as f:
@@ -409,7 +409,7 @@ def benchmark_hdfs_search(payload: str):
             indexer_result = invoke_hdfs_searcher(payload, download_logs=False)
             bench_result["lambda_report"] = indexer_result.extract_report()
         except Exception as e:
-            bench_result["invokation_error"] = repr(e)
+            bench_result["invocation_error"] = repr(e)
             print(f"Failed to invoke searcher")
 
         with open(f"lambda-bench.log", "a+") as f:

docker-compose.yml

@@ -53,7 +53,7 @@ services:
     image: postgres:${POSTGRES_VERSION:-12.17-alpine}
     container_name: postgres
     ports:
-      - "${MAP_HOST_POSTGRESS:-127.0.0.1}:5432:5432"
+      - "${MAP_HOST_POSTGRES:-127.0.0.1}:5432:5432"
     profiles:
       - all
       - postgres

docs/configuration/index-config.md

@@ -135,7 +135,7 @@ fast:
 | `tokenizer` | Name of the `Tokenizer`. ([See tokenizers](#description-of-available-tokenizers)) for a list of available tokenizers.  | `default` |
 | `record`    | Describes the amount of information indexed, choices between `basic`, `freq` and `position` | `basic` |
 | `fieldnorms` | Whether to store fieldnorms for the field. Fieldnorms are required to calculate the BM25 Score of the document. | `false` |
-| `fast`     | Whether value is stored in a fast field. The fast field will contain the term ids and the dictionary. The default behaviour for `true` is to store the original text unchanged. The normalizers on the fast field is seperately configured. It can be configured via `normalizer: lowercase`. ([See normalizers](#description-of-available-normalizers)) for a list of available normalizers. | `false` |
+| `fast`     | Whether value is stored in a fast field. The fast field will contain the term ids and the dictionary. The default behaviour for `true` is to store the original text unchanged. The normalizers on the fast field is separately configured. It can be configured via `normalizer: lowercase`. ([See normalizers](#description-of-available-normalizers)) for a list of available normalizers. | `false` |
 
 ##### Description of available tokenizers
 
@@ -327,7 +327,7 @@ stored: true
 indexed: true
 fast: true
 input_format: hex
-output_foramt: hex
+output_format: hex
 ```
 
 **Parameters for bytes field**
@@ -432,7 +432,7 @@ tokenizer: default
 record: basic
 ```
 
-Concatenate fields don't support fast fields, and are never stored. They uses their own tokenizer, independantly of the
+Concatenate fields don't support fast fields, and are never stored. They uses their own tokenizer, independently of the
 tokenizer configured on the individual fields.
 At query time, concatenate fields don't support range queries.
 Only the following types are supported inside a concatenate field: text, bool, i64, u64, json. Other types are rejected
@@ -458,7 +458,7 @@ when the features are supported, add these:
 ---
 Only the following types are supported inside a concatenate field: text, datetime, bool, i64, u64, ip, json. Other types are rejected
 ---
-Datetime can only be queried in their RFC-3339 form, possibly omiting later components. # todo! will have to confirm this is achievable
+Datetime can only be queried in their RFC-3339 form, possibly omitting later components. # todo! will have to confirm this is achievable
 ---
 plan:
 - implement text/bool/i64/u64 (nothing to do on search side for it to work). all gets converted to strings

docs/configuration/storage-config.md

@@ -66,7 +66,7 @@ Hardcoding credentials into configuration files is not secure and strongly disco
 | Env variable | Description |
 | --- | --- |
 | `QW_S3_ENDPOINT` | Custom S3 endpoint. |
-| `QW_S3_MAX_CONCURRENCY` | Limit the number of concurent requests to S3 |
+| `QW_S3_MAX_CONCURRENCY` | Limit the number of concurrent requests to S3 |
 
 #### Storage flavors
 

docs/deployment/cluster-sizing.md

@@ -62,7 +62,7 @@ Searcher nodes:
 <!-- 1GB fast_field_cache_capacity + 0.5GB split_footer_cache_capacity + 0.5GB/req aggregation_memory_limit -->
 - Searcher nodes don't use disk unless the [split
   cache](../configuration/node-config.md#Searcher-split-cache-configuration) is
-  explicitely enabled
+  explicitly enabled
 
 One strength of Quickwit is that its Searchers are stateless, which makes it
 easy to scale them up and down based on the workload. Scale the number of