Skip to content

Commit cb6455f

Browse files
Add a sentence to the docs explaining what frozen indices were - otherwise, everything will point to the message about the unfreeze API having gone away, which is not very helpful
1 parent 0b8f928 commit cb6455f

File tree

1 file changed

+6
-9
lines changed

1 file changed

+6
-9
lines changed

docs/reference/redirects.asciidoc

Lines changed: 6 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -156,8 +156,8 @@ 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

163163
[role="exclude",id="unfreeze-index-api"]
@@ -1755,13 +1755,10 @@ See <<search-terms-enum>>.
17551755
=== Frozen indices
17561756

17571757
// tag::frozen-index-redirect[]
1758-
1759-
// TODO(pete): Figure out what to do here. I don't think anything links here from main. But I guess users could get here
1760-
// from link in old versions. Linking from here to the thing saying that the API isn't much use. Maybe we need a
1761-
// sentence about what the feature was? And maybe the other places which currently point to unfreeze-index-api should
1762-
// point here instead?
1763-
1764-
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.
17651762
// end::frozen-index-redirect[]
17661763

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

0 commit comments

Comments
 (0)