Skip to content

Commit b17062b

Browse files
authored
Fixing spelling mistakes. (#2927)
1 parent 81af21f commit b17062b

File tree

81 files changed

+148
-142
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

81 files changed

+148
-142
lines changed

CONTRIBUTING.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -44,6 +44,7 @@ You will be notified by email from the CI system if any issues are discovered, b
4444
* `make -k test-all docker-compose-down` - the same as above, but tears down the Docker services after running all the tests.
4545
* `make fmt` - runs formatter, this command requires the nightly toolchain to be installed by running `rustup toolchain install nightly`.
4646
* `make fix` - runs formatter and clippy checks.
47+
* `make typos` - runs the spellcheck tool over the codebase. (Install by running `cargo install typos`)
4748
* `make build-docs` - builds docs.
4849
* `make docker-compose-up` - starts Docker services.
4950
* `make docker-compose-down` - stops Docker services.

Makefile

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -41,6 +41,9 @@ fmt:
4141
fix:
4242
@$(MAKE) -C $(QUICKWIT_SRC) fix
4343

44+
typos:
45+
typos
46+
4447
# Usage:
4548
# `make test-all` starts the Docker services and runs all the tests.
4649
# `make -k test-all docker-compose-down`, tears down the Docker services after running all the tests.

_typos.toml

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
[files]
2+
extend-exclude = ["**/*.json"]

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ ARG PBC_URL="https://github.com/protocolbuffers/protobuf/releases/download/v21.5
44

55
#TODO:
66
# We can switch to static linking (remove `libsasl2-dev:arm64`) using
7-
# `rdkafka/gssapi-vendored` feature when there is a release incuding:
7+
# `rdkafka/gssapi-vendored` feature when there is a release including:
88
# https://github.com/MaterializeInc/rust-sasl/pull/48
99

1010
RUN dpkg --add-architecture arm64 && \

docs/concepts/querying.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -65,7 +65,7 @@ a few faulty documents.
6565
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:
6666

6767
- `tenant_id`: create one partition per tenant\_id
68-
- `tenant_id,app_id`: create one partiton per unique combination of tenant\_id and app\_id
68+
- `tenant_id,app_id`: create one partition per unique combination of tenant\_id and app\_id
6969
- `tenant_id,hash_mod(app_id, 8)`: for each tenant, create up to 8 partitions containing each data related to some applications
7070
- `hash_mod((tenant_id,app_id), 50)`: create 50 partition in total, containing some combination of tenant and apps.
7171

docs/guides/schemaless.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ Quickwit lets you place the cursor on how strict you would like your schema to b
99

1010
:::note
1111

12-
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:
12+
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:
1313

1414
```bash
1515
./quickwit run

docs/internals/backward-compatibility.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ Stored in metastore only:
1515
- FileBackedIndex
1616
- SplitMetadata.
1717

18-
Quickwit currently manages backward compatibiltiy of all of these resources but QuickwitConfig.
18+
Quickwit currently manages backward compatibility of all of these resources but QuickwitConfig.
1919
This document describes how to handle a change, and how to make test such a change,
2020
and spot eventual regression.
2121

docs/reference/storage-uri.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -106,7 +106,7 @@ See our [Scaleway Setup Guide](../guides/storage-setup/scaleway-setup.md) for th
106106

107107
### Garage
108108

109-
[Garage](https://garagehq.deuxfleurs.fr/) is an Open-Souce lightweight and efficient object storage.
109+
[Garage](https://garagehq.deuxfleurs.fr/) is an Open-Source lightweight and efficient object storage.
110110

111111
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`.
112112

install.sh

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44
#
55
# This is just a little script that can be downloaded from the internet to
66
# install Quickwit.
7-
# It just does platform detection, fetches the lastest appropriate release version from github
7+
# It just does platform detection, fetches the latest appropriate release version from github
88
# and execute the appropriate commands to download the binary.
99
#
1010
# Heavily inspired by the Vector & Meilisearch installation scripts
@@ -199,7 +199,7 @@ get_latest_version() {
199199
latest=""
200200
current_tag=""
201201
for release_info in $releases; do
202-
if [ $i -eq 0 ]; then # Cheking tag_name
202+
if [ $i -eq 0 ]; then # Checking tag_name
203203
if echo "$release_info" | grep -q "$GREP_SEMVER_REGEXP"; then # If it's not an alpha or beta release
204204
current_tag=$release_info
205205
else

quickwit/deny.toml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -66,7 +66,7 @@ ignore = [
6666
[licenses]
6767
# The lint level for crates which do not have a detectable license
6868
unlicensed = "deny"
69-
# List of explictly allowed licenses
69+
# List of explicitly allowed licenses
7070
# See https://spdx.org/licenses/ for list of possible licenses
7171
# [possible values: any SPDX 3.11 short identifier (+ optional exception)].
7272
allow = [
@@ -85,7 +85,7 @@ allow = [
8585
"Zlib",
8686
"zlib-acknowledgement",
8787
]
88-
# List of explictly disallowed licenses
88+
# List of explicitly disallowed licenses
8989
# See https://spdx.org/licenses/ for list of possible licenses
9090
# [possible values: any SPDX 3.11 short identifier (+ optional exception)].
9191
deny = [

0 commit comments

Comments
 (0)