[DOCS] Mark freeze API as deprecated #72946
Conversation
danhermann
added
>docs
elasticmachine
added
Team:Data Management
|
Pinging @elastic/es-core-features (Team:Core/Features) |
|
Pinging @elastic/es-docs (Team:Docs) |
There was a problem hiding this comment.
LGTM.
We'll also need to figure out how to handle the frozen indices overview + best practices:
https://elasticsearch_72946.docs-preview.app.elstc.co/guide/en/elasticsearch/reference/master/frozen-indices.html
We can likely just remove them and add redirects. I can handle that as a separate PR, but let me know your thoughts!
| @@ -6,6 +6,8 @@ | |||
| <titleabbrev>Freeze index</titleabbrev> | |||
| ++++ | |||
|
|
|||
| deprecated::[8.0, Frozen indices are no longer useful due to https://www.elastic.co/blog/significantly-decrease-your-elasticsearch-heap-memory-usage[recent improvements in heap memory utilization]] | |||
There was a problem hiding this comment.
Nits: I think the deprecation release is actually 7.14. I'd also use usage instead of utilization. Adds a period.
| deprecated::[8.0, Frozen indices are no longer useful due to https://www.elastic.co/blog/significantly-decrease-your-elasticsearch-heap-memory-usage[recent improvements in heap memory utilization]] | |
| deprecated::[7.14, Frozen indices are no longer useful due to https://www.elastic.co/blog/significantly-decrease-your-elasticsearch-heap-memory-usage[recent improvements in heap memory usage].] |
|
Thanks, @jrodewig!
That sounds good to me.
The deprecation release is 7.14. I know that for version references in code, we update that after backporting, but is it different for docs? |
That's typically true in the docs too, but deprecation notes are an exception. The version in the deprecation admon is the release in which we first deprecated the feature. |
elastic/elasticsearch#72946 marks the freeze API as deprecated. This removes a couple of glossary terms related to frozen indices. Relates to elastic/elasticsearch#72990.
Changes: * Removes and adds redirects for the frozen indices [overview][0], [best practices][1], [search][2], and [monitoring][3] pages. * Removes glossary terms related to frozen indices. * Updates several xrefs to point to the freeze index API docs. Relates to #72946 and #70192. [0]: https://www.elastic.co/guide/en/elasticsearch/reference/7.12/frozen-indices.html [1]: https://www.elastic.co/guide/en/elasticsearch/reference/master/best_practices.html [2]: https://www.elastic.co/guide/en/elasticsearch/reference/master/searching_a_frozen_index.html [3]: https://www.elastic.co/guide/en/elasticsearch/reference/master/monitoring_frozen_indices.html
…3001) Changes: * Removes and adds redirects for the frozen indices [overview][0], [best practices][1], [search][2], and [monitoring][3] pages. * Removes glossary terms related to frozen indices. * Updates several xrefs to point to the freeze index API docs. Relates to #72946 and #70192. [0]: https://www.elastic.co/guide/en/elasticsearch/reference/7.12/frozen-indices.html [1]: https://www.elastic.co/guide/en/elasticsearch/reference/master/best_practices.html [2]: https://www.elastic.co/guide/en/elasticsearch/reference/master/searching_a_frozen_index.html [3]: https://www.elastic.co/guide/en/elasticsearch/reference/master/monitoring_frozen_indices.html
Changes: * Removes and adds redirects for the frozen indices [overview][0], [best practices][1], [search][2], and [monitoring][3] pages. * Removes glossary terms related to frozen indices. * Updates several xrefs to point to the freeze index API docs. Relates to elastic/elasticsearch#72946 and elastic/elasticsearch#70192. [0]: https://www.elastic.co/guide/en/elasticsearch/reference/7.12/frozen-indices.html [1]: https://www.elastic.co/guide/en/elasticsearch/reference/master/best_practices.html [2]: https://www.elastic.co/guide/en/elasticsearch/reference/master/searching_a_frozen_index.html [3]: https://www.elastic.co/guide/en/elasticsearch/reference/master/monitoring_frozen_indices.html
Relates to #70192
Preview: https://elasticsearch_72946.docs-preview.app.elstc.co/guide/en/elasticsearch/reference/master/freeze-index-api.html