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.

Sign up for GitHub

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

Jump to bottom

[Reporting] Added docs about the new ILM kibana-reporting policy #108018

Merged
merged 2 commits into from
Aug 11, 2021
Merged

[Reporting] Added docs about the new ILM kibana-reporting policy #108018

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
d31c7b9
first iteration of ilm policy copy - in a callout
jloleysens Aug 10, 2021
0b5e7ef
apply James' suggested change
jloleysens Aug 10, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
19 changes: 12 additions & 7 deletions docs/user/reporting/index.asciidoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,9 +7,9 @@
--

:keywords: analyst, concept, task, reporting
:description: {kib} provides you with several options to share *Discover* saved searches, dashboards, *Visualize Library* visualizations, and *Canvas* workpads with others, or on a website.
:description: {kib} provides you with several options to share *Discover* saved searches, dashboards, *Visualize Library* visualizations, and *Canvas* workpads with others, or on a website.

{kib} provides you with several options to share *Discover* saved searches, dashboards, *Visualize Library* visualizations, and *Canvas* workpads.
{kib} provides you with several options to share *Discover* saved searches, dashboards, *Visualize Library* visualizations, and *Canvas* workpads.

You access the options from the *Share* menu in the toolbar. The sharing options include the following:

Expand All @@ -34,9 +34,9 @@ You access the options from the *Share* menu in the toolbar. The sharing options
Create and download PDF, PNG, or CSV reports of saved searches, dashboards, visualizations, and workpads.

[[reporting-layout-sizing]]
The layout and size of the report depends on what you are sharing.
The layout and size of the report depends on what you are sharing.
For saved searches, dashboards, and visualizations, the layout depends on the size of the panels.
For workpads, the layout depends on the size of the worksheet dimensions.
For workpads, the layout depends on the size of the worksheet dimensions.

To change the output size, change the size of the browser, which resizes the shareable container before the report generates. It might take some trial and error before you're satisfied.

Expand Down Expand Up @@ -67,6 +67,11 @@ NOTE: When you create a dashboard report that includes a data table or saved sea

. To view and manage reports, open the main menu, then click *Stack Management > Reporting*.

NOTE: Reports are stored in {es} and managed by the `kibana-reporting` {ilm}
({ilm-init}) policy. By default, the policy stores reports forever. To learn
more about {ilm-init} policies, refer to the {es}
{ref}/index-lifecycle-management.html[{ilm-init} documentation].

[float]
[[share-a-direct-link]]
== Share a direct link
Expand Down Expand Up @@ -102,15 +107,15 @@ Create a JSON file for a workpad.

. Open the main menu, then click *Canvas*.

. Open the workpad you want to share.
. Open the workpad you want to share.

. From the toolbar, click *Share*, then select *Download as JSON*.

[float]
[[add-workpad-website]]
== Share workpads on a website

beta[] *Canvas* allows you to create _shareables_, which are workpads that you download and securely share on a website.
beta[] *Canvas* allows you to create _shareables_, which are workpads that you download and securely share on a website.
To customize the behavior of the workpad on your website, you can choose to autoplay the pages or hide the workpad toolbar.

. Open the main menu, then click *Canvas*.
Expand Down Expand Up @@ -139,7 +144,7 @@ Some users might not have access to the dashboard or visualization. For more inf

. Open the main menu, then open the dashboard or visualization you want to share.

. Click *Share > Embed code*.
. Click *Share > Embed code*.

. Specify how you want to generate the code:

Expand Down