Updating docs about how to create new dashboards#5229
Conversation
b80a5af to
6d13b70
Compare
|
@dedemorton Ready for the review. I think I am done with the changes. |
dedemorton
left a comment
There was a problem hiding this comment.
Made some comments. Overall looks good, but I did not have time to test the steps (only had time to review for readability).
docs/devguide/newdashboards.asciidoc
Outdated
There was a problem hiding this comment.
Title is a bit long. Let's add an abbreviated title so the TOC is cleaner. It's good to mention "Beat" in the heading for SEO, but not necessary in the TOC where the context is clear.
== Creating New Kibana Dashboards for a Beat or Beat module
++++
<titleabbrev>Creating New Kibana Dashboards</titleabbrev>
++++
docs/devguide/newdashboards.asciidoc
Outdated
There was a problem hiding this comment.
I'd remove line 4 and work some of the details into this section by saying:
When contributing to Beats development, you may want to add new dashboards or
customize the existing ones. To get started, you can
<<import-dashboards,import the Kibana dashboards>> that come with the official
Beats and use them as a starting point for your own dashboards. When you're done
making changes to the dashboards in Kibana, you can use the `export_dashboards`
script to <<export-dashboards,export the dashboards>>, along with all
dependencies, to a local directory.
docs/devguide/newdashboards.asciidoc
Outdated
There was a problem hiding this comment.
The ideas seem a bit out of sequence here. To fix this:
- Move line 4 to the topic about importing dashboards (see my comments later).
- Make the changes recommended on line 6.
docs/devguide/newdashboards.asciidoc
Outdated
There was a problem hiding this comment.
Move the content from line 4 to the start of this section. One small concern I have is that users might look furtively on the download page for an executable called "Beat". So I'd suggest a minor change:
The official Beats come with Kibana dashboards, and starting with 6.0.0, they
are part of every Beat package. You can use the Beat executable to import all
the dashboards and the index pattern for a Beat, including the dependencies
such as visualizations and searches.
docs/devguide/newdashboards.asciidoc
Outdated
There was a problem hiding this comment.
Make this active to avoid passive voice:
To import the dashboards, run the setup command:
docs/devguide/newdashboards.asciidoc
Outdated
There was a problem hiding this comment.
Change to:
The default value is the `kibana` directory available in the Beat package.
docs/devguide/newdashboards.asciidoc
Outdated
There was a problem hiding this comment.
Change to: "...it's better to modify a copy of the dashboard because the Beat overwrites..."
docs/devguide/newdashboards.asciidoc
Outdated
There was a problem hiding this comment.
Users might be confused if we use "generated" to mean a two different things in the same sentence. Maybe it would be better to say:
The Beat index pattern is generated from the `fields.yml`, which contains all
the fields exported by the Beat.
docs/devguide/newdashboards.asciidoc
Outdated
There was a problem hiding this comment.
Is there a thought missing at the end of this sentence? There is no period, and it just seems to drop off.
docs/devguide/newdashboards.asciidoc
Outdated
There was a problem hiding this comment.
To get the correct note formatting, use NOTE: (a single colon). Otherwise, you won't get the correct formatting and icon. (There are multiple instances of NOTE:: that need to be fixed.)
|
@dedemorton I addressed all the remarks. Can you please have another look? |
06742ed to
c7b196e
Compare
(cherry picked from commit 94b6298)
(cherry picked from commit f945da9)
This PR is part of #4540, and includes documentation updates in the dev guide about how to import and export Kibana 6.0 dashboards and newer.
cc-ed @dedemorton