-
Notifications
You must be signed in to change notification settings - Fork 25.2k
[DOCS] Combo version of ILM docs. #57909
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
Conversation
* [DOCS] Adds documentation for index lifecycle policies * [DOCS] Updated image for policy options to show all menu items * Update create-policy.asciidoc * [DOCS] Incorporated review comments on hot and warm phase * [DOCS] Additional changes to warm phase * [DOCS] Removed the word open in the warm phase
* Add tutorial for ILM with filebeat * Change screenshots and add additional steps * Update screenshots, add numbered steps, and other minor edits * Incorporate feedback: update links, formatting, and minor edits * Move tip inline with list * Apply suggestions from code review Co-Authored-By: James Rodewig <[email protected]> * Move TIP inline . . . again * Put TIP inline Co-authored-by: James Rodewig <[email protected]>
* [DOCS] Updates for navigation redesign * Getting started * Set up text * Discover * Dashboard, Graph, ML, Maps, APM, SIEM, Dev tools * Dev Tools, Stack Monitoring, Management * Management * Final changes * [DOCS] Updates for navigation redesign * [DOCS] Updates CCR monitoring screenshots * updates SIEM screenshot and Cases overview text * Added Brandon's APM image * [DOCS] Refines CCR shard screenshot * Removed merge conflict image file Co-authored-by: lcawl <[email protected]> Co-authored-by: Ben Skelker <[email protected]>
@elasticmachine retest this please |
Pinging @elastic/es-core-features (:Core/Features/ILM+SLM) |
Pinging @elastic/es-docs (>docs) |
@debadair I don't understand, why do we have the same tutorial duplicated in two places? Is there no way to link or refer to it? I'm concerned that since it's duplicated it means a higher chance of the two diverging at some point in the future |
It's temporary. It will be removed from the Kibana guide/repo & maintained here going forward. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
It looks like these two files are nearly identical:
docs/management/index-lifecycle-policies/example-index-lifecycle-policy.asciidoc
docs/reference/ilm/example-index-lifecycle-policy.asciidoc
I didn't notice until later in my review, but it looks like only docs/reference/ilm/example-index-lifecycle-policy.asciidoc
is actually rendering. Please copy any of my applicable comments over.
Broader food for thought:
-
This PRs adds a decent number of PNG images. If we take this strategy forward, I imagine that number will grow. However, from what I understand, storing binary files in GitHub generally isn't good practice and can lead to bandwidth suffering as the repo grows and images change. It may be worth considering a workaround for that.
-
We don't indicate to the user that we expect Kibana to be installed or point them to a place where they can do that. While it may not be worth doing on every tutorial, we may want to add a note somewhere to indicate that the docs expect the user to have Kibana running.
docs/management/index-lifecycle-policies/example-index-lifecycle-policy.asciidoc
Outdated
Show resolved
Hide resolved
docs/management/index-lifecycle-policies/example-index-lifecycle-policy.asciidoc
Outdated
Show resolved
Hide resolved
docs/management/index-lifecycle-policies/example-index-lifecycle-policy.asciidoc
Outdated
Show resolved
Hide resolved
docs/management/index-lifecycle-policies/example-index-lifecycle-policy.asciidoc
Outdated
Show resolved
Hide resolved
docs/management/index-lifecycle-policies/example-index-lifecycle-policy.asciidoc
Outdated
Show resolved
Hide resolved
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I like how the Kibana UIs were included in the docs.
In overview-index-lifecycle-management , the formatting of Rollover bullet needs fixing.
docs/management/index-lifecycle-policies/example-index-lifecycle-policy.asciidoc
Outdated
Show resolved
Hide resolved
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Left a few comments. Will look at this again with fresh eyes after feedback from other reviewers is addressed.
docs/management/index-lifecycle-policies/example-index-lifecycle-policy.asciidoc
Outdated
Show resolved
Hide resolved
docs/management/index-lifecycle-policies/example-index-lifecycle-policy.asciidoc
Outdated
Show resolved
Hide resolved
They are identical. The docs/management/index-lifecycle-policies/example-index-lifecycle-policy.asciidoc file is an artifact of my attempts to preserve its history. The first one needs to be removed. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM. Still confused over the duplicate files, but if that gets addressed I'm good with these changes. Missed your comment. Thanks for the explanation!
It probably makes sense to have a "management" topic that addresses this that we can link to. I'll address that separately. |
* [DOCS] Combo version of ILM docs. * [DOCS] Moved tutorial from Kibana. * Adds documentation for index lifecycle policies (elastic#28705) * [DOCS] Adds documentation for index lifecycle policies * [DOCS] Updated image for policy options to show all menu items * Update create-policy.asciidoc * [DOCS] Incorporated review comments on hot and warm phase * [DOCS] Additional changes to warm phase * [DOCS] Removed the word open in the warm phase * Adds X-Pack icon for ILM (elastic#34178) * Add ILM tutorial (elastic#59502) * Add tutorial for ILM with filebeat * Change screenshots and add additional steps * Update screenshots, add numbered steps, and other minor edits * Incorporate feedback: update links, formatting, and minor edits * Move tip inline with list * Apply suggestions from code review Co-Authored-By: James Rodewig <[email protected]> * Move TIP inline . . . again * Put TIP inline Co-authored-by: James Rodewig <[email protected]> * Updates for navigation redesign (elastic#68709) * [DOCS] Updates for navigation redesign * Getting started * Set up text * Discover * Dashboard, Graph, ML, Maps, APM, SIEM, Dev tools * Dev Tools, Stack Monitoring, Management * Management * Final changes * [DOCS] Updates for navigation redesign * [DOCS] Updates CCR monitoring screenshots * updates SIEM screenshot and Cases overview text * Added Brandon's APM image * [DOCS] Refines CCR shard screenshot * Removed merge conflict image file Co-authored-by: lcawl <[email protected]> Co-authored-by: Ben Skelker <[email protected]> * [DOCS] Put API examples in collapsible sections like ML does * Fix include * Added tutorial images * Fixed images * Add short title for FB tutorial * Add missing files * Incorporate review feedback * review feedback * Incorporated review feedback Co-authored-by: gchaps <[email protected]> Co-authored-by: Lisa Cawley <[email protected]> Co-authored-by: Melori Arellano <[email protected]> Co-authored-by: James Rodewig <[email protected]> Co-authored-by: Kaarina Tungseth <[email protected]> Co-authored-by: Ben Skelker <[email protected]>
* [DOCS] Combo version of ILM docs. * [DOCS] Moved tutorial from Kibana. * Adds documentation for index lifecycle policies (#28705) * [DOCS] Adds documentation for index lifecycle policies * [DOCS] Updated image for policy options to show all menu items * Update create-policy.asciidoc * [DOCS] Incorporated review comments on hot and warm phase * [DOCS] Additional changes to warm phase * [DOCS] Removed the word open in the warm phase * Adds X-Pack icon for ILM (#34178) * Add ILM tutorial (#59502) * Add tutorial for ILM with filebeat * Change screenshots and add additional steps * Update screenshots, add numbered steps, and other minor edits * Incorporate feedback: update links, formatting, and minor edits * Move tip inline with list * Apply suggestions from code review Co-Authored-By: James Rodewig <[email protected]> * Move TIP inline . . . again * Put TIP inline Co-authored-by: James Rodewig <[email protected]> * Updates for navigation redesign (#68709) * [DOCS] Updates for navigation redesign * Getting started * Set up text * Discover * Dashboard, Graph, ML, Maps, APM, SIEM, Dev tools * Dev Tools, Stack Monitoring, Management * Management * Final changes * [DOCS] Updates for navigation redesign * [DOCS] Updates CCR monitoring screenshots * updates SIEM screenshot and Cases overview text * Added Brandon's APM image * [DOCS] Refines CCR shard screenshot * Removed merge conflict image file Co-authored-by: lcawl <[email protected]> Co-authored-by: Ben Skelker <[email protected]> * [DOCS] Put API examples in collapsible sections like ML does * Fix include * Added tutorial images * Fixed images * Add short title for FB tutorial * Add missing files * Incorporate review feedback * review feedback * Incorporated review feedback Co-authored-by: gchaps <[email protected]> Co-authored-by: Lisa Cawley <[email protected]> Co-authored-by: Melori Arellano <[email protected]> Co-authored-by: James Rodewig <[email protected]> Co-authored-by: Kaarina Tungseth <[email protected]> Co-authored-by: Ben Skelker <[email protected]> Co-authored-by: gchaps <[email protected]> Co-authored-by: Lisa Cawley <[email protected]> Co-authored-by: Melori Arellano <[email protected]> Co-authored-by: James Rodewig <[email protected]> Co-authored-by: Kaarina Tungseth <[email protected]> Co-authored-by: Ben Skelker <[email protected]>
* [DOCS] Combo version of ILM docs. * [DOCS] Moved tutorial from Kibana. * Adds documentation for index lifecycle policies (elastic#28705) * [DOCS] Adds documentation for index lifecycle policies * [DOCS] Updated image for policy options to show all menu items * Update create-policy.asciidoc * [DOCS] Incorporated review comments on hot and warm phase * [DOCS] Additional changes to warm phase * [DOCS] Removed the word open in the warm phase * Adds X-Pack icon for ILM (elastic#34178) * Add ILM tutorial (elastic#59502) * Add tutorial for ILM with filebeat * Change screenshots and add additional steps * Update screenshots, add numbered steps, and other minor edits * Incorporate feedback: update links, formatting, and minor edits * Move tip inline with list * Apply suggestions from code review Co-Authored-By: James Rodewig <[email protected]> * Move TIP inline . . . again * Put TIP inline Co-authored-by: James Rodewig <[email protected]> * Updates for navigation redesign (elastic#68709) * [DOCS] Updates for navigation redesign * Getting started * Set up text * Discover * Dashboard, Graph, ML, Maps, APM, SIEM, Dev tools * Dev Tools, Stack Monitoring, Management * Management * Final changes * [DOCS] Updates for navigation redesign * [DOCS] Updates CCR monitoring screenshots * updates SIEM screenshot and Cases overview text * Added Brandon's APM image * [DOCS] Refines CCR shard screenshot * Removed merge conflict image file Co-authored-by: lcawl <[email protected]> Co-authored-by: Ben Skelker <[email protected]> * [DOCS] Put API examples in collapsible sections like ML does * Fix include * Added tutorial images * Fixed images * Add short title for FB tutorial * Add missing files * Incorporate review feedback * review feedback * Incorporated review feedback Co-authored-by: gchaps <[email protected]> Co-authored-by: Lisa Cawley <[email protected]> Co-authored-by: Melori Arellano <[email protected]> Co-authored-by: James Rodewig <[email protected]> Co-authored-by: Kaarina Tungseth <[email protected]> Co-authored-by: Ben Skelker <[email protected]> Co-authored-by: gchaps <[email protected]> Co-authored-by: Lisa Cawley <[email protected]> Co-authored-by: Melori Arellano <[email protected]> Co-authored-by: James Rodewig <[email protected]> Co-authored-by: Kaarina Tungseth <[email protected]> Co-authored-by: Ben Skelker <[email protected]>
* [DOCS] Combo version of ILM docs. (#57909) (#59029) * [DOCS] Combo version of ILM docs. * [DOCS] Moved tutorial from Kibana. * Adds documentation for index lifecycle policies (#28705) * [DOCS] Adds documentation for index lifecycle policies * [DOCS] Updated image for policy options to show all menu items * Update create-policy.asciidoc * [DOCS] Incorporated review comments on hot and warm phase * [DOCS] Additional changes to warm phase * [DOCS] Removed the word open in the warm phase * Adds X-Pack icon for ILM (#34178) * Add ILM tutorial (#59502) * Add tutorial for ILM with filebeat * Change screenshots and add additional steps * Update screenshots, add numbered steps, and other minor edits * Incorporate feedback: update links, formatting, and minor edits * Move tip inline with list * Apply suggestions from code review Co-Authored-By: James Rodewig <[email protected]> * Move TIP inline . . . again * Put TIP inline Co-authored-by: James Rodewig <[email protected]> * Updates for navigation redesign (#68709) * [DOCS] Updates for navigation redesign * Getting started * Set up text * Discover * Dashboard, Graph, ML, Maps, APM, SIEM, Dev tools * Dev Tools, Stack Monitoring, Management * Management * Final changes * [DOCS] Updates for navigation redesign * [DOCS] Updates CCR monitoring screenshots * updates SIEM screenshot and Cases overview text * Added Brandon's APM image * [DOCS] Refines CCR shard screenshot * Removed merge conflict image file Co-authored-by: lcawl <[email protected]> Co-authored-by: Ben Skelker <[email protected]> * [DOCS] Put API examples in collapsible sections like ML does * Fix include * Added tutorial images * Fixed images * Add short title for FB tutorial * Add missing files * Incorporate review feedback * review feedback * Incorporated review feedback Co-authored-by: gchaps <[email protected]> Co-authored-by: Lisa Cawley <[email protected]> Co-authored-by: Melori Arellano <[email protected]> Co-authored-by: James Rodewig <[email protected]> Co-authored-by: Kaarina Tungseth <[email protected]> Co-authored-by: Ben Skelker <[email protected]> Co-authored-by: gchaps <[email protected]> Co-authored-by: Lisa Cawley <[email protected]> Co-authored-by: Melori Arellano <[email protected]> Co-authored-by: James Rodewig <[email protected]> Co-authored-by: Kaarina Tungseth <[email protected]> Co-authored-by: Ben Skelker <[email protected]> * [DOCS] Remove datastream reference Co-authored-by: gchaps <[email protected]> Co-authored-by: Lisa Cawley <[email protected]> Co-authored-by: Melori Arellano <[email protected]> Co-authored-by: James Rodewig <[email protected]> Co-authored-by: Kaarina Tungseth <[email protected]> Co-authored-by: Ben Skelker <[email protected]>
The goal is to present a more user-friendly, holistic view of the management features like ILM. This PR reworks the ILM content in the ES ref to show the UI as the primary way of setting up ILM. It incorporates the ILM tutorial that currently is published in the Kibana guide. Once this combined content is published, we'll remove the redundant content from the Kibana guide, set up redirects where needed, and add xrefs to the the ES docs.
Preview: https://elasticsearch_57909.docs-preview.app.elstc.co/guide/en/elasticsearch/reference/master/index-lifecycle-management.html