From 8d7392de35da6a3e312f0e9b60ceb168336fa99e Mon Sep 17 00:00:00 2001 From: James Rodewig Date: Mon, 22 Jul 2019 08:51:34 -0400 Subject: [PATCH] [DOCS] Make field datatype titles consistent (#43933) * [DOCS] Make field datatype titles consistent * Add titleabbrev for array --- docs/reference/mapping/types.asciidoc | 18 +++++++++--------- docs/reference/mapping/types/alias.asciidoc | 3 +++ docs/reference/mapping/types/binary.asciidoc | 3 +++ docs/reference/mapping/types/boolean.asciidoc | 3 +++ docs/reference/mapping/types/date.asciidoc | 3 +++ .../mapping/types/date_nanos.asciidoc | 5 ++++- .../mapping/types/dense-vector.asciidoc | 3 +++ .../reference/mapping/types/flattened.asciidoc | 3 +++ .../reference/mapping/types/geo-point.asciidoc | 3 +++ .../reference/mapping/types/geo-shape.asciidoc | 5 ++++- docs/reference/mapping/types/ip.asciidoc | 3 +++ docs/reference/mapping/types/keyword.asciidoc | 3 +++ docs/reference/mapping/types/nested.asciidoc | 3 +++ docs/reference/mapping/types/numeric.asciidoc | 3 +++ docs/reference/mapping/types/object.asciidoc | 3 +++ .../mapping/types/parent-join.asciidoc | 5 ++++- .../mapping/types/percolator.asciidoc | 3 +++ docs/reference/mapping/types/range.asciidoc | 3 +++ .../mapping/types/rank-feature.asciidoc | 3 +++ .../mapping/types/rank-features.asciidoc | 3 +++ .../mapping/types/search-as-you-type.asciidoc | 5 ++++- .../mapping/types/sparse-vector.asciidoc | 3 +++ docs/reference/mapping/types/text.asciidoc | 3 +++ .../mapping/types/token-count.asciidoc | 3 +++ 24 files changed, 82 insertions(+), 13 deletions(-) diff --git a/docs/reference/mapping/types.asciidoc b/docs/reference/mapping/types.asciidoc index 4d97e4b40aa..6794118537c 100644 --- a/docs/reference/mapping/types.asciidoc +++ b/docs/reference/mapping/types.asciidoc @@ -81,14 +81,14 @@ include::types/array.asciidoc[] include::types/binary.asciidoc[] -include::types/range.asciidoc[] - include::types/boolean.asciidoc[] include::types/date.asciidoc[] include::types/date_nanos.asciidoc[] +include::types/dense-vector.asciidoc[] + include::types/flattened.asciidoc[] include::types/geo-point.asciidoc[] @@ -97,6 +97,8 @@ include::types/geo-shape.asciidoc[] include::types/ip.asciidoc[] +include::types/parent-join.asciidoc[] + include::types/keyword.asciidoc[] include::types/nested.asciidoc[] @@ -105,20 +107,18 @@ include::types/numeric.asciidoc[] include::types/object.asciidoc[] -include::types/text.asciidoc[] - -include::types/token-count.asciidoc[] - include::types/percolator.asciidoc[] -include::types/parent-join.asciidoc[] +include::types/range.asciidoc[] include::types/rank-feature.asciidoc[] include::types/rank-features.asciidoc[] -include::types/dense-vector.asciidoc[] +include::types/search-as-you-type.asciidoc[] include::types/sparse-vector.asciidoc[] -include::types/search-as-you-type.asciidoc[] +include::types/text.asciidoc[] + +include::types/token-count.asciidoc[] \ No newline at end of file diff --git a/docs/reference/mapping/types/alias.asciidoc b/docs/reference/mapping/types/alias.asciidoc index c70d96a7e57..89229ce0bb9 100644 --- a/docs/reference/mapping/types/alias.asciidoc +++ b/docs/reference/mapping/types/alias.asciidoc @@ -1,5 +1,8 @@ [[alias]] === Alias datatype +++++ +Alias +++++ An `alias` mapping defines an alternate name for a field in the index. The alias can be used in place of the target field in <> requests, diff --git a/docs/reference/mapping/types/binary.asciidoc b/docs/reference/mapping/types/binary.asciidoc index 22e107dab56..41478d1965a 100644 --- a/docs/reference/mapping/types/binary.asciidoc +++ b/docs/reference/mapping/types/binary.asciidoc @@ -1,5 +1,8 @@ [[binary]] === Binary datatype +++++ +Binary +++++ The `binary` type accepts a binary value as a https://en.wikipedia.org/wiki/Base64[Base64] encoded string. The field is not diff --git a/docs/reference/mapping/types/boolean.asciidoc b/docs/reference/mapping/types/boolean.asciidoc index 962022060b6..790b5013d1a 100644 --- a/docs/reference/mapping/types/boolean.asciidoc +++ b/docs/reference/mapping/types/boolean.asciidoc @@ -1,5 +1,8 @@ [[boolean]] === Boolean datatype +++++ +Boolean +++++ Boolean fields accept JSON `true` and `false` values, but can also accept strings which are interpreted as either true or false: diff --git a/docs/reference/mapping/types/date.asciidoc b/docs/reference/mapping/types/date.asciidoc index 94aadb46fb2..3a5c4805846 100644 --- a/docs/reference/mapping/types/date.asciidoc +++ b/docs/reference/mapping/types/date.asciidoc @@ -1,5 +1,8 @@ [[date]] === Date datatype +++++ +Date +++++ JSON doesn't have a date datatype, so dates in Elasticsearch can either be: diff --git a/docs/reference/mapping/types/date_nanos.asciidoc b/docs/reference/mapping/types/date_nanos.asciidoc index 45d53a19b72..5fb84068bd2 100644 --- a/docs/reference/mapping/types/date_nanos.asciidoc +++ b/docs/reference/mapping/types/date_nanos.asciidoc @@ -1,5 +1,8 @@ [[date_nanos]] -=== date_nanos datatype +=== Date nanoseconds datatype +++++ +Date nanoseconds +++++ This datatype is an addition to the `date` datatype. However there is an important distinction between the two. The existing `date` datatype stores diff --git a/docs/reference/mapping/types/dense-vector.asciidoc b/docs/reference/mapping/types/dense-vector.asciidoc index 7ea04b42330..9462fe544af 100644 --- a/docs/reference/mapping/types/dense-vector.asciidoc +++ b/docs/reference/mapping/types/dense-vector.asciidoc @@ -2,6 +2,9 @@ [testenv="basic"] [[dense-vector]] === Dense vector datatype +++++ +Dense vector +++++ experimental[] diff --git a/docs/reference/mapping/types/flattened.asciidoc b/docs/reference/mapping/types/flattened.asciidoc index 80fd72c3dcc..317fd54c1a0 100644 --- a/docs/reference/mapping/types/flattened.asciidoc +++ b/docs/reference/mapping/types/flattened.asciidoc @@ -3,6 +3,9 @@ [[flattened]] === Flattened datatype +++++ +Flattened +++++ By default, each subfield in an object is mapped and indexed separately. If the names or types of the subfields are not known in advance, then they are diff --git a/docs/reference/mapping/types/geo-point.asciidoc b/docs/reference/mapping/types/geo-point.asciidoc index f890cf92f89..4c21bebc8fe 100644 --- a/docs/reference/mapping/types/geo-point.asciidoc +++ b/docs/reference/mapping/types/geo-point.asciidoc @@ -1,5 +1,8 @@ [[geo-point]] === Geo-point datatype +++++ +Geo-point +++++ Fields of type `geo_point` accept latitude-longitude pairs, which can be used: diff --git a/docs/reference/mapping/types/geo-shape.asciidoc b/docs/reference/mapping/types/geo-shape.asciidoc index be5308db41a..0fd370ec4e8 100644 --- a/docs/reference/mapping/types/geo-shape.asciidoc +++ b/docs/reference/mapping/types/geo-shape.asciidoc @@ -1,5 +1,8 @@ [[geo-shape]] -=== Geo-Shape datatype +=== Geo-shape datatype +++++ +Geo-shape +++++ The `geo_shape` datatype facilitates the indexing of and searching with arbitrary geo shapes such as rectangles and polygons. It should be diff --git a/docs/reference/mapping/types/ip.asciidoc b/docs/reference/mapping/types/ip.asciidoc index 46ca444c955..a1a56cf69fd 100644 --- a/docs/reference/mapping/types/ip.asciidoc +++ b/docs/reference/mapping/types/ip.asciidoc @@ -1,5 +1,8 @@ [[ip]] === IP datatype +++++ +IP +++++ An `ip` field can index/store either https://en.wikipedia.org/wiki/IPv4[IPv4] or https://en.wikipedia.org/wiki/IPv6[IPv6] addresses. diff --git a/docs/reference/mapping/types/keyword.asciidoc b/docs/reference/mapping/types/keyword.asciidoc index 8ac0983dc95..61a603b4f2d 100644 --- a/docs/reference/mapping/types/keyword.asciidoc +++ b/docs/reference/mapping/types/keyword.asciidoc @@ -1,5 +1,8 @@ [[keyword]] === Keyword datatype +++++ +Keyword +++++ A field to index structured content such as email addresses, hostnames, status codes, zip codes or tags. diff --git a/docs/reference/mapping/types/nested.asciidoc b/docs/reference/mapping/types/nested.asciidoc index 1f9ad2e2d2c..3113e86599c 100644 --- a/docs/reference/mapping/types/nested.asciidoc +++ b/docs/reference/mapping/types/nested.asciidoc @@ -1,5 +1,8 @@ [[nested]] === Nested datatype +++++ +Nested +++++ The `nested` type is a specialised version of the <> datatype that allows arrays of objects to be indexed in a way that they can be queried diff --git a/docs/reference/mapping/types/numeric.asciidoc b/docs/reference/mapping/types/numeric.asciidoc index f2977957ff4..7298b54873b 100644 --- a/docs/reference/mapping/types/numeric.asciidoc +++ b/docs/reference/mapping/types/numeric.asciidoc @@ -1,5 +1,8 @@ [[number]] === Numeric datatypes +++++ +Numeric +++++ The following numeric types are supported: diff --git a/docs/reference/mapping/types/object.asciidoc b/docs/reference/mapping/types/object.asciidoc index f5b9a9df856..e127415c618 100644 --- a/docs/reference/mapping/types/object.asciidoc +++ b/docs/reference/mapping/types/object.asciidoc @@ -1,5 +1,8 @@ [[object]] === Object datatype +++++ +Object +++++ JSON documents are hierarchical in nature: the document may contain inner objects which, in turn, may contain inner objects themselves: diff --git a/docs/reference/mapping/types/parent-join.asciidoc b/docs/reference/mapping/types/parent-join.asciidoc index 39bcaa96d77..14c7b7b2758 100644 --- a/docs/reference/mapping/types/parent-join.asciidoc +++ b/docs/reference/mapping/types/parent-join.asciidoc @@ -1,5 +1,8 @@ [[parent-join]] -=== `join` datatype +=== Join datatype +++++ +Join +++++ The `join` datatype is a special field that creates parent/child relation within documents of the same index. diff --git a/docs/reference/mapping/types/percolator.asciidoc b/docs/reference/mapping/types/percolator.asciidoc index 00270fff385..cdc10bcaa03 100644 --- a/docs/reference/mapping/types/percolator.asciidoc +++ b/docs/reference/mapping/types/percolator.asciidoc @@ -1,5 +1,8 @@ [[percolator]] === Percolator type +++++ +Percolator +++++ The `percolator` field type parses a json structure into a native query and stores that query, so that the <> diff --git a/docs/reference/mapping/types/range.asciidoc b/docs/reference/mapping/types/range.asciidoc index 79c9e6629c6..91bbbd0d6d0 100644 --- a/docs/reference/mapping/types/range.asciidoc +++ b/docs/reference/mapping/types/range.asciidoc @@ -1,5 +1,8 @@ [[range]] === Range datatypes +++++ +Range +++++ The following range types are supported: diff --git a/docs/reference/mapping/types/rank-feature.asciidoc b/docs/reference/mapping/types/rank-feature.asciidoc index 780a68216f4..d066d0452d3 100644 --- a/docs/reference/mapping/types/rank-feature.asciidoc +++ b/docs/reference/mapping/types/rank-feature.asciidoc @@ -1,5 +1,8 @@ [[rank-feature]] === Rank feature datatype +++++ +Rank feature +++++ A `rank_feature` field can index numbers so that they can later be used to boost documents in queries with a <> query. diff --git a/docs/reference/mapping/types/rank-features.asciidoc b/docs/reference/mapping/types/rank-features.asciidoc index 9bc960b7f83..b80db43651d 100644 --- a/docs/reference/mapping/types/rank-features.asciidoc +++ b/docs/reference/mapping/types/rank-features.asciidoc @@ -1,5 +1,8 @@ [[rank-features]] === Rank features datatype +++++ +Rank features +++++ A `rank_features` field can index numeric feature vectors, so that they can later be used to boost documents in queries with a diff --git a/docs/reference/mapping/types/search-as-you-type.asciidoc b/docs/reference/mapping/types/search-as-you-type.asciidoc index 7ddc4f12fad..21a1a46cf8c 100644 --- a/docs/reference/mapping/types/search-as-you-type.asciidoc +++ b/docs/reference/mapping/types/search-as-you-type.asciidoc @@ -1,5 +1,8 @@ [[search-as-you-type]] -=== Search as you type datatype +=== Search-as-you-type datatype +++++ +Search-as-you-type +++++ The `search_as_you_type` field type is a text-like field that is optimized to provide out-of-the-box support for queries that serve an as-you-type completion diff --git a/docs/reference/mapping/types/sparse-vector.asciidoc b/docs/reference/mapping/types/sparse-vector.asciidoc index de63a1a822a..7b437031513 100644 --- a/docs/reference/mapping/types/sparse-vector.asciidoc +++ b/docs/reference/mapping/types/sparse-vector.asciidoc @@ -2,6 +2,9 @@ [testenv="basic"] [[sparse-vector]] === Sparse vector datatype +++++ +Sparse vector +++++ experimental[] diff --git a/docs/reference/mapping/types/text.asciidoc b/docs/reference/mapping/types/text.asciidoc index 8ddecd88d08..46477972d5c 100644 --- a/docs/reference/mapping/types/text.asciidoc +++ b/docs/reference/mapping/types/text.asciidoc @@ -1,5 +1,8 @@ [[text]] === Text datatype +++++ +Text +++++ A field to index full-text values, such as the body of an email or the description of a product. These fields are `analyzed`, that is they are passed through an diff --git a/docs/reference/mapping/types/token-count.asciidoc b/docs/reference/mapping/types/token-count.asciidoc index d574c25e93d..a435be1e54d 100644 --- a/docs/reference/mapping/types/token-count.asciidoc +++ b/docs/reference/mapping/types/token-count.asciidoc @@ -1,5 +1,8 @@ [[token-count]] === Token count datatype +++++ +Token count +++++ A field of type `token_count` is really an <> field which accepts string values, analyzes them, then indexes the number of tokens in the