[Reporting] Reporting info panel touch ups #120617

jloleysens · 2021-12-07T14:18:27Z

Summary

Closes #118247

Addresses the points raised the issue and introduces new structure to the flyout. Notable changes:

Added subsections for the details to live inside of helping the reader scan and find the exact info they are looking for
Moved warnings and errors to a callout at the top of the flyout. It's important that this information be highlighted here as it is one the main reasons a user might to the flyout.
Move the report title to the title of the flyout, was "Report info"
Removed some fields: Export type, Layout, Dimensions (now to separate fields with units denoted),

How to test

Start Kibana & ES on basic
Go to License management and start a trial license
Generate a PNG/PDF report in dashboard
Go the reporting management UI in Stack Management and view the report flyout by clicking on the name of a report

Release note

We introduced a new structure to the report details flyout to help readers get to the information they want faster.

Screenshots

With warnings

With errors

With errors and warnings

Any text added follows EUI's writing guidelines, uses sentence case text and includes i18n support
Unit or functional tests were updated or added to match the most common scenarios

…ng. still need to re-introduce errors and deprecated report types in the new structure

…d settings format

jloleysens · 2021-12-08T11:51:03Z

@elasticmachine merge upstream

elasticmachine · 2021-12-08T15:16:26Z

Pinging @elastic/kibana-reporting-services (Team:Reporting Services)

elasticmachine · 2021-12-08T15:16:27Z

Pinging @elastic/kibana-app-services (Team:AppServicesUx)

jloleysens · 2021-12-08T15:16:35Z

@elasticmachine merge upstream

x-pack/plugins/reporting/public/management/components/report_info_flyout_content.tsx

tsullivan

I left a few minor suggestions

Co-authored-by: Tim Sullivan <tsullivan@users.noreply.github.com>

jloleysens · 2021-12-13T13:17:38Z

@elasticmachine merge upstream

tsullivan

LGTM

…ons are not ready

gchaps

Is it possible to add more spacing between the title "Timestamps" and "Time zone"? It seems a little tight.

gchaps · 2021-12-13T22:32:51Z

x-pack/plugins/reporting/public/management/components/report_info_flyout.tsx

+      }}
+    >
+      {i18n.translate('xpack.reporting.reportInfoFlyout.openInKibanaAppButtonLabel', {
+        defaultMessage: 'Open in Kibana App',


I don't really have the context for this text, but can it be: Open in Kibana

If you do include app, it should be lower case.

"Open in Kibana" sounds good!

gchaps · 2021-12-13T23:45:10Z

x-pack/plugins/reporting/public/management/components/report_info_flyout_content.tsx

+
+    hasScreenshot && {
+      title: i18n.translate('xpack.reporting.listing.infoPanel.dimensionsInfoHeight', {
+        defaultMessage: 'Height (in pixels)',


Are the parens needed? "Size in bytes" does not contain parens.

gchaps · 2021-12-13T23:45:50Z

x-pack/plugins/reporting/public/management/components/report_info_flyout_content.tsx

+    },
+    hasScreenshot && {
+      title: i18n.translate('xpack.reporting.listing.infoPanel.dimensionsInfoWidth', {
+        defaultMessage: 'Width (in pixels)',


Same comment about the parens. Does this work:

Width in pixels

gchaps · 2021-12-13T23:47:23Z

x-pack/plugins/reporting/public/management/report_listing.tsx

@@ -431,10 +429,7 @@ class ReportListingUi extends Component<Props, State> {
                defaultMessage: 'Open the Kibana App where this report was generated.',


Suggested change

defaultMessage: 'Open the Kibana App where this report was generated.',

defaultMessage: 'Open the Kibana app where this report was generated.',

jloleysens · 2021-12-14T10:10:21Z

Thanks for the review @gchaps ! I think I've addressed your points.

Is it possible to add more spacing between the title "Timestamps" and "Time zone"? It seems a little tight.

Great idea, updated, see the screenshot.

kibana-ci · 2021-12-14T11:21:42Z

💚 Build Succeeded

Metrics [docs]

Async chunks

Total size of all lazy-loaded chunks that will be downloaded as the user navigates the app

id	before	after	diff
`reporting`	56.3KB	58.0KB	+1.7KB

Page load bundle

Size of the bundles that are downloaded on every page load. Target size is below 100kb

id	before	after	diff
`reporting`	41.8KB	42.1KB	+260.0B

History

💚 Build #12959 succeeded 0612c02
💔 Build #12822 failed f4d1166
💚 Build #12166 succeeded 4d14d9f
💚 Build #12085 succeeded c2e4e74
💚 Build #11811 succeeded c67b758
💔 Build #11778 failed 28fb5c0

To update your PR or re-run it, just comment with:
@elasticmachine merge upstream

gchaps

LGTM

* changed info -> summary and combined maximum attempts and attempts field * added spaceId if it is there to job info * moved space id to job details section * moved processing and job info into a single array * wip, introduced a new structure to the flyout for easier visual parsing. still need to re-introduce errors and deprecated report types in the new structure * remove unnecessary div * added warnings and errors to callout and cleaned up comments * remove unused functionality and introduce date formatting per advanced settings format * remove unused import * remove unused i18n * refactor check for info.max_attempts in flyout content Co-authored-by: Tim Sullivan <tsullivan@users.noreply.github.com> * update info.lyout.dimensions.height to be Math.ceiled Co-authored-by: Tim Sullivan <tsullivan@users.noreply.github.com> * update info.lyout.dimensions.width to be Math.ceiled Co-authored-by: Tim Sullivan <tsullivan@users.noreply.github.com> * lint and remove bad suggestion commit * added actions button to flyout, in flyout footer * create a little bit more breathing room for the section titles * added logic to disable the action buttons in the flyout when the actions are not ready * update copy per feedback * added basic tests for the actions menu in the flyout Co-authored-by: Kibana Machine <42973632+kibanamachine@users.noreply.github.com> Co-authored-by: Tim Sullivan <tsullivan@users.noreply.github.com>

* changed info -> summary and combined maximum attempts and attempts field * added spaceId if it is there to job info * moved space id to job details section * moved processing and job info into a single array * wip, introduced a new structure to the flyout for easier visual parsing. still need to re-introduce errors and deprecated report types in the new structure * remove unnecessary div * added warnings and errors to callout and cleaned up comments * remove unused functionality and introduce date formatting per advanced settings format * remove unused import * remove unused i18n * refactor check for info.max_attempts in flyout content Co-authored-by: Tim Sullivan <tsullivan@users.noreply.github.com> * update info.lyout.dimensions.height to be Math.ceiled Co-authored-by: Tim Sullivan <tsullivan@users.noreply.github.com> * update info.lyout.dimensions.width to be Math.ceiled Co-authored-by: Tim Sullivan <tsullivan@users.noreply.github.com> * lint and remove bad suggestion commit * added actions button to flyout, in flyout footer * create a little bit more breathing room for the section titles * added logic to disable the action buttons in the flyout when the actions are not ready * update copy per feedback * added basic tests for the actions menu in the flyout Co-authored-by: Kibana Machine <42973632+kibanamachine@users.noreply.github.com> Co-authored-by: Tim Sullivan <tsullivan@users.noreply.github.com> (cherry picked from commit d213263) # Conflicts: # x-pack/plugins/reporting/public/lib/job.tsx # x-pack/plugins/reporting/public/management/components/report_info_flyout_content.tsx # x-pack/plugins/translations/translations/ja-JP.json # x-pack/plugins/translations/translations/zh-CN.json

* [Reporting] Reporting info panel touch ups (#120617) * changed info -> summary and combined maximum attempts and attempts field * added spaceId if it is there to job info * moved space id to job details section * moved processing and job info into a single array * wip, introduced a new structure to the flyout for easier visual parsing. still need to re-introduce errors and deprecated report types in the new structure * remove unnecessary div * added warnings and errors to callout and cleaned up comments * remove unused functionality and introduce date formatting per advanced settings format * remove unused import * remove unused i18n * refactor check for info.max_attempts in flyout content Co-authored-by: Tim Sullivan <tsullivan@users.noreply.github.com> * update info.lyout.dimensions.height to be Math.ceiled Co-authored-by: Tim Sullivan <tsullivan@users.noreply.github.com> * update info.lyout.dimensions.width to be Math.ceiled Co-authored-by: Tim Sullivan <tsullivan@users.noreply.github.com> * lint and remove bad suggestion commit * added actions button to flyout, in flyout footer * create a little bit more breathing room for the section titles * added logic to disable the action buttons in the flyout when the actions are not ready * update copy per feedback * added basic tests for the actions menu in the flyout Co-authored-by: Kibana Machine <42973632+kibanamachine@users.noreply.github.com> Co-authored-by: Tim Sullivan <tsullivan@users.noreply.github.com> (cherry picked from commit d213263) # Conflicts: # x-pack/plugins/reporting/public/lib/job.tsx # x-pack/plugins/reporting/public/management/components/report_info_flyout_content.tsx # x-pack/plugins/translations/translations/ja-JP.json # x-pack/plugins/translations/translations/zh-CN.json * resolved merge conflicts

jloleysens added 8 commits December 7, 2021 12:06

changed info -> summary and combined maximum attempts and attempts field

223af50

added spaceId if it is there to job info

305059f

moved space id to job details section

bfb8036

moved processing and job info into a single array

318f8e1

wip, introduced a new structure to the flyout for easier visual parsi…

d828732

…ng. still need to re-introduce errors and deprecated report types in the new structure

remove unnecessary div

586e43f

added warnings and errors to callout and cleaned up comments

1c0062e

remove unused functionality and introduce date formatting per advance…

0ffd3fc

…d settings format

jloleysens added release_note:enhancement (Deprecated) Feature:Reporting Use Reporting:Screenshot, Reporting:CSV, or Reporting:Framework instead Team:Reporting Services v8.1.0 labels Dec 7, 2021

jloleysens requested a review from tsullivan December 7, 2021 14:18

jloleysens added 2 commits December 7, 2021 15:22

remove unused import

28fb5c0

remove unused i18n

c67b758

Merge branch 'main' into reporting/info-panel-touch-ups

c2e4e74

jloleysens marked this pull request as ready for review December 8, 2021 15:16

jloleysens requested review from a team as code owners December 8, 2021 15:16

Merge branch 'main' into reporting/info-panel-touch-ups

4d14d9f

tsullivan reviewed Dec 9, 2021

View reviewed changes

x-pack/plugins/reporting/public/management/components/report_info_flyout_content.tsx Outdated Show resolved Hide resolved

tsullivan reviewed Dec 9, 2021

View reviewed changes

x-pack/plugins/reporting/public/management/components/report_info_flyout_content.tsx Outdated Show resolved Hide resolved

tsullivan reviewed Dec 9, 2021

View reviewed changes

x-pack/plugins/reporting/public/management/components/report_info_flyout_content.tsx Outdated Show resolved Hide resolved

tsullivan requested changes Dec 9, 2021

View reviewed changes

refactor check for info.max_attempts in flyout content

09707a8

Co-authored-by: Tim Sullivan <tsullivan@users.noreply.github.com>

update info.lyout.dimensions.width to be Math.ceiled

009b5fb

Co-authored-by: Tim Sullivan <tsullivan@users.noreply.github.com>

Merge branch 'main' into reporting/info-panel-touch-ups

f4d1166

tsullivan approved these changes Dec 13, 2021

View reviewed changes

jloleysens added 4 commits December 13, 2021 18:44

lint and remove bad suggestion commit

c6e3942

added actions button to flyout, in flyout footer

614c723

create a little bit more breathing room for the section titles

b218605

added logic to disable the action buttons in the flyout when the acti…

0612c02

…ons are not ready

gchaps reviewed Dec 13, 2021

View reviewed changes

jloleysens added 2 commits December 14, 2021 10:26

update copy per feedback

d94957d

added basic tests for the actions menu in the flyout

72346b7

gchaps approved these changes Dec 14, 2021

View reviewed changes

jloleysens merged commit d213263 into elastic:main Dec 15, 2021

kibanamachine added the backport:skip This commit does not require backporting label Dec 15, 2021

jloleysens deleted the reporting/info-panel-touch-ups branch December 15, 2021 09:20

jloleysens added v7.17.0 v8.2.0 v8.0.0 and removed v7.17.0 v8.0.0 labels Dec 15, 2021

tsullivan mentioned this pull request Dec 29, 2021

Reporting should display clearer error message if dashboard has saved object not found panel #97904

Closed

kibanamachine mentioned this pull request Apr 28, 2022

[Reporting/Cloud] Soft disable reporting functionality on 1GB Kibanas #130651

Merged

3 tasks

jloleysens mentioned this pull request Apr 28, 2022

[8.2] [Reporting] Reporting info panel touch ups (#120617) #131164

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[Reporting] Reporting info panel touch ups #120617

[Reporting] Reporting info panel touch ups #120617

jloleysens commented Dec 7, 2021 •

edited

Loading

jloleysens commented Dec 8, 2021

elasticmachine commented Dec 8, 2021

elasticmachine commented Dec 8, 2021

jloleysens commented Dec 8, 2021

tsullivan left a comment

jloleysens commented Dec 13, 2021

tsullivan left a comment

gchaps left a comment

gchaps Dec 13, 2021

jloleysens Dec 14, 2021

gchaps Dec 13, 2021

gchaps Dec 13, 2021

gchaps Dec 13, 2021

jloleysens commented Dec 14, 2021

kibana-ci commented Dec 14, 2021

gchaps left a comment

		@@ -431,10 +429,7 @@ class ReportListingUi extends Component<Props, State> {
		defaultMessage: 'Open the Kibana App where this report was generated.',

[Reporting] Reporting info panel touch ups #120617

[Reporting] Reporting info panel touch ups #120617

Conversation

jloleysens commented Dec 7, 2021 • edited Loading

Summary

How to test

Release note

Screenshots

With warnings

With errors

With errors and warnings

jloleysens commented Dec 8, 2021

elasticmachine commented Dec 8, 2021

elasticmachine commented Dec 8, 2021

jloleysens commented Dec 8, 2021

tsullivan left a comment

Choose a reason for hiding this comment

jloleysens commented Dec 13, 2021

tsullivan left a comment

Choose a reason for hiding this comment

gchaps left a comment

Choose a reason for hiding this comment

gchaps Dec 13, 2021

Choose a reason for hiding this comment

jloleysens Dec 14, 2021

Choose a reason for hiding this comment

gchaps Dec 13, 2021

Choose a reason for hiding this comment

gchaps Dec 13, 2021

Choose a reason for hiding this comment

gchaps Dec 13, 2021

Choose a reason for hiding this comment

jloleysens commented Dec 14, 2021

kibana-ci commented Dec 14, 2021

💚 Build Succeeded

Metrics [docs]

Async chunks

Page load bundle

History

gchaps left a comment

Choose a reason for hiding this comment

jloleysens commented Dec 7, 2021 •

edited

Loading