Skip to content

Commit 4c5e1b5

Browse files
authored
fix tables, fix links, fix blocks (#1077)
* fix tables in index config * fix notion links * fix caution, tip block * fix caution blocks
1 parent e4fee7f commit 4c5e1b5

File tree

3 files changed

+15
-33
lines changed

3 files changed

+15
-33
lines changed

docs/reference/index-config.md

Lines changed: 0 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -85,13 +85,11 @@ Today, only the s3 storage is available when running several searcher nodes.
8585

8686
The doc mapping defines how a document and the fields it contains are stored and indexed for a given index. A document is a collection of named fields, each having its own data type (text, binary, date, i64, u64, f64).
8787

88-
```markdown
8988
| Variable | Description | Default value |
9089
| ------------- | ------------- | ------------- |
9190
| `field_mappings` | Collection of field mapping, each having its own data type (text, binary, date, i64, u64, f64). | [] |
9291
| `tag_fields` | Collection of fields already defined in `field_mappings` whose values will be stored in a dedicated `tags` (1) | [] |
9392
| `store_source` | Whether or not the original JSON document is stored or not in the index. | false |
94-
```
9593

9694
(1) [Learn more on the tags usage](../design/querying.md).
9795

@@ -119,33 +117,27 @@ record: position
119117

120118
**Parameters for text field**
121119

122-
```markdown
123120
| Variable | Description | Default value |
124121
| ------------- | ------------- | ------------- |
125122
| `stored` | Whether value is stored in the document store | `true` |
126123
| `tokenizer` | Name of the `Tokenizer`, choices between `raw`, `default` and `stem_en` | `default` |
127124
| `record` | Describes the amount of information indexed, choices between `basic`, `freq` and `position` | `basic` |
128-
```
129125

130126
**Description of available tokenizers**
131127

132-
```markdown
133128
| Tokenizer | Description |
134129
| ------------- | ------------- |
135130
| `raw` | Does not process nor tokenize text |
136131
| `default` | Chops the text on according to whitespace and punctuation, removes tokens that are too long, and lowercases tokens |
137132
| `stem_en` | Like `default`, but also applies stemming on the resulting tokens |
138-
```
139133

140134
**Description of record options**
141135

142-
```markdown
143136
| Record option | Description |
144137
| ------------- | ------------- |
145138
| `basic` | Records only the `DocId`s |
146139
| `freq` | Records the document ids as well as the term frequency |
147140
| `position` | Records the document id, the term frequency and the positions of occurences. |
148-
```
149141

150142
Indexing with position is required to run phrase queries.
151143

@@ -167,13 +159,11 @@ fast: true
167159

168160
**Parameters for i64, u64 and f64 field**
169161

170-
```markdown
171162
| Variable | Description | Default value |
172163
| ------------- | ------------- | ------------- |
173164
| `stored` | Whether value is stored in the document store | `true` |
174165
| `indexed` | Whether value is indexed | `true` |
175166
| `fast` | Whether value is stored in a fast field | `false` |
176-
```
177167

178168
#### `date` type
179169

@@ -191,13 +181,11 @@ fast: true
191181

192182
**Parameters for date field**
193183

194-
```markdown
195184
| Variable | Description | Default value |
196185
| ------------- | ------------- | ------------- |
197186
| `stored` | Whether value is stored in the document store | `true` |
198187
| `indexed` | Whether value is indexed | `true` |
199188
| `fast` | Whether value is stored in a fast field | `false` |
200-
```
201189

202190
#### `bytes` type
203191
The `bytes` type accepts a binary value as a `Base64` encoded string.
@@ -214,13 +202,11 @@ fast: true
214202

215203
**Parameters for bytes field**
216204

217-
```markdown
218205
| Variable | Description | Default value |
219206
| ------------- | ------------- | ------------- |
220207
| `stored` | Whether value is stored in the document store | `true` |
221208
| `indexed` | Whether value is indexed | `true` |
222209
| `fast` | Whether value is stored in a fast field | `false` |
223-
```
224210

225211
### Composite types
226212

@@ -261,7 +247,6 @@ Fields with `null` or missing fields in your JSON document will be silently igno
261247

262248
This section describes indexing settings for a given index.
263249

264-
```markdown
265250
| Variable | Description | Default value |
266251
| ------------- | ------------- | ------------- |
267252
| `timestamp_field` | Timestamp field used for sharding documents in splits (1). | None |
@@ -271,7 +256,6 @@ This section describes indexing settings for a given index.
271256
| `merge_policy.max_merge_factor` | Maximum number of splits to merge. | 12 |
272257
| `resources.num_threads` | Number of threads per source. | 1 |
273258
| `resources.heap_size` | Indexer heap size per source per index. | 2_000_000_000 |
274-
```
275259

276260
(1) [Learn more on time sharding]( ../design/architecture.md)
277261

@@ -285,11 +269,9 @@ Indexer works with a default heap of 2 GiB of memory. This does not directly ref
285269

286270
This section describes search settings for a given index.
287271

288-
```markdown
289272
| Variable | Description | Default value |
290273
| ------------- | ------------- | ------------- |
291274
| `search_default_fields` | Default list of fields that will be used for search. | None |
292-
```
293275

294276
## Sources
295277

docs/reference/metastore-config.md

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ For instance:
1212
- The different sources checkpoints.
1313
- Some extra information such as the index creation time.
1414

15-
The metastore is entirely defined by a single URI. One can set it by editing the `metastore_uri` parameter of the [Quickwit configuration file](https://www.notion.so/Quickwit-configuration-MERGED-3fab5a181a9a43cba83db2fb25b46729) (often named `quickwit.yaml`).
15+
The metastore is entirely defined by a single URI. One can set it by editing the `metastore_uri` parameter of the [Quickwit configuration file](./quickwit-config.md) (often named `quickwit.yaml`).
1616

1717
Currently, Quickwit offers two implementations:
1818

@@ -48,7 +48,7 @@ Likewise, if you upgrade Quickwit to a version that includes some changes in the
4848

4949
For convenience, Quickwit also makes it possible to store its metadata in files using a file-backed metastore. In that case, Quickwit will write one file per index.
5050

51-
The metastore is then configured by passing a [Storage URI](https://www.notion.so/Storage-URI-APPROVED-176d8befb8d144fb820bcd0df077a728) that will serve as the root of the metastore storage.
51+
The metastore is then configured by passing a [Storage URI](./storage-uri.md) that will serve as the root of the metastore storage.
5252

5353
The metadata file associated with a given index will then be stored under
5454

@@ -57,7 +57,7 @@ The metadata file associated with a given index will then be stored under
5757
For the moment, Quickwit supports two types of storage types:
5858

5959
- a local file system URI (e.g., `file:///opt/toto`). It is also valid to pass a file path directly (without file://). `/var/quickwit`. Relative paths will be resolved with respect to the current working directory.
60-
- S3-compatible storage URI (e.g. `s3://my-bucket/some-path`] ). See the [Storage URI](https://www.notion.so/Storage-URI-APPROVED-176d8befb8d144fb820bcd0df077a728) documentation to configure S3 or S3-compatible storage.
60+
- S3-compatible storage URI (e.g. `s3://my-bucket/some-path`] ). See the [Storage URI](./storage-uri.md) documentation to configure S3 or S3-compatible storage.
6161

6262
### Polling configuration
6363

@@ -67,10 +67,10 @@ You can also configure it to poll the File-Backed Metastore periodically to keep
6767

6868
To configure the polling interval (in seconds only), add a URI fragment to the storage URI like this: `s3://quickwit/my-indexes#polling_interval=30s`
6969

70-
<aside>
71-
👌 Amazon S3 charges $0.0004 per 1000 GET requests. Polling a metastore every 30 seconds will induce a cost of $0.04 per month and per index.
70+
:::tip
71+
Amazon S3 charges $0.0004 per 1000 GET requests. Polling a metastore every 30 seconds will induce a cost of $0.04 per month and per index.
7272

73-
</aside>
73+
:::
7474

7575
### Examples
7676

@@ -86,9 +86,9 @@ file:///local/indices#polling_interval=30s
8686
./quickwit-metastores
8787
```
8888

89-
<aside>
90-
The file-backed metastore does not allow concurrent writes. For this reason, it should not be used in distributed settings.
89+
:::caution
90+
The file-backed metastore does not allow concurrent writes. For this reason, it should not be used in distributed settings.
9191
Running several indexer services on the same file-backed metastore can lead to the corruption of the metastore.
9292
Running several search services, on the other hand, is perfectly safe.
9393

94-
</aside>
94+
:::

docs/reference/storage-uri.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -30,12 +30,12 @@ The following are valid local file system URIs
3030
- ./quickwit
3131
```
3232

33-
<aside>
34-
⚠️ When using the `file://` protocol, a third `/` is necessary to express an absolute path.
33+
:::caution
34+
When using the `file://` protocol, a third `/` is necessary to express an absolute path.
3535

3636
For instance, the following URI `file://home/quickwit/` is interpreted as `./home/quickwit`
3737

38-
</aside>
38+
:::
3939

4040
## Amazon S3
4141

@@ -70,7 +70,7 @@ The region will be detected using the first successful method in this list (orde
7070
- `AWS_REGION` environment variable
7171
- Amazon’s instance metadata API [https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-instance-metadata.html](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-instance-metadata.html)
7272

73-
<aside>
74-
⚠️ Custom endpoints are not supported yet.
73+
:::caution
74+
Custom endpoints are not supported yet.
7575

76-
</aside>
76+
:::

0 commit comments

Comments
 (0)