Skip to content

[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

Merged
merged 15 commits into from
Jul 3, 2020
Merged

[DOCS] Combo version of ILM docs. #57909

merged 15 commits into from
Jul 3, 2020

Conversation

debadair
Copy link
Contributor

@debadair debadair commented Jun 10, 2020

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

@debadair debadair added the WIP label Jun 10, 2020
@debadair debadair requested a review from gchaps June 10, 2020 01:56
gchaps and others added 9 commits June 29, 2020 15:32
* [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]>
@debadair
Copy link
Contributor Author

@elasticmachine retest this please

@debadair debadair added :Data Management/ILM+SLM Index and Snapshot lifecycle management >docs General docs changes v7.8.0 v7.9.0 v8.0.0 v7.8.1 and removed WIP v7.8.0 labels Jun 30, 2020
@debadair debadair marked this pull request as ready for review June 30, 2020 00:36
@elasticmachine
Copy link
Collaborator

Pinging @elastic/es-core-features (:Core/Features/ILM+SLM)

@elasticmachine elasticmachine added the Team:Data Management Meta label for data/management team label Jun 30, 2020
@elasticmachine
Copy link
Collaborator

Pinging @elastic/es-docs (>docs)

@elasticmachine elasticmachine added the Team:Docs Meta label for docs team label Jun 30, 2020
@dakrone
Copy link
Member

dakrone commented Jun 30, 2020

@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

@debadair
Copy link
Contributor Author

@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.

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.

LGTM

Copy link
Contributor

@jrodewig jrodewig left a 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.

Copy link
Contributor

@gchaps gchaps left a 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.

Copy link
Contributor

@lockewritesdocs lockewritesdocs left a 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.

@debadair
Copy link
Contributor Author

debadair commented Jul 1, 2020

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

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.

Copy link
Contributor

@jrodewig jrodewig left a 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!

@debadair
Copy link
Contributor Author

debadair commented Jul 3, 2020

  • 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.

It probably makes sense to have a "management" topic that addresses this that we can link to. I'll address that separately.

@debadair debadair merged commit f80f603 into elastic:master Jul 3, 2020
debadair added a commit to debadair/elasticsearch that referenced this pull request Jul 3, 2020
* [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]>
debadair added a commit that referenced this pull request Jul 3, 2020
* [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]>
debadair added a commit to debadair/elasticsearch that referenced this pull request Jul 28, 2020
* [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]>
debadair added a commit that referenced this pull request Jul 29, 2020
* [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]>
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 Team:Data Management Meta label for data/management team Team:Docs Meta label for docs team v7.8.1 v7.9.0 v8.0.0-alpha1
Projects
None yet
Development

Successfully merging this pull request may close these issues.

9 participants