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

Content about loading beats dashboards should be in the guide for each beat #1943

Closed
dedemorton opened this issue Jun 30, 2016 · 4 comments
Closed
Assignees
Labels

Comments

@dedemorton
Copy link
Contributor

Right now, the Platform Ref provides content about loading the beats dashboards. In the getting started guide for each beat, we point to the Platform Ref for info about loading the dashboards. This is not an ideal getting started experience because we send users out to a different book, and they need to find their way back to the specific guide for the beat they are using. We don’t make it super easy for people to navigate between books!

Instead of making users jump back to the Platform Ref, we should use asciidoc includes to suck the shared content into the docs for each beat (like we do with other sections of the guides).

@chrisribe
Copy link

chrisribe commented Aug 25, 2016

The guide is very confusing, I am just starting with topbeat (which is to be replaced by Metricbeat) and for the last hour have been looking how to load the sample dashboards !!!

Is this it?
https://www.elastic.co/guide/en/beats/libbeat/1.2/load-kibana-dashboards.html

The original doc starts here:
https://www.elastic.co/guide/en/beats/topbeat/1.2/_step_5_loading_sample_kibana_dashboards.html
Then hints to here:
https://www.elastic.co/guide/en/beats/libbeat/1.2/visualizing-data.html
Then finaly here:
https://www.elastic.co/guide/en/beats/libbeat/1.2/load-kibana-dashboards.html

WHAT THE FRACK !
Chris

UPDATE
I can confirm that this page is the page to use to load the dashboard samples
https://www.elastic.co/guide/en/beats/libbeat/1.2/load-kibana-dashboards.html
Chris

@dedemorton
Copy link
Contributor Author

@chrisribe Thanks for your feedback. I agree that we need to improve the docs in this area (that's what prompted me to open this issue). As you've figured out, the content for loading the dashboards is documented in the Platform Reference because the content is relevant to all Beats. However, I'm planning to move this information to the guide for each Beat so that you won't have to jump back to the Platform Reference after you've gotten the Elastic Stack set up. Hopefully that will make the getting started process more straightforward. We're also making some improvements to the dashboard import process to give you more flexibility over loading the dashboards.

@dedemorton
Copy link
Contributor Author

Note that we've also made an enhancement to the way the topics display in the right-hand navigation pane in the docs. The current topic is now highlighted in the TOC so that its relationships to other topics is more obvious.

@dedemorton
Copy link
Contributor Author

Closing in favor of tracking this issue in #2482

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

No branches or pull requests

3 participants