[DOCS] various docs fixes

Removed unused misc.asciidoc file
Added plugins directory to directory layout
Fixed transport.tcp.connect_timeout value to match the code found in NetworkService.TcpSettings
Clarified that phrase query does not preserve order of terms
Clarified merge page
Added instructions on how to build documentation to docs/README
This commit is contained in:
Brusic 2014-01-19 12:29:08 -08:00 committed by Luca Cavanna
parent ed4b15fb4c
commit d9b71a8083
6 changed files with 14 additions and 18 deletions

4
docs/README.md Normal file
View File

@ -0,0 +1,4 @@
The Elasticsearch docs are in AsciiDoc format and can be built using the Elasticsearch documentation build process
See: https://github.com/elasticsearch/docs

View File

@ -7,13 +7,11 @@ where the index data is stored, and are immutable up to delete markers.
Segments are, periodically, merged into larger segments to keep the
index size at bay and expunge deletes.
The more segments one has in the Lucene index mean slower searches and
more memory used, but, low number of segments means more merging that
has to go on.
The more segments one has in the Lucene index means slower searches and
more memory used. Segment merging is used to reduce the number of segments,
however merges can be expensive to perform, especially on low IO environments.
Merges can be throttled using <<store-throttling,store level throttling>>.
Since merges can be expensive to perform, especially on low IO
environments, they can be throttled using store level throttling. Read
the store module documentation on how to set it.
[float]
[[policy]]
@ -69,7 +67,7 @@ This policy has the following settings:
Sets the allowed number of segments per tier. Smaller values mean more
merging but fewer segments. Default is `10`. Note, this value needs to be
>= then the `max_merge_at_once_` otherwise you'll force too many merges to
>= then the `max_merge_at_once` otherwise you'll force too many merges to
occur.
`index.reclaim_deletes_weight`::

View File

@ -1,8 +0,0 @@
[[mapping-misc]]
== Miscellaneous
include::mapping/date-format.asciidoc[]
include::mapping/conf-mappings.asciidoc[]
include::mapping/meta.asciidoc[]

View File

@ -32,7 +32,7 @@ addressable from the outside. Defaults to the actual port assigned via
`transport.tcp.port`.
|`transport.tcp.connect_timeout` |The socket connect timeout setting (in
time setting format). Defaults to `2s`.
time setting format). Defaults to `30s`.
|`transport.tcp.compress` |Set to `true` to enable compression (LZF)
between all nodes. Defaults to `false`.

View File

@ -149,8 +149,8 @@ used in the following manner:
}
--------------------------------------------------
A phrase query maintains order of the terms up to a configurable `slop`
(which defaults to 0).
A phrase query matches terms up to a configurable `slop`
(which defaults to 0) in any order. Transposed terms have a slop of 2.
The `analyzer` can be set to control which analyzer will perform the
analysis process on the text. It default to the field explicit mapping

View File

@ -18,6 +18,8 @@ on the node. Can hold multiple locations. |`{path.home}/data`|`path.data`
|*work* |Temporal files that are used by different nodes. |`{path.home}/work` |`path.work`
|*logs* |Log files location |`{path.home}/logs` |`path.logs`
|*plugins* |Plugin files location. Each plugin will be contained in a subdirectory. |`{path.home}/plugins` |`path.plugins`
|=======================================================================
The multiple data locations allows to stripe it. The striping is simple,