update docs for reporting move to share menu (#27683) (#28045)

This commit is contained in:
Nathan Reese 2019-01-03 17:01:31 -07:00 committed by GitHub
parent 7306406f3f
commit 7eee7cc427
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
9 changed files with 17 additions and 20 deletions

View file

@ -13,17 +13,10 @@ However, these docs will be kept up-to-date to reflect the current implementatio
[float]
[[reporting-nav-bar-extensions]]
=== Nav Bar Extensions
X-Pack uses the `NavBarExtensionsRegistryProvider` to register a navigation bar item for the
Dashboard/Discover/Visualize applications. These all use the `export-config` AngularJS directive to display the
Reporting options. Each of the different exportTypes require the AngularJS controller that the contains the
`export-config` directive to implement certain methods/properties that are used when creating the {reporting} job.
=== Share Menu Extensions
X-Pack uses the `ShareContextMenuExtensionsRegistryProvider` to register actions in the share menu.
If you wish to add Reporting integration via the navigation bar that emulates the way these options are chosen for
Dashboards, Visualize and Discover, you can reuse the `export-config` directive for the time being. Otherwise, you can
provide a custom UI that generates the URL that is used to generate the {reporting} job.
This integration will likely be changing in the near future as we move away from AngularJS towards React.
This integration will likely be changing in the near future as we move towards a unified actions abstraction across {kib}.
[float]
=== Generate Job URL

View file

@ -2,7 +2,7 @@
[[reporting-getting-started]]
== Getting Started
{reporting} is automatically enabled in {kib}.
{reporting} is automatically enabled in {kib}.
To manually generate a report:
@ -14,20 +14,24 @@ information, see <<secure-reporting>>.
. Open the dashboard, visualization, or saved search you want to include
in the report.
. Click *Reporting* in the {kib} toolbar:
. Click *Share* in the {kib} toolbar:
+
--
[role="screenshot"]
image:reporting/images/reporting-button.png["Reporting Button",link="reporting-button.png"]
image:reporting/images/share-button.png["Reporting Button",link="share-button.png"]
--
. Depending on the {kib} application, choose the appropriate options:
.. If you're on Discover, click the *Generate CSV* button.
.. If you're on Discover:
... Select *CSV Reports*
... Click the *Generate CSV* button.
.. If you're on Visualize or Dashboard:
... Select *PDF Reports*
... Select either *Optimize PDF for printing* or *Preserve existing layout in PDF*. For an explanation of the different layout modes, see <<pdf-layout-modes, PDF Layout Modes>>.
... Choose to enable *Optimize for printing* layout mode. For an explanation of the different layout modes, see <<pdf-layout-modes, PDF Layout Modes>>.
... Click the *Generate PDF* button.

Binary file not shown.

Before

Width:  |  Height:  |  Size: 111 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 145 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 86 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 55 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 213 KiB

View file

@ -13,10 +13,10 @@ NOTE: On Linux, the `libfontconfig` and `libfreetype6` packages and system
fonts are required to generate PDF reports. If no system fonts are available,
labels are not rendered correctly in the reports.
The following Reporting button is found in the {kib} toolbar:
Reporting is located in the share menu from the {kib} toolbar:
[role="screenshot"]
image::reporting/images/reporting-button.png["Reporting"]
image::reporting/images/share-button.png["Share"]
You can also <<automating-report-generation, generate reports automatically>>.
@ -30,4 +30,4 @@ include::pdf-layout-modes.asciidoc[]
include::configuring-reporting.asciidoc[]
include::chromium-sandbox.asciidoc[]
include::reporting-troubleshooting.asciidoc[]
include::development/index.asciidoc[]
include::development/index.asciidoc[]

View file

@ -5,7 +5,7 @@ When creating a PDF report, there are two layout modes *Optimize PDF for printin
--
[role="screenshot"]
image:reporting/images/pdf-reporting.png["PDF Reporting",link="pdf-reporting.png"]
image:reporting/images/preserve-layout-switch.png["PDF Reporting",link="preserve-layout-switch.png"]
--
[float]
@ -26,4 +26,4 @@ This will create a PDF preserving the existing layout and size of the Visualizat
--
[role="screenshot"]
image:reporting/images/preserve-layout.png["Preserve existing layout in PDF",link="preserve-layout.png"]
--
--