Skip to content

Fix up the 'Templates' section #2178

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

Open
wants to merge 7 commits into
base: main
Choose a base branch
from

Conversation

kilfoyle
Copy link
Contributor

@kilfoyle kilfoyle commented Jul 18, 2025

This attempts to improve the Templates docs by:

  • Adding more explanation into the page rather than just linking to the API docs.
  • Removing the "manage index templates" content that is duplicated; this section in the more prominent "Index basics" will be the single source of truth.
  • Improving the narrative by making a clearer distinction between "Index templates" and "component templates", with separate sections for each.
  • Changing the giant warning about index pattern collisions (which takes about 1/3 of the page) into a subsection of "Index templates"; this should flow better and be less jarring for readers.
  • Including the API instructions for creating each kind of template, and also link to the Kibana version of those steps that are included in the Index basics page.
  • Adding a tip with links to the subpages about simulating an index template and about ignore missing component templates, just to help people be aware of these cool features.

Please see preview page: Templates

@eedugon This was prompted by your suggestions here so I hope you don't mind my adding you as a reviewer. 🙏

Closes: #2056

Copy link

github-actions bot commented Jul 18, 2025

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Improvements to "Templates" section
1 participant