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.

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

[Lens] [Docs] Add more QA for Lens #97142

Merged
merged 25 commits into from
May 31, 2021
Merged

Conversation

dej611
Copy link
Contributor

@dej611 dej611 commented Apr 14, 2021

Summary

Fixes #81780

this new batch of Q&A adds some more limitations based on some real forum questions to the Lens page.

I've also tried to fill some missing bits of information within existing answers.
The percentage/filter ratio page is coming through a different PR.

Checklist

  • Documentation was added for features that require explanation or tutorials

@elasticmachine
Copy link
Contributor

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

@dej611 dej611 added the release_note:skip Skip the PR/issue when compiling release notes label Apr 21, 2021
@spalger spalger added v7.14.0 and removed v7.13.0 labels Apr 21, 2021
@dej611 dej611 requested a review from KOTungseth April 27, 2021 10:07

[float]
[[why-my-field-x-is-missing-from-the-fields-list]]
===== Why is my field X missing from the fields list in Lens?
Copy link
Contributor

Choose a reason for hiding this comment

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

that's a good one, I saw this like 3 times in Discuss forum 👏🏼

[[is-it-possible-to-change-the-scale-of-Y-axis]]
===== Is it possible to change the scale of the Y axis in a visualization?

At the moment it is not possible to change the scale of the Y axis (for instance, making it start from another value than 0) in *Lens*.
Copy link
Contributor

Choose a reason for hiding this comment

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

Nit: Maybe it would be worth mentioning that at the moment we only support linear scale.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Good catch!

Copy link
Contributor

@mbondyra mbondyra left a comment

Choose a reason for hiding this comment

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

This looks very useful. All my comments are just suggestions that feel more understandable to me so feel free to not use them.

dej611 and others added 5 commits April 27, 2021 15:36
Co-authored-by: Marta Bondyra <marta.bondyra@gmail.com>
Co-authored-by: Marta Bondyra <marta.bondyra@gmail.com>
Co-authored-by: Marta Bondyra <marta.bondyra@gmail.com>
docs/user/dashboard/lens.asciidoc Outdated Show resolved Hide resolved
* *Pie*, *Donut*, and *Treemap*
+
[role="screenshot"]
image::images/lens_value_labels_partition_toggle.png[Lens Pie chart value labels menu]

Other type of visualizations do not support labels yet.
Copy link
Contributor

Choose a reason for hiding this comment

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

I don't think we need this sentence. In the intro to the section, we already say A subset of **Lens** visualizations support value labels.

@@ -207,7 +211,10 @@ refer to <<explore-fields-in-your-data,Explore the fields in your data>>.
[[is-it-possible-to-sort-dimensions-in-a-chart]]
===== How do I sort the dimensions in a chart?

Sorting dimensions in visualizations is unsupported in *Lens*.
Sorting dimensions in visualizations is unsupported in *Lens* for charts.
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
Sorting dimensions in visualizations is unsupported in *Lens* for charts.
Sorting chart dimensions is unsupported in *Lens*, but you can sort the dimensions for a single column in data tables.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I see the copy is shorter with your version, but it does not sound as clear (to me) as having two distinct sentences.

Sorting dimensions in visualizations is unsupported in *Lens*.
Sorting dimensions in visualizations is unsupported in *Lens* for charts.

Sorting is possible in *Lens* datatables, but it is limited to a single column. Click on the column header to sort by the column and select the sorting criteria.
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
Sorting is possible in *Lens* datatables, but it is limited to a single column. Click on the column header to sort by the column and select the sorting criteria.
To sort the dimension of a single column, click the column header, then select the sorting criteria you want to use.

Sorting dimensions in visualizations is unsupported in *Lens* for charts.

Sorting is possible in *Lens* datatables, but it is limited to a single column. Click on the column header to sort by the column and select the sorting criteria.
Note that if the dimension is used within the `Columns` (transposed) then all columns that belong to the same dimension will be sorted.
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
Note that if the dimension is used within the `Columns` (transposed) then all columns that belong to the same dimension will be sorted.
If the dimension is used within the transposed `Columns`, then all columns that belong to the same dimension are sorted.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Your version sounds better. I guess the only pending issue is to understand how to call the new transposed feature for data tables. I'll check the release notes for some reference.

Copy link
Contributor

Choose a reason for hiding this comment

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

The definition of transpose is "to change the relative position, order, or sequence of; cause to change places; interchange"

I suggest change this to:

If you use the dimension in the reordered columns, then all columns that belong to the same dimension are sorted.

docs/user/dashboard/lens.asciidoc Outdated Show resolved Hide resolved
docs/user/dashboard/lens.asciidoc Outdated Show resolved Hide resolved
docs/user/dashboard/lens.asciidoc Outdated Show resolved Hide resolved
docs/user/dashboard/lens.asciidoc Outdated Show resolved Hide resolved
[[is-it-possible-to-have-more-than-one-Y-axis-scale]]
===== Is it possible to have more than one Y axis scale in visualization?

*Lens* lets you pick, for each Y dimension, up to two distinct axis: *left* and *right*. Each axis can have a different scale.
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
*Lens* lets you pick, for each Y dimension, up to two distinct axis: *left* and *right*. Each axis can have a different scale.
For each y-axis in the editor, *Lens* supports *left* and *right* axes. Each axis can have a different scale.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

For each y-axis in the editor

It does not sound not to immediate to me exactly what it meant.

dej611 and others added 3 commits May 5, 2021 10:16
Co-authored-by: Kaarina Tungseth <kaarina.tungseth@elastic.co>
Co-authored-by: Kaarina Tungseth <kaarina.tungseth@elastic.co>
Co-authored-by: Kaarina Tungseth <kaarina.tungseth@elastic.co>
dej611 and others added 14 commits May 5, 2021 10:20
Co-authored-by: Kaarina Tungseth <kaarina.tungseth@elastic.co>
Co-authored-by: Kaarina Tungseth <kaarina.tungseth@elastic.co>
Co-authored-by: Kaarina Tungseth <kaarina.tungseth@elastic.co>
Co-authored-by: Kaarina Tungseth <kaarina.tungseth@elastic.co>
Co-authored-by: Kaarina Tungseth <kaarina.tungseth@elastic.co>
Co-authored-by: Kaarina Tungseth <kaarina.tungseth@elastic.co>
Co-authored-by: Kaarina Tungseth <kaarina.tungseth@elastic.co>
Co-authored-by: Kaarina Tungseth <kaarina.tungseth@elastic.co>
Co-authored-by: Kaarina Tungseth <kaarina.tungseth@elastic.co>
Co-authored-by: Kaarina Tungseth <kaarina.tungseth@elastic.co>
Co-authored-by: Kaarina Tungseth <kaarina.tungseth@elastic.co>
Co-authored-by: Kaarina Tungseth <kaarina.tungseth@elastic.co>
@dej611
Copy link
Contributor Author

dej611 commented May 14, 2021

Integrated most of the feedback @KOTungseth . Maybe we can discuss offline these remaining point?

@dej611
Copy link
Contributor Author

dej611 commented May 26, 2021

@elasticmachine merge upstream

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

@wylieconlon wylieconlon left a comment

Choose a reason for hiding this comment

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

LGTM! I read through the changes here and they look accurate and good to ship, I think the areas you've pushed back on in the comments are also more accurate as written here.


[float]
[[why-my-field-x-is-missing-from-the-fields-list]]
===== Why is my field X missing from the fields list?
Copy link
Contributor

Choose a reason for hiding this comment

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

There are a few possible reasons for a field to be missing:

  • Full text
  • Geo (in all released versions)
  • Mapping is not supported by index patterns, like flattened or object

Also, sometimes user say "missing" when it's actually in the "empty" list. Would be nice to summarize all of these if it can be done concisely, but I don't think it's a blocker.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Makes sense. I'll merge this and revisit that particular section in a subsequent PR

@dej611 dej611 merged commit 6c879cc into elastic:master May 31, 2021
@dej611 dej611 deleted the fix/more-lens-faq branch May 31, 2021 16:16
kibanamachine added a commit to kibanamachine/kibana that referenced this pull request May 31, 2021
Co-authored-by: Marta Bondyra <marta.bondyra@gmail.com>
Co-authored-by: Kaarina Tungseth <kaarina.tungseth@elastic.co>
Co-authored-by: Kibana Machine <42973632+kibanamachine@users.noreply.github.com>
@kibanamachine
Copy link
Contributor

💚 Backport successful

Status Branch Result
7.x

This backport PR will be merged automatically after passing CI.

kibanamachine added a commit that referenced this pull request May 31, 2021
Co-authored-by: Marta Bondyra <marta.bondyra@gmail.com>
Co-authored-by: Kaarina Tungseth <kaarina.tungseth@elastic.co>
Co-authored-by: Kibana Machine <42973632+kibanamachine@users.noreply.github.com>

Co-authored-by: Marco Liberati <dej611@users.noreply.github.com>
Co-authored-by: Marta Bondyra <marta.bondyra@gmail.com>
Co-authored-by: Kaarina Tungseth <kaarina.tungseth@elastic.co>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
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 v7.14.0 v8.0.0
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Advanced Lens documentation
7 participants