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

Update chart reference docs #102430

Merged
merged 6 commits into from
Jun 23, 2021
Merged

Update chart reference docs #102430

merged 6 commits into from
Jun 23, 2021

Conversation

wylieconlon
Copy link
Contributor

@wylieconlon wylieconlon commented Jun 16, 2021 •
edited
Loading

@wylieconlon wylieconlon added Team:Docs Team:Visualizations Visualization editors, elastic-charts and infrastructure Feature:Lens labels Jun 16, 2021
@wylieconlon wylieconlon requested a review from KOTungseth June 16, 2021 22:03
@elasticmachine
Copy link
Contributor

Pinging @elastic/kibana-app (Team:KibanaApp)

@elasticmachine
Copy link
Contributor

Pinging @elastic/kibana-docs (Team:Docs)

@wylieconlon wylieconlon added release_note:skip Skip the PR/issue when compiling release notes v7.14.0 v8.0.0 labels Jun 16, 2021
@flash1293
Copy link
Contributor

Thanks for this. A few notes:

  • Gauge and Goal / Sunburst / Treemap Vega can totally do these chart types
  • Color by value TSVB does have color rules for tables (only text, not background)
  • Percentage mode agg-based does have a percentage mode. Also it's kind of possible to build in Timelion using math
  • Date range can be done in Lens as well using filters
  • Significant terms is not supported by Lens
  • Filter agg-based does not support the filter bucket agg. I'm not sure whether the split with Metrics with filters for the Lens feature makes sense (it's the same thing technically). I think Lens should just get a check mark for Filter, but agg-based shouldn't.

@wylieconlon wylieconlon requested a review from flash1293 June 17, 2021 14:47
flash1293
flash1293 approved these changes Jun 17, 2021
View reviewed changes
Copy link
Contributor

@flash1293 flash1293 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Seems like you missed the percentage mode one. Also, I found a new one:

  • Significant terms TSVB does not support it to my knowledge

LGTM otherwise, I don't think we need another round of review

KOTungseth
KOTungseth approved these changes Jun 17, 2021
View reviewed changes
Copy link
Contributor

@KOTungseth KOTungseth left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I have two questions re: the Formulas section:

  • Can we change the title to something actionable?
  • Can we add an image for the help button?

Otherwise, LGTM!

docs/user/dashboard/lens.asciidoc
Formulas let you perform math on aggregated data in Lens by typing
math and quick functions. To access formulas,
click the *Formula* tab in the dimension editor. Access the complete
reference for formulas from the help menu.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can we add an image of the help button once it's finalized?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes, it's still held up for now.

docs/user/dashboard/lens.asciidoc Outdated
@@ -139,6 +139,42 @@ image::images/lens_drag_drop_3.gif[Using drag and drop to reorder]

. Press Space bar to confirm, or to cancel, press Esc.

[float]
[[lens-formulas]]
==== Formulas
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can we make this title actionable? Something like, Perform math on aggregated data or Use formulas to perform math.

@wylieconlon wylieconlon added the auto-backport Deprecated - use backport:version if exact versions are needed label Jun 21, 2021
@dej611
Copy link
Contributor

dej611 commented Jun 22, 2021

The content it's really useful here!
Would it be possible to align the whole column text rather than just the cell values?

Checks are right aligned while column headers are left aligned.

Screenshot 2021-06-22 at 10 23 38

Something like this should sync the whole column:

[cols="<,>,>,>", options="header"]

@wylieconlon
Copy link
Contributor Author

@dej611 I think you've correctly diagnosed that there was an issue in the alignment, but not the solution. The ^| &check; syntax is actually setting each checkmark to be centered at a td level, which was overriding the column alignment defaults. Personally I think that this table is easier to read when left-aligned, so I'd appreciate another review.

dej611
dej611 approved these changes Jun 23, 2021
View reviewed changes
Copy link
Contributor

@dej611 dej611 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Reviewed again and it's all good 👍
The problem was more the misalignment between cells and header than the specific alignment: now they are in sync and it looks much better

@wylieconlon wylieconlon merged commit f49ecb3 into elastic:master Jun 23, 2021
@kibanamachine kibanamachine mentioned this pull request Jun 23, 2021
Merged
kibanamachine pushed a commit to kibanamachine/kibana that referenced this pull request Jun 23, 2021
@kibanamachine
Update chart reference docs (elastic#102430)
3a07f43 
* Update chart reference docs

* Update from feedback

* Update from review feedback

* Update more from comments

* Apply left alignment
@kibanamachine
Copy link
Contributor

💚 Backport successful

Status Branch Result
✅ 7.x

This backport PR will be merged automatically after passing CI.

@wylieconlon wylieconlon deleted the update-chart-reference branch June 23, 2021 13:58
kibanamachine added a commit that referenced this pull request Jun 23, 2021
@kibanamachine
Update chart reference docs (#102430) (#103093)
77d269f 
* Update chart reference docs

* Update from feedback

* Update from review feedback

* Update more from comments

* Apply left alignment

Co-authored-by: Wylie Conlon <william.conlon@elastic.co>
@dej611 dej611 mentioned this pull request Jul 9, 2021
Open
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@KOTungseth KOTungseth KOTungseth approved these changes

@flash1293 flash1293 flash1293 approved these changes

@dej611 dej611 dej611 approved these changes

Assignees
No one assigned
Labels
auto-backport Deprecated - use backport:version if exact versions are needed Feature:Lens release_note:skip Skip the PR/issue when compiling release notes Team:Docs Team:Visualizations Visualization editors, elastic-charts and infrastructure v7.14.0 v8.0.0
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
6 participants
@wylieconlon @elasticmachine @flash1293 @dej611 @kibanamachine @KOTungseth