Skip to content

Commit b172db5

Browse files
authored
Prepare synthetic source docs for tech-preview (#89358) (#89392)
Now that we're releasing synthetic _source as a tech preview feature, we no longer want to remove the docs from the non-release builds. And we want to mark all of the headings describing synthetic `_source` as a preview.
1 parent 3922ff2 commit b172db5

File tree

8 files changed

+7
-25
lines changed

8 files changed

+7
-25
lines changed

docs/reference/mapping/fields/source-field.asciidoc

Lines changed: 0 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -6,16 +6,13 @@ at index time. The `_source` field itself is not indexed (and thus is not
66
searchable), but it is stored so that it can be returned when executing
77
_fetch_ requests, like <<docs-get,get>> or <<search-search,search>>.
88

9-
ifeval::["{release-state}"=="unreleased"]
109
If disk usage is important to you then have a look at
1110
<<synthetic-source,synthetic `_source`>> which shrinks disk usage at the cost of
1211
only supporting a subset of mappings and slower fetches or (not recommended)
1312
<<disable-source-field,disabling the `_source` field>> which also shrinks disk
1413
usage but disables many features.
1514

1615
include::synthetic-source.asciidoc[]
17-
endif::[]
18-
1916

2017
[[disable-source-field]]
2118
==== Disabling the `_source` field

docs/reference/mapping/fields/synthetic-source.asciidoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
[[synthetic-source]]
2-
==== Synthetic `_source`
2+
==== Synthetic `_source` preview:[]
33

44
Though very handy to have around, the source field takes up a significant amount
55
of space on disk. Instead of storing source documents on disk exactly as you

docs/reference/mapping/types/boolean.asciidoc

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -215,9 +215,8 @@ The following parameters are accepted by `boolean` fields:
215215

216216
Metadata about the field.
217217

218-
ifeval::["{release-state}"=="unreleased"]
219218
[[boolean-synthetic-source]]
220-
==== Synthetic source
219+
==== Synthetic source preview:[]
221220
`boolean` fields support <<synthetic-source,synthetic `_source`>> in their
222221
default configuration. Synthetic `_source` cannot be used together with
223222
<<copy-to,`copy_to`>> or with <<doc-values,`doc_values`>> disabled.
@@ -249,4 +248,3 @@ Will become:
249248
}
250249
----
251250
// TEST[s/^/{"_source":/ s/\n$/}/]
252-
endif::[]

docs/reference/mapping/types/geo-point.asciidoc

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -204,9 +204,8 @@ def lat = doc['location'].lat;
204204
def lon = doc['location'].lon;
205205
--------------------------------------------------
206206

207-
ifeval::["{release-state}"=="unreleased"]
208207
[[geo-point-synthetic-source]]
209-
==== Synthetic source
208+
==== Synthetic source preview:[]
210209
`geo_point` fields support <<synthetic-source,synthetic `_source`>> in their
211210
default configuration. Synthetic `_source` cannot be used together with
212211
<<ignore-malformed,`ignore_malformed`>>, <<copy-to,`copy_to`>>, or with
@@ -246,4 +245,3 @@ Will become:
246245
}
247246
----
248247
// TEST[s/^/{"_source":/ s/\n$/}/]
249-
endif::[]

docs/reference/mapping/types/ip.asciidoc

Lines changed: 1 addition & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -151,9 +151,8 @@ GET my-index-000001/_search
151151
}
152152
--------------------------------------------------
153153

154-
ifeval::["{release-state}"=="unreleased"]
155154
[[ip-synthetic-source]]
156-
==== Synthetic source
155+
==== Synthetic source preview:[]
157156
`ip` fields support <<synthetic-source,synthetic `_source`>> in their default
158157
configuration. Synthetic `_source` cannot be used together with
159158
<<ignore-malformed,`ignore_malformed`>>, <<copy-to,`copy_to`>>, or with
@@ -192,5 +191,3 @@ Will become:
192191
NOTE: IPv4 addresses are sorted as though they were IPv6 addresses prefixed by
193192
`::ffff:0:0:0/96` as specified by
194193
https://datatracker.ietf.org/doc/html/rfc6144[rfc6144].
195-
196-
endif::[]

docs/reference/mapping/types/keyword.asciidoc

Lines changed: 1 addition & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -174,9 +174,8 @@ Dimension fields have the following constraints:
174174
* The field cannot use a <<normalizer,`normalizer`>>.
175175
--
176176

177-
ifeval::["{release-state}"=="unreleased"]
178177
[[keyword-synthetic-source]]
179-
==== Synthetic source
178+
==== Synthetic source preview:[]
180179
`keyword` fields support <<synthetic-source,synthetic `_source`>> in their
181180
default configuration. Synthetic `_source` cannot be used together with
182181
<<ignore-above,`ignore_above`>>, a <<normalizer,`normalizer`>>,
@@ -212,8 +211,6 @@ Will become:
212211
----
213212
// TEST[s/^/{"_source":/ s/\n$/}/]
214213

215-
endif::[]
216-
217214
include::constant-keyword.asciidoc[]
218215

219216
include::wildcard.asciidoc[]

docs/reference/mapping/types/numeric.asciidoc

Lines changed: 1 addition & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -229,9 +229,8 @@ endif::[]
229229
of `scaling_factor` improve accuracy but also increase space requirements.
230230
This parameter is required.
231231

232-
ifeval::["{release-state}"=="unreleased"]
233232
[[numeric-synthetic-source]]
234-
==== Synthetic source
233+
==== Synthetic source preview:[]
235234
All numeric fields except `unsigned_long` support <<synthetic-source,synthetic
236235
`_source`>> in their default configuration. Synthetic `_source` cannot be used
237236
together with <<ignore-malformed,`ignore_malformed`>>, <<copy-to,`copy_to`>>, or
@@ -293,5 +292,3 @@ Will become:
293292
}
294293
----
295294
// TEST[s/^/{"_source":/ s/\n$/}/]
296-
297-
endif::[]

docs/reference/mapping/types/text.asciidoc

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -159,9 +159,8 @@ The following parameters are accepted by `text` fields:
159159

160160
Metadata about the field.
161161

162-
ifeval::["{release-state}"=="unreleased"]
163162
[[text-synthetic-source]]
164-
==== Synthetic source
163+
==== Synthetic source preview:[]
165164
`text` fields support <<synthetic-source,synthetic `_source`>> if they have
166165
a `keyword` sub-field that supports synthetic `_source` and *do not* have
167166
<<copy-to,`copy_to`>>.
@@ -214,7 +213,6 @@ NOTE: Reordering text fields can have an effect on <<query-dsl-match-query-phras
214213
<<position-increment-gap,`position_increment_gap`>> for more detail. You
215214
can avoid this by making sure the `slop` parameter on the phrase queries
216215
is lower than the `position_increment_gap`. This is the default.
217-
endif::[]
218216

219217
[[fielddata-mapping-param]]
220218
==== `fielddata` mapping parameter

0 commit comments

Comments
 (0)