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

Updated tutorial text #117940

Closed
wants to merge 5 commits into from
Closed

Updated tutorial text #117940

wants to merge 5 commits into from

Conversation

satyyam11
Copy link
Contributor

This PR updates the Elasticsearch ILM tutorial to make things clearer and easier to follow.
I’ve cleaned up the steps for customizing ILM policies, explained the rollover, warm, and delete phases a bit more, and made sure everything’s easy to understand.
Basically, it's to help people better manage their ILM policies based on their needs, without all the confusion.

Copy link

cla-checker-service bot commented Dec 3, 2024

💚 CLA has been signed

Copy link
Contributor

github-actions bot commented Dec 3, 2024

Documentation preview:

@elasticsearchmachine elasticsearchmachine added v9.0.0 external-contributor Pull request authored by a developer outside the Elasticsearch team needs:triage Requires assignment of a team area label labels Dec 3, 2024
@satyyam11
Copy link
Contributor Author

I signed the document now what

@satyyam11
Copy link
Contributor Author

Shalll I raise a PR for image change as well?

@PeteGillinElastic PeteGillinElastic added :Data Management/ILM+SLM Index and Snapshot lifecycle management and removed needs:triage Requires assignment of a team area label labels Dec 5, 2024
@elasticsearchmachine elasticsearchmachine added the Team:Data Management Meta label for data/management team label Dec 5, 2024
@elasticsearchmachine
Copy link
Collaborator

Pinging @elastic/es-data-management (Team:Data Management)

@dakrone dakrone self-requested a review December 6, 2024 01:48
@dakrone dakrone self-assigned this Dec 6, 2024
@dakrone dakrone added the >docs General docs changes label Dec 6, 2024
@elasticsearchmachine elasticsearchmachine added the Team:Docs Meta label for docs team label Dec 6, 2024
@elasticsearchmachine
Copy link
Collaborator

Pinging @elastic/es-docs (Team:Docs)

Copy link
Member

@dakrone dakrone left a comment

Choose a reason for hiding this comment

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

Thanks for working on this @satyyam11, but we need to update the images as part of this PR in addition to changing the text. Could you make those image updates as well?

Elastic Stack deployments on {ess} include a hot tier by default. To add a warm
tier, edit your deployment and click **Add capacity** for the warm data tier.
+
Elastic Stack deployments on {ess} automatically include hot and warm tiers. If needed, you can add additional warm capacity by editing your deployment and selecting **Add capacity** for the warm data tier.
Copy link
Member

Choose a reason for hiding this comment

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

They do not automatically include a warm tier. They include a hot and content tier.

Suggested change
Elastic Stack deployments on {ess} automatically include hot and warm tiers. If needed, you can add additional warm capacity by editing your deployment and selecting **Add capacity** for the warm data tier.
Elastic Stack deployments on {ess} automatically include hot and content tiers. If needed, you can add additional warm capacity by editing your deployment and selecting **Add capacity** for the warm data tier.

[role="screenshot"]
image::images/ilm/tutorial-ilm-ess-add-warm-data-tier.png[Add a warm data tier to your deployment]
image::images/ilm/tutorial-ilm-add-warm-data-tier.png[Add a warm data tier to your deployment]
Copy link
Member

Choose a reason for hiding this comment

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

Is there a reason you changed this image link? As part of this the pngs should be updated to show the newer UI.

Comment on lines -90 to +87
phase. Then disable **Use recommended defaults** to display the rollover
settings.
phase. Adjust the **Minimum primary shard size** and other rollover settings as needed.
Copy link
Member

Choose a reason for hiding this comment

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

A user will still need to uncheck the "Use recommended defaults" right?


[role="screenshot"]
image::images/ilm/tutorial-ilm-hotphaserollover-default.png[View rollover defaults]
image::images/ilm/tutorial-ilm-hotphaserollover-new.png[View rollover defaults]
Copy link
Member

Choose a reason for hiding this comment

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

This image doesn't exist, do you need to add it to git so it's committed for this PR?

Comment on lines +101 to +102
+
--
Copy link
Member

Choose a reason for hiding this comment

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

There is a lot of unnecessary whitespace changes in this file, can you undo those?

@satyyam11
Copy link
Contributor Author

Any updates?

@leemthompo
Copy link
Contributor

This should be closed because it's been superseded by #118148

@leemthompo leemthompo closed this Dec 13, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
:Data Management/ILM+SLM Index and Snapshot lifecycle management >docs General docs changes external-contributor Pull request authored by a developer outside the Elasticsearch team Team:Data Management Meta label for data/management team Team:Docs Meta label for docs team v9.0.0
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants