From d9b71a8083fb4cc2cd8742d84e15e56ef9689168 Mon Sep 17 00:00:00 2001 From: Brusic Date: Sun, 19 Jan 2014 12:29:08 -0800 Subject: [PATCH] [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 --- docs/README.md | 4 ++++ docs/reference/index-modules/merge.asciidoc | 12 +++++------- docs/reference/mapping/misc.asciidoc | 8 -------- docs/reference/modules/transport.asciidoc | 2 +- .../reference/query-dsl/queries/match-query.asciidoc | 4 ++-- docs/reference/setup/dir-layout.asciidoc | 2 ++ 6 files changed, 14 insertions(+), 18 deletions(-) create mode 100644 docs/README.md delete mode 100644 docs/reference/mapping/misc.asciidoc diff --git a/docs/README.md b/docs/README.md new file mode 100644 index 00000000000..fa61e5abddc --- /dev/null +++ b/docs/README.md @@ -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 + diff --git a/docs/reference/index-modules/merge.asciidoc b/docs/reference/index-modules/merge.asciidoc index 61b29f11b27..84d2675ffe6 100644 --- a/docs/reference/index-modules/merge.asciidoc +++ b/docs/reference/index-modules/merge.asciidoc @@ -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 <>. -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`:: diff --git a/docs/reference/mapping/misc.asciidoc b/docs/reference/mapping/misc.asciidoc deleted file mode 100644 index 5b4a443aaae..00000000000 --- a/docs/reference/mapping/misc.asciidoc +++ /dev/null @@ -1,8 +0,0 @@ -[[mapping-misc]] -== Miscellaneous - -include::mapping/date-format.asciidoc[] - -include::mapping/conf-mappings.asciidoc[] - -include::mapping/meta.asciidoc[] diff --git a/docs/reference/modules/transport.asciidoc b/docs/reference/modules/transport.asciidoc index 1dcd5134dae..62fe6d0c715 100644 --- a/docs/reference/modules/transport.asciidoc +++ b/docs/reference/modules/transport.asciidoc @@ -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`. diff --git a/docs/reference/query-dsl/queries/match-query.asciidoc b/docs/reference/query-dsl/queries/match-query.asciidoc index 2bf8c8dff78..d514768bd2a 100644 --- a/docs/reference/query-dsl/queries/match-query.asciidoc +++ b/docs/reference/query-dsl/queries/match-query.asciidoc @@ -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 diff --git a/docs/reference/setup/dir-layout.asciidoc b/docs/reference/setup/dir-layout.asciidoc index 86e8e63ae8c..2971c45e568 100644 --- a/docs/reference/setup/dir-layout.asciidoc +++ b/docs/reference/setup/dir-layout.asciidoc @@ -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,