Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[DOCS] Remove and redirect frozen index overview content #72990

Merged
merged 4 commits into from
May 12, 2021
Merged

[DOCS] Remove and redirect frozen index overview content #72990

merged 4 commits into from
May 12, 2021

Conversation

jrodewig
Copy link
Contributor

@jrodewig jrodewig commented May 12, 2021

Changes:

  • Removes and adds redirects for the frozen indices overview, best practices, search, and monitoring pages.
  • Removes glossary terms related to frozen indices.
  • Updates several xrefs to point to the freeze index API docs.

Relates to #72946 and #70192.

Preview

Redirect preview: https://elasticsearch_72990.docs-preview.app.elstc.co/guide/en/elasticsearch/reference/master/frozen-indices.html

jrodewig added a commit to elastic/stack-docs that referenced this pull request May 12, 2021
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.
@jrodewig
Copy link
Contributor Author

@elasticmachine update branch

@jrodewig jrodewig changed the title [DOCS] Add redirects and deprecations for frozen indices [DOCS] Add redirects for frozen indices May 12, 2021
@jrodewig jrodewig changed the title [DOCS] Add redirects for frozen indices [DOCS] Remove and redirect frozen index overview content May 12, 2021
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
@@ -18,8 +18,7 @@ include::../glossary.asciidoc[tag=rollover-def-short]
include::../glossary.asciidoc[tag=shrink-def-short]
* **Force merge**:
include::../glossary.asciidoc[tag=force-merge-def-short]
* **Freeze**:
include::../glossary.asciidoc[tag=freeze-def-short]
* **Freeze**: Makes an index read-only and minimizes its memory footprint.
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This copy comes from the removed freeze glossary term.

@jrodewig jrodewig requested a review from danhermann May 12, 2021 15:34
@jrodewig jrodewig added :Data Management/Indices APIs APIs to create and manage indices and templates >docs General docs changes v7.13.1 v7.14.0 v8.0.0 and removed v7.13.1 labels May 12, 2021
@jrodewig jrodewig marked this pull request as ready for review May 12, 2021 15:34
@elasticmachine elasticmachine added Team:Data Management Meta label for data/management team Team:Docs Meta label for docs team labels May 12, 2021
@elasticmachine
Copy link
Collaborator

Pinging @elastic/es-core-features (Team:Core/Features)

Copy link
Contributor

@danhermann danhermann left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Overall, the changes LGTM. I do wonder if we should remove references to "minimizing memory usage" and "minimal cluster overhead" since it implies that frozen indices have a lighter footprint than regular indices when they are now, in fact, no lighter in weight than any other index.

@jrodewig
Copy link
Contributor Author

Thanks @danhermann.

I do wonder if we should remove references to "minimizing memory usage" and "minimal cluster overhead" since it implies that frozen indices have a lighter footprint than regular indices when they are now, in fact, no lighter in weight than any other index.

This is great feedback. I've push a few commits to remove those references.

@jrodewig jrodewig merged commit 8dddca7 into elastic:master May 12, 2021
@jrodewig jrodewig deleted the docs__redirect-frozen-index-docs branch May 12, 2021 16:54
jrodewig added a commit that referenced this pull request May 12, 2021
…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
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
:Data Management/Indices APIs APIs to create and manage indices and templates >docs General docs changes Team:Data Management Meta label for data/management team Team:Docs Meta label for docs team v7.14.0 v8.0.0-alpha1
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants