Skip to content

Commit fd0eb6c

Browse files
authored
Backport docs corrections from quickwit.io (#1127)
1 parent 26d4f5c commit fd0eb6c

File tree

2 files changed

+4
-4
lines changed

2 files changed

+4
-4
lines changed

docs/design/architecture.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -41,10 +41,10 @@ A Quickwit index stores documents and makes it possible to query them efficientl
4141
A document is a collection of fields. Fields can be stored in different data structures:
4242

4343
- an inverted index, which enables fast full-text search.
44-
- a columnar storage called `fast field`. It is the equivalent of doc values in [Lucene]([https://lucene.apache.org/](https://lucene.apache.org/)). Fast fields are required to compute aggregates over the documents matching a query. They can also allow some advanced types of filtering.
44+
- a columnar storage called `fast field`. It is the equivalent of doc values in [Lucene](https://lucene.apache.org/). Fast fields are required to compute aggregates over the documents matching a query. They can also allow some advanced types of filtering.
4545
- a row-storage called the doc store. It makes it possible to get the content of the matching documents.
4646

47-
You can configure your index to control how to map your JSON object to a Quickwit document and, for each field, define whether it should be stored, indexed, or be a fast field. [Learn how to configure your index](../reference/index-config.pd)
47+
You can configure your index to control how to map your JSON object to a Quickwit document and, for each field, define whether it should be stored, indexed, or be a fast field. [Learn how to configure your index](../reference/index-config.md)
4848

4949
### Splits
5050

@@ -94,7 +94,7 @@ Thanks to the hotcache, opening a split on Amazon S3 only takes 60ms. It makes i
9494

9595
**Cluster discovery**
9696

97-
Quickwit uses a gossip protocol to manage membership and broadcast messages to the cluster provided by [artillery project](https://github.com/bastion-rs/artillery/). The gossip protocol is based on [SWIM: Scalable Weakly-consistent Infection-style Process Group Membership Protocol]([https://www.cs.cornell.edu/projects/Quicksilver/public_pdfs/SWIM.pdf](https://www.cs.cornell.edu/projects/Quicksilver/public_pdfs/SWIM.pdf)) with a few minor adaptations.
97+
Quickwit uses a gossip protocol to manage membership and broadcast messages to the cluster provided by [artillery project](https://github.com/bastion-rs/artillery/). The gossip protocol is based on [SWIM: Scalable Weakly-consistent Infection-style Process Group Membership Protocol](https://www.cs.cornell.edu/projects/Quicksilver/public_pdfs/SWIM.pdf) with a few minor adaptations.
9898

9999
**Rendezvous hashing**
100100

docs/reference/index-config.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -257,7 +257,7 @@ This section describes indexing settings for a given index.
257257
| `resources.num_threads` | Number of threads per source. | 1 |
258258
| `resources.heap_size` | Indexer heap size per source per index. | 2_000_000_000 |
259259

260-
(1) [Learn more on time sharding]( ../design/architecture.md)
260+
(1) [Learn more on time sharding](./../design/architecture.md)
261261

262262

263263
### Indexer memory usage

0 commit comments

Comments
 (0)