Edit topics about creating new dashboards #2576
Conversation
|
@monicasarbu These are the structural changes that I mentioned I would be making eventually. Please review. |
|
This PR adds edits for work tracked in #2482 |
|
LGTM. I only left a few comments due to the latest changes. The PR needs to be rebased. |
| * Community Beats developers may want to <<import-dashboards-for-development,import dashboards for development>> to use as a starting point for new dashboards. | ||
|
|
||
| [[import-single-beat]] | ||
| ==== Import Dashboards and/or the Index Pattern for a Single Beat | ||
|
|
||
| Using the `import_dashboards` script, you can import the dashboards and the index pattern to |
There was a problem hiding this comment.
I would mention: Using the import_dashboards script from the Beat package, you can import the dashboards ...
| [source,shell] | ||
| ---------------------------------------------------------------------- | ||
| $ ./scripts/import_dashboards -beat metricbeat -file metricbeat-dashboards-1.1.zip | ||
| ./scripts/import_dashboards -beat metricbeat -file metricbeat-dashboards-1.1.zip |
There was a problem hiding this comment.
and we can remove the -beat metricbeat from the command line. So, it becomes:
./scripts/import_dashboards -file metricbeat-dashboards-1.1.zip
| [source,shell] | ||
| ---------------------------------------------------------------------- | ||
| $ ./scripts/import_dashboards -dir kibana/metricbeat |
There was a problem hiding this comment.
@dedemorton Any reasons to remove the $ sign? I used it to identify that it's a shell, but I am not sure how useful that is.
There was a problem hiding this comment.
@monicasarbu Yes. I removed it for a couple of reasons. We weren't using it consistently. Also, we've heard from customers (specifically, for cloud) that the $ makes it harder to copy/paste commands. Granted...we're not consistent in the doc, but we should move towards removing it. If we think that showing the $ adds value, then we should handle it as part of the formatting that happens in the doc build when we've tagged something as shell.
| [source,shell] | ||
| ---------------------------------------------------------------------- | ||
| $ ./scripts/import_dashboards -beat metricbeat | ||
| ./scripts/import_dashboards -beat metricbeat |
There was a problem hiding this comment.
same here, it becomes:
./scripts/import_dashboards
| [source,shell] | ||
| ----------------------- | ||
| $ scripts/import_dashboards -beat metricbeat -url https://github.com/monicasarbu/metricbeat-dashboards/archive/v1.1.zip | ||
| ./scripts/import_dashboards -beat metricbeat -url https://github.com/monicasarbu/metricbeat-dashboards/archive/v1.1.zip |
There was a problem hiding this comment.
same here, it becomes:
./scripts/import_dashboards -url https://github.com/monicasarbu/metricbeat-dashboards/archive/v1.1.zip
|
|
||
| To import only the index-pattern for a single Beat (eg. Metricbeat) use: | ||
| [source,shell] | ||
| ----------------------- | ||
| ./import_dashboards -only-index -beat metricbeat | ||
| ./scripts/import_dashboards -only-index -beat metricbeat |
There was a problem hiding this comment.
same here, it becomes:
./scripts/import_dashboards -only-index
| ----------------------- | ||
|
|
||
| To import only the dashboards together with visualizations and searches for a single Beat (eg. Metricbeat) use: | ||
|
|
||
| [source,shell] | ||
| ----------------------- | ||
| ./import_dashboards -only-dashboards -beat metricbeat | ||
| ./scripts/import_dashboards -only-dashboards -beat metricbeat |
There was a problem hiding this comment.
same here, it becomes:
./scripts/import_dashboards -only-dashboards
|
|
||
| [source,shell] | ||
| ----------------- | ||
| $ beats/libbeat/dashboards/import_dashboards -beat metricbeat | ||
| beats/libbeat/dashboards/import_dashboards -beat metricbeat |
There was a problem hiding this comment.
here it's mandatory to pass the -beat option.
dedemorton
force-pushed
the
edit_platform_ref
branch
from
a237698 to
000e48b
Compare
|
@monicasarbu I've rebased and fixed the issues that you identified. I also noticed that the section titles were a bit inconsistent, so I fixed that, too. |
Summary of changes:
-h(makes it a lot easier to see when we've left something out).$because we've gotten feedback from developers saying that it makes copy/paste harder when we include$in our examples.