Skip to content
This repository was archived by the owner on Sep 21, 2021. It is now read-only.

Commit bc8ab7e

Browse files
Converted all [IMPORTANT] to another annotation type
1 parent e7a3b85 commit bc8ab7e

22 files changed

+37
-37
lines changed

050_Search/10_Multi_index_multi_type.asciidoc

+1-1
Original file line numberDiff line numberDiff line change
@@ -49,7 +49,7 @@ request to a primary or replica of every shard in that index, then gathers the
4949
results from each shard. Searching within multiple indices works in exactly
5050
the same way -- there are just more shards involved.
5151

52-
[IMPORTANT]
52+
[TIP]
5353
================================================
5454
5555
Searching one index which has 5 primary shards is *exactly equivalent* to

052_Mapping_Analysis/35_Inverted_index.asciidoc

+1-1
Original file line numberDiff line numberDiff line change
@@ -106,7 +106,7 @@ we apply the same normalization rules that we used on the `content` field to
106106
our query string, it would become a query for `"+quick +fox"`, which would
107107
match both documents!
108108

109-
IMPORTANT: This is very important. You can only find terms that actually exist in your
109+
NOTE: This is very important. You can only find terms that actually exist in your
110110
index, so: *both the indexed text and the query string must be normalized
111111
into the same form*.
112112

052_Mapping_Analysis/45_Mapping.asciidoc

+1-1
Original file line numberDiff line numberDiff line change
@@ -203,7 +203,7 @@ You can specify the mapping for a type when you first create an index.
203203
Alternatively, you can add the mapping for a new type (or update the mapping
204204
for an existing type) later, using the `/_mapping` endpoint.
205205

206-
[IMPORTANT]
206+
[NOTE]
207207
================================================
208208
While you can *add* to an existing mapping, you can't *change* it. If a field
209209
already exists in the mapping, then it probably means that data from that

056_Sorting/90_What_is_relevance.asciidoc

+1-1
Original file line numberDiff line numberDiff line change
@@ -147,7 +147,7 @@ sub-calculations that were required:
147147
<3> Inverse document frequency
148148
<4> Field length norm
149149

150-
IMPORTANT: Producing the `explain` output is expensive. It is a debugging tool
150+
WARNING: Producing the `explain` output is expensive. It is a debugging tool
151151
only -- don't leave it turned on in production.
152152

153153
The first part is the summary of the calculation. It tells us that it has

056_Sorting/95_Fielddata.asciidoc

+1-1
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ In order to make sorting efficient, Elasticsearch loads all of the values for
2020
the field that you want to sort on into memory. This is referred to as
2121
_fielddata_.
2222

23-
IMPORTANT: It doesn't just load the values for the documents that matched a
23+
WARNING: It doesn't just load the values for the documents that matched a
2424
particular query. It loads the values from *every document in your index*,
2525
regardless of the document `type`.
2626

060_Distributed_Search/20_Scan_and_scroll.asciidoc

+1-1
Original file line numberDiff line numberDiff line change
@@ -69,7 +69,7 @@ documents. When scanning, the `size` is applied to each shard, so you will
6969
get back a maximum of `size * number_of_primary_shards` documents in each
7070
batch.
7171

72-
IMPORTANT: The scroll request also returns a *new `_scroll_id`*. Every time
72+
NOTE: The scroll request also returns a *new `_scroll_id`*. Every time
7373
we make the next scroll request, we must pass the `_scroll_id` returned by the
7474
*previous* scroll request.
7575

075_Inside_a_shard/40_Near_real_time.asciidoc

+1-1
Original file line numberDiff line numberDiff line change
@@ -91,7 +91,7 @@ POST /my_logs/_settings
9191
<1> Disable automatic refreshes.
9292
<2> Refresh automatically every second.
9393

94-
IMPORTANT: The `refresh_interval` expects a ``duration'' like `1s` (one
94+
CAUTION: The `refresh_interval` expects a ``duration'' like `1s` (one
9595
second) or `2m` (two minutes). An absolute number like `1` means
9696
**1 millisecond**... a sure way to bring your cluster to its knees.
9797

100_Full_Text_Search/35_Relevance_is_broken.asciidoc

+1-1
Original file line numberDiff line numberDiff line change
@@ -49,7 +49,7 @@ search requests. The `dfs` stands for _Distributed Frequency Search_ and it
4949
tells Elasticsearch to first retrieve the local IDF from each shard in order
5050
to calculate the global IDF across the whole index.
5151

52-
IMPORTANT: Don't use `dfs_query_then_fetch` in production. It really isn't
52+
TIP: Don't use `dfs_query_then_fetch` in production. It really isn't
5353
required. Just having enough data will ensure that your term frequencies are
5454
well distributed. There is no reason to add this extra DFS step to every query
5555
that you run.

110_Multi_Field_Search/45_Custom_all.asciidoc

+1-1
Original file line numberDiff line numberDiff line change
@@ -42,7 +42,7 @@ With this mapping in place, we can query the `first_name` field for first
4242
names, the `last_name` field for last name, or the `full_name` field for first
4343
and last names.
4444

45-
IMPORTANT: Mappings of the `first_name` and `last_name` fields have no bearing
45+
NOTE: Mappings of the `first_name` and `last_name` fields have no bearing
4646
on how the `full_name` field is indexed. The `full_name` field copies the
4747
string values from the other two fields, then indexes them according to the
4848
mapping of the `full_name` field only.

110_Multi_Field_Search/50_Cross_field.asciidoc

+1-1
Original file line numberDiff line numberDiff line change
@@ -81,7 +81,7 @@ the `last_name` fields and uses the minimum of the two as the IDF for both
8181
fields. The fact that `smith` is a common last name means that it will be
8282
treated as a common first name too.
8383

84-
[IMPORTANT]
84+
[NOTE]
8585
==================================================
8686
For the `cross_fields` query type to work optimally, all fields should have
8787
the same analyzer. Fields which share an analyzer are grouped together as

130_Partial_Matching/15_WildcardRegexp.asciidoc

+1-1
Original file line numberDiff line numberDiff line change
@@ -59,7 +59,7 @@ While prefix matching can be made more efficient by preparing your data at
5959
index time, wildcard and regular expression matching can only really be done
6060
at query time. These queries have their place, but should be used sparingly.
6161

62-
[IMPORTANT]
62+
[CAUTION]
6363
=================================================
6464
6565
The `prefix`, `wildcard` and `regexp` queries operate on terms. If you use

170_Relevance/15_Practical_scoring.asciidoc

+1-1
Original file line numberDiff line numberDiff line change
@@ -204,7 +204,7 @@ than necessary, this field-level index-time boost is combined with the field
204204
length norm (see <<field-norm>>) and stored in the index as a single byte.
205205
This is the value returned by `norm(t,d)` in the formula above.
206206

207-
[IMPORTANT]
207+
[WARNING]
208208
=========================================
209209
210210
We strongly recommend against using field-level index-time boosts for a few

170_Relevance/70_Pluggable_similarities.asciidoc

+1-1
Original file line numberDiff line numberDiff line change
@@ -71,7 +71,7 @@ it considers each field separately by taking the average length of the field
7171
into account. It can distinguish between a short `title` field and a `long`
7272
title field.
7373

74-
IMPORTANT: In <<query-time-boosting>> we said that the `title` field has a
74+
CAUTION: In <<query-time-boosting>> we said that the `title` field has a
7575
``natural'' boost over the `body` field because of its length. This natural
7676
boost disappears with BM25 as differences in field length only apply within a
7777
single field.

260_Synonyms/10_Intro.asciidoc

+1-1
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@ Synonyms appear to be a simple concept but they are quite tricky to get right.
3232
In this chapter will will explain the mechanics of using synonyms and discuss
3333
the limitations and gotchas.
3434

35-
IMPORTANT: Synonyms are used to broaden the scope of what is considered a
35+
TIP: Synonyms are used to broaden the scope of what is considered a
3636
matching document. Just like with <<stemming,stemming>> or
3737
<<partial-matching,partial matching>>, synonym fields should not be used
3838
alone but should be combined with a query on a ``main'' field which contains

260_Synonyms/20_Using_synonyms.asciidoc

+2-2
Original file line numberDiff line numberDiff line change
@@ -66,11 +66,11 @@ Pos 5: (queen,monarch) <1>
6666
<1> All synonyms occupy the same position as the original term.
6767

6868
A document like this will match queries for any of: ``English queen'',
69-
``British queen'', ``English monarch'' or ``British monarch''.
69+
``British queen'', ``English monarch'' or ``British monarch''.
7070
Even a phrase query will work, because the position of
7171
each term has been preserved.
7272

73-
[IMPORTANT]
73+
[TIP]
7474
.Index time vs search time
7575
======================================
7676

260_Synonyms/40_Expand_contract.asciidoc

+1-1
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ In <<synonym-formats>> we have seen that it is possible to replace synonyms by
55
_simple expansion_, _simple contraction_ or _generic expansion_. We will look
66
at the tradeoffs of each of these techniques below.
77

8-
IMPORTANT: This section deals with single-word synonyms only. Multi-word
8+
TIP: This section deals with single-word synonyms only. Multi-word
99
synonyms add another layer of complexity and are discussed later in
1010
<<multi-word-synonyms>>.
1111

310_Geopoints/20_Geopoints.asciidoc

+1-1
Original file line numberDiff line numberDiff line change
@@ -63,7 +63,7 @@ PUT /attractions/restaurant/3
6363
<2> An object representation with `lat` and `lon` explicitly named.
6464
<3> An array representation with `[lon,lat]`.
6565

66-
[IMPORTANT]
66+
[CAUTION]
6767
========================
6868
6969
Everybody gets caught at least once: string geo-points are

310_Geopoints/32_Bounding_box.asciidoc

+1-1
Original file line numberDiff line numberDiff line change
@@ -97,7 +97,7 @@ GET /attractions/restaurant/_search
9797
<1> Setting the `type` parameter to `indexed` (instead of the default
9898
`memory`) tells Elasticsearch to use the inverted index for this filter.
9999

100-
IMPORTANT: While a `geo_point` field can contain multiple geo-points, the
100+
CAUTION: While a `geo_point` field can contain multiple geo-points, the
101101
`lat_lon` optimization can only be used on fields which contain a single
102102
geo-point.
103103

340_Geoshapes/74_Indexing_geo_shapes.asciidoc

+1-1
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ standard for encoding two dimensional shapes in JSON. Each shape definition
66
contains the type of shape -- `point`, `line`, `polygon`, `envelope`, etc. --
77
and one or more arrays of longitude/latitude points.
88

9-
IMPORTANT: In GeoJSON, coordinates are always written as *longitude* followed
9+
CAUTION: In GeoJSON, coordinates are always written as *longitude* followed
1010
by *latitude*.
1111

1212
For instance, we can index a polygon representing Dam Square in Amsterdam as

404_Parent_Child/45_Indexing_parent_child.asciidoc

+1-1
Original file line numberDiff line numberDiff line change
@@ -64,7 +64,7 @@ POST /company/employee/_bulk
6464
{ "name": "Adrien Grand", "dob": "1987-05-11", "hobby": "horses" }
6565
-------------------------
6666

67-
IMPORTANT: If you want to change the `parent` value of a child document, it is
67+
WARNING: If you want to change the `parent` value of a child document, it is
6868
not sufficient to just reindex or update the child document -- the new parent
6969
document may be on a different shard. Instead, you must first delete the old
7070
child, then index the new child.

410_Scaling/40_Multiple_indices.asciidoc

+1-1
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ copy (a primary or a replica) of all the shards in an index. If we issue the
77
same search request on multiple indices, the exact same thing happens -- there
88
are just more shards involved.
99

10-
IMPORTANT: Searching 1 index of 50 shards is exactly equivalent to searching
10+
TIP: Searching 1 index of 50 shards is exactly equivalent to searching
1111
50 indices with 1 shard each: both search requests hit 50 shards.
1212

1313
This can be a useful fact to remember when you need to add capacity on the

510_Deployment/40_config.asciidoc

+15-15
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ the settings alone. We have witnessed countless dozens of clusters ruined
55
by errant settings because the administrator thought they could turn a knob
66
and gain 100x improvement.
77

8-
[IMPORTANT]
8+
[NOTE]
99
====
1010
Please read this entire section! All configurations presented are equally
1111
important, and are not listed in any particular "importance" order. Please read
@@ -79,7 +79,7 @@ path.logs: /path/to/logs
7979
path.plugins: /path/to/plugins
8080
----
8181
<1> Notice that you can specify more than one directory for data using comma
82-
separated lists.
82+
separated lists.
8383

8484
Data can be saved to multiple directories, and if each of these directories
8585
are mounted on a different hard drive, this is a simple and effective way to
@@ -94,15 +94,15 @@ where two masters exist in a single cluster.
9494

9595
When you have a split-brain, your cluster is at danger of losing data. Because
9696
the master is considered the "supreme ruler" of the cluster, it decides
97-
when new indices can be created, how shards are moved, etc. If you have _two_
97+
when new indices can be created, how shards are moved, etc. If you have _two_
9898
masters, data integrity becomes perilous, since you have two different nodes
9999
that think they are in charge.
100100

101101
This setting tells Elasticsearch to not elect a master unless there are enough
102102
master-eligible nodes available. Only then will an election take place.
103103

104104
This setting should always be configured to a quorum (majority) of your master-
105-
eligible nodes. A quorum is `(number of master-eligible nodes / 2) + 1`.
105+
eligible nodes. A quorum is `(number of master-eligible nodes / 2) + 1`.
106106
Some examples:
107107

108108
- If you have ten regular nodes (can hold data, can become master), a quorum is
@@ -147,31 +147,31 @@ remove master-eligible nodes.
147147
==== Recovery settings
148148

149149
There are several settings which affect the behavior of shard recovery when
150-
your cluster restarts. First, we need to understand what happens if nothing is
150+
your cluster restarts. First, we need to understand what happens if nothing is
151151
configured.
152152

153153
Imagine you have 10 nodes, and each node holds a single shard -- either a primary
154154
or a replica -- in a 5 primary / 1 replica index. You take your
155-
entire cluster offline for maintenance (installing new drives, etc). When you
155+
entire cluster offline for maintenance (installing new drives, etc). When you
156156
restart your cluster, it just so happens that five nodes come online before
157-
the other five.
157+
the other five.
158158

159159
Maybe the switch to the other five is being flaky and they didn't
160-
receive the restart command right away. Whatever the reason, you have five nodes
161-
online. These five nodes will gossip with eachother, elect a master and form a
160+
receive the restart command right away. Whatever the reason, you have five nodes
161+
online. These five nodes will gossip with eachother, elect a master and form a
162162
cluster. They notice that data is no longer evenly distributed since five
163163
nodes are missing from the cluster, and immediately start replicating new
164164
shards between each other.
165165

166166
Finally, your other five nodes turn on and join the cluster. These nodes see
167-
that _their_ data is being replicated to other nodes, so they delete their local
167+
that _their_ data is being replicated to other nodes, so they delete their local
168168
data (since it is now redundant, and may be out-dated). Then the cluster starts
169169
to rebalance even more, since the cluster size just went from five to 10.
170170

171171
During this whole process, your nodes are thrashing the disk and network moving
172-
data around...for no good reason. For large clusters with terrabytes of data,
173-
this useless shuffling of data can take a _really long time_. If all the nodes
174-
had simply waited for the cluster to come online, all the data would have been
172+
data around...for no good reason. For large clusters with terrabytes of data,
173+
this useless shuffling of data can take a _really long time_. If all the nodes
174+
had simply waited for the cluster to come online, all the data would have been
175175
local and nothing would need to move.
176176

177177
Now that we know the problem, we can configure a few settings to alleviate it.
@@ -220,9 +220,9 @@ a few nodes on and they automatically find each other and form a cluster.
220220

221221
This ease of use is the exact reason you should disable it in production. The
222222
last thing you want is for nodes to accidentally join your production network, simply
223-
because they received an errant multicast ping. There is nothing wrong with
223+
because they received an errant multicast ping. There is nothing wrong with
224224
multicast _per-se_. Multicast simply leads to silly problems, and can be a bit
225-
more fragile (e.g. a network engineer fiddles with the network without telling
225+
more fragile (e.g. a network engineer fiddles with the network without telling
226226
you...and all of a sudden nodes can't find each other anymore).
227227

228228
In production, it is recommended to use Unicast instead of Multicast. This works

0 commit comments

Comments
 (0)