-
Notifications
You must be signed in to change notification settings - Fork 107
Combine 'Index mgmt' with 'Index mgmt in Kibana' #2010
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
base: main
Are you sure you want to change the base?
Conversation
I'll try to review this tomorrow. I'm totally ok with the initiative! The majority of ILM docs were part of the elasticsearch guide and are felt like almost reference in some areas, or focused on API calls. So this is a great step 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.
Great addings! I've added some suggestions with a bit more details in some areas that could feel confusing otherwise. Feel free to share your thoughts.
Also I'd like to share some extra thoughts for your consideration (maybe in future PRs):
- Duplication:
With the proposed change we now have in the Templates
section something that feels repetitive:

which feels similar to:

Maybe something to address as a separate issue (probably the entire "Templates + child" section needs extra love).
- Narrative around index templates / templates / component templates:
In the Templates
section we are trying to introduce a generic template
concept explaining that templates can be of two different types (index templates and component templates). And we don't have them separated in different docs, neither with different headings / anchors for definition.
That makes linking to index-templates and component-templates a bit complicated, as we don't have a good section dedicated to component-templates and another dedicated to index-templates. Maybe something to address also in the future.
-
In relation with the previous, I think linking to the
PUT component templates API
doc to share a good description of what a component template is, is a prove that our "template" document needs love. -
Something I haven't been able to touch because it wasn't part of the PR is:
Manage index templates [index-management-manage-index-templates]
An index template is a way to tell {{es}} how to configure an index when it is created.
I'd suggest something like:
An index template is a type of [template](/manage-data/data-store/templates.md) that tells {{es}} how to configure an index when it is created.
Similar to that, the component template introduction:
Manage component templates
Component templates are reusable building blocks that configure mappings, settings, and aliases.
For that I'd suggest something like:
Component templates are a type of [template](/manage-data/data-store/templates.md) used as reusable building blocks within index templates to configure index settings, mappings, and aliases.
With those suggestions I think the context of the link (templates.md) makes better sense, and it also implies to the reader that there are multiple types of templates (index / component).
Co-authored-by: Edu González de la Herrán <25320357+eedugon@users.noreply.github.com>
Co-authored-by: Edu González de la Herrán <25320357+eedugon@users.noreply.github.com>
Co-authored-by: Edu González de la Herrán <25320357+eedugon@users.noreply.github.com>
Co-authored-by: Edu González de la Herrán <25320357+eedugon@users.noreply.github.com>
Co-authored-by: Edu González de la Herrán <25320357+eedugon@users.noreply.github.com>
Thanks for the superb review @eedugon! |
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.
Experience docs changes LGTM 🥳
As part of the ILM review it was pointed out that the very important Index management in Kibana page is kind of hard to find, since it's nested a few levels down in the "Index Lifecycle Management" section. It's also confusing that we have a few pages about managing indices.
This PR combines the contents of "Index management in Kibana" into Index Management (a section of the main, very prominent "Index basics" page at the top of the ToC).
Notes:
This page has moved
note, and created a redirect in theredirect.yml
file.See:
Closes: #1569