Skip to content

Commit e1b96e6

Browse files
Remove asciidocs
This adds a sentence to `redirects.asciidoc` explaining what frozen indices were - otherwise, everything will point to the message about the unfreeze API having gone away, which is not very helpful. Some cross-references are updated to point to this rather than to the notice about the removal of the unfreeze API.
1 parent e1f11c0 commit e1b96e6

File tree

5 files changed

+14
-69
lines changed

5 files changed

+14
-69
lines changed

docs/reference/indices.asciidoc

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,6 @@ index settings, aliases, mappings, and index templates.
2424
* <<indices-split-index>>
2525
* <<indices-clone-index>>
2626
* <<indices-rollover-index>>
27-
* <<unfreeze-index-api>>
2827
* <<indices-resolve-index-api>>
2928
* <<indices-resolve-cluster-api>>
3029
* <<indices-downsample-data-stream>>
@@ -143,6 +142,5 @@ include::indices/shrink-index.asciidoc[]
143142
include::indices/simulate-index.asciidoc[]
144143
include::indices/simulate-template.asciidoc[]
145144
include::indices/split-index.asciidoc[]
146-
include::indices/apis/unfreeze.asciidoc[]
147145
include::indices/update-settings.asciidoc[]
148146
include::indices/put-mapping.asciidoc[]

docs/reference/indices/apis/unfreeze.asciidoc

Lines changed: 0 additions & 61 deletions
This file was deleted.

docs/reference/indices/index-mgmt.asciidoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -43,7 +43,7 @@ For more information on managing indices, refer to <<indices, Index APIs>>.
4343

4444
* To filter the list of indices, use the search bar or click a badge.
4545
Badges indicate if an index is a <<ccr-put-follow,follower index>>, a
46-
<<rollup-get-rollup-index-caps,rollup index>>, or <<unfreeze-index-api,frozen>>.
46+
<<rollup-get-rollup-index-caps,rollup index>>, or <<frozen-indices,frozen>>.
4747

4848
* To drill down into the index
4949
<<mapping,mappings>>, <<index-modules-settings,settings>>, and statistics,

docs/reference/redirects.asciidoc

Lines changed: 12 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -156,10 +156,16 @@ See <<restore-entire-cluster>>.
156156
The freeze index API was removed in 8.0.
157157
// tag::frozen-removal-explanation[]
158158
Frozen indices are no longer useful due to
159-
https://www.elastic.co/blog/significantly-decrease-your-elasticsearch-heap-memory-usage[recent
160-
improvements in heap memory usage].
159+
https://www.elastic.co/blog/significantly-decrease-your-elasticsearch-heap-memory-usage[improvements
160+
in heap memory usage].
161161
// end::frozen-removal-explanation[]
162162

163+
[role="exclude",id="unfreeze-index-api"]
164+
=== Unfreeze index API
165+
166+
The unfreeze index API was removed in 9.0.
167+
include::redirects.asciidoc[tag=frozen-removal-explanation]
168+
163169
[role="exclude",id="ilm-freeze"]
164170
=== Freeze {ilm-init} action
165171

@@ -1749,8 +1755,10 @@ See <<search-terms-enum>>.
17491755
=== Frozen indices
17501756

17511757
// tag::frozen-index-redirect[]
1752-
1753-
For API documentation, see <<unfreeze-index-api>>.
1758+
Older versions of {es} provided the option to reduce the amount of data kept in memory for an index, at the expense of
1759+
increasing search latency. This was known as 'freezing' the index.
1760+
include::redirects.asciidoc[tag=frozen-removal-explanation]
1761+
The freeze index API was removed in 8.0, and the unfreeze index API was removed in 9.0.
17541762
// end::frozen-index-redirect[]
17551763

17561764
[role="exclude",id="best_practices"]

docs/reference/sql/language/indices.asciidoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -100,7 +100,7 @@ requires the keyword `LIKE` for SQL `LIKE` pattern.
100100
[[sql-index-frozen]]
101101
=== Frozen Indices
102102

103-
By default, {es-sql} doesn't search <<unfreeze-index-api,frozen indices>>. To
103+
By default, {es-sql} doesn't search <<frozen-indices,frozen indices>>. To
104104
search frozen indices, use one of the following features:
105105

106106
dedicated configuration parameter::

0 commit comments

Comments
 (0)