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

Move Index Patterns documentation to top level section before Discover section #39543

Closed
nreese opened this issue Jun 24, 2019 · 9 comments · Fixed by #53347
Closed

Move Index Patterns documentation to top level section before Discover section #39543

nreese opened this issue Jun 24, 2019 · 9 comments · Fixed by #53347
Assignees
Labels
discuss Team:Docs Team:Visualizations Visualization editors, elastic-charts and infrastructure

Comments

@nreese
Copy link
Contributor

nreese commented Jun 24, 2019

Index Patterns are an important part to working with Kibana. The Index Pattern docs are currently buried underneath management section because thats were they are in the UI. I think it would be better to move the Index Pattern section out from management and into its own top level subject that comes before Discover.

The Index Pattern docs should also be updated to include

  • Clear relation to Elasticsearch indices and how Index Patterns are used to group Elasticsearch indices by wildcard
  • Better explanation of field formatters

cc @gchaps @lukasolson

@nreese nreese added Team:Docs discuss Team:Visualizations Visualization editors, elastic-charts and infrastructure labels Jun 24, 2019
@elasticmachine
Copy link
Contributor

Pinging @elastic/kibana-docs

@elasticmachine
Copy link
Contributor

Pinging @elastic/kibana-app

@elasticmachine
Copy link
Contributor

Pinging @elastic/kibana-app-arch

@gchaps
Copy link
Contributor

gchaps commented Aug 7, 2019

This is a good idea. In running metrics, we found that Define your index pattern in the Getting Started is one of the top 10 hit docs. However, this doc is specific to using the GS.

We have another topic on index patterns, Connecting Kibana to Elasticsearch , which is in the Set Up section.

I think it would be beneficial to the reader if we combine the topics related to index patterns and make them more visible in the doc.

@alexh97 alexh97 closed this as completed Aug 15, 2019
@nreese
Copy link
Contributor Author

nreese commented Aug 15, 2019

Can you provide a reason why this issue was closed?

@alexh97
Copy link

alexh97 commented Aug 15, 2019

This was closed accidentally due to a bad integration with a 3rd party app (Zube). My apologies.

@alexh97 alexh97 reopened this Aug 15, 2019
@KOTungseth
Copy link
Contributor

@nreese we are fixing this in our doc reorg.

@gchaps
Copy link
Contributor

gchaps commented Dec 6, 2019

@nreese, @alexfrancoeur I'm reworking the Discover docs now, and am would like your opinion on moving the Index Patterns section as the first topic under that section. Although not its own section, it will be less hidden than under Management. I'm a little hesitant to add a new section to an already overloaded TOC.

We also have plans to document index patterns in other areas:

  • The introduction to Kibana, which is going through an update to better highlight what Kibana can do.

  • The Getting Started, which is also going through an update, discusses creating index patterns.

  • In Visualize, more links have been added to creating index patterns.

Let me know if you still feel a separate, top-level section is needed.

@nreese
Copy link
Contributor Author

nreese commented Dec 6, 2019

I think putting Index Pattern under Discover is a natural fit since Discover so closely aligns to exploring a data source and looking at documents.

Places like intro, getting started, visualize can just mention index patterns and then link to Discover section.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
discuss Team:Docs Team:Visualizations Visualization editors, elastic-charts and infrastructure
Projects
None yet
Development

Successfully merging a pull request may close this issue.

6 participants