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

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

Merged
merged 25 commits into from
May 31, 2021
Merged

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

Changes from 4 commits
Commits
Show all changes
25 commits
Select commit Hold shift + click to select a range
138e63b
:memo: Add more QA for Lens
dej611 Apr 14, 2021
0b29dbf
:fire: Remove duplicate
dej611 Apr 14, 2021
460489d
Update docs/user/dashboard/lens.asciidoc
dej611 Apr 27, 2021
971ea11
Update docs/user/dashboard/lens.asciidoc
dej611 Apr 27, 2021
f472ab2
Update docs/user/dashboard/lens.asciidoc
dej611 Apr 28, 2021
20470e8
:memo: Fix few issues based on feedback + new faq
dej611 Apr 28, 2021
c65265c
:camera: Add missing picture
dej611 Apr 28, 2021
876116e
Update docs/user/dashboard/lens.asciidoc
dej611 May 5, 2021
691b061
Update docs/user/dashboard/lens.asciidoc
dej611 May 5, 2021
7db8640
Update docs/user/dashboard/lens.asciidoc
dej611 May 5, 2021
2cbf9ef
Update docs/user/dashboard/lens.asciidoc
dej611 May 5, 2021
0aa77f4
Update docs/user/dashboard/lens.asciidoc
dej611 May 5, 2021
d80ef91
Update docs/user/dashboard/lens.asciidoc
dej611 May 5, 2021
e4f9717
Update docs/user/dashboard/lens.asciidoc
dej611 May 5, 2021
bf4db3d
Update docs/user/dashboard/lens.asciidoc
dej611 May 6, 2021
634d6ce
Update docs/user/dashboard/lens.asciidoc
dej611 May 6, 2021
062319d
Update docs/user/dashboard/lens.asciidoc
dej611 May 6, 2021
444d2f7
Update docs/user/dashboard/lens.asciidoc
dej611 May 6, 2021
c8d901e
Update docs/user/dashboard/lens.asciidoc
dej611 May 6, 2021
36e0619
Update docs/user/dashboard/lens.asciidoc
dej611 May 6, 2021
088a107
Update docs/user/dashboard/lens.asciidoc
dej611 May 6, 2021
9c4f409
Update docs/user/dashboard/lens.asciidoc
dej611 May 6, 2021
5e4a260
:ok_hand: Integrated feedback
dej611 May 14, 2021
8ad9cd4
:ok_hand: More feedback
dej611 May 14, 2021
af21cc0
Merge branch 'master' into fix/more-lens-faq
kibanamachine May 26, 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
47 changes: 46 additions & 1 deletion docs/user/dashboard/lens.asciidoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -156,11 +156,15 @@ A subset of *Lens* visualizations support value labels.
[role="screenshot"]
image::images/lens_value_labels_xychart_toggle.png[Lens Bar chart value labels menu]

Note: it is not possible yet to control the labels position in bar visualizations.
dej611 marked this conversation as resolved.
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.


[float]
[[what-is-the-other-category]]
===== What data is categorized as Other?
Expand Down Expand Up @@ -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 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.

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.


[float]
[[is-it-possible-to-use-saved-serches-in-lens]]
Expand All @@ -220,3 +227,41 @@ Visualizing saved searches in unsupported in *Lens*.
===== How do I change the number of suggestions?

Configuring the *Suggestions* that *Lens* automatically populates is unsupported.

[float]
[[is-it-possible-to-use-different-indexpatterns-in-lens]]
===== Is it possible to use different index patterns in a single visualization?
dej611 marked this conversation as resolved.
Show resolved Hide resolved

You can create a visualization from multiple index patterns in *Lens*: this feature is available for a subset of visualizations such as *Bar*, *Line* and *Area* charts.
dej611 marked this conversation as resolved.
Show resolved Hide resolved

Each *Layer* in a visualization is associated with an index pattern and mutiple *Layers* can be combined together within the same visualization. Each *Layer* also has a chart switcher button in order to select the best type of visualization for the specific dataset.
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
Each *Layer* in a visualization is associated with an index pattern and mutiple *Layers* can be combined together within the same visualization. Each *Layer* also has a chart switcher button in order to select the best type of visualization for the specific dataset.
Each chart *Layer* is associated with an index pattern, and you can combine multiple *Layers* in the same chart. Each *Layer* also has a menu to change the visualization type, which allows you to select the best type of visualization for the data.

Copy link
Contributor

Choose a reason for hiding this comment

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

Since this section is about using multiple index patterns, is this sentence necessary?

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 think that, while it may sounds a distinct issue, there is often a correlation between overlaying different charts types from different index patterns.

At the same time it is possible to dynamically change the indexpattern for the *Layer* when required.
dej611 marked this conversation as resolved.
Show resolved Hide resolved

[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 👏🏼

dej611 marked this conversation as resolved.
Show resolved Hide resolved

*Lens* does not support the visualization of full-text fields, therefore it is not showing them in the data summary.
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* does not support the visualization of full-text fields, therefore it is not showing them in the data summary.
Creating visualizations with full-text fields is unsupported in *Lens*. When your index pattern contains a full-text field, *Lens* displays the `X.keyword` field, but is unable to display the data summary.

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 think the suggested version is not correct, as it assumes always the availability of the X.keyword field for each full-text field, while this is not true.

Copy link
Contributor

Choose a reason for hiding this comment

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

How about:

Creating visualizations with full-text fields is unsupported in Lens. When your index pattern contains full-text fields, the fields do not appear in the data summaries.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

The bits of information to communicate, I think, are the following three:

  • Lens does not support full-text fields
  • If a full-text field has also keyword subfield then the latter is shown
  • Data summaries are not available for full-text fields, even when the keyword subfield is available.

In particular the first 2 are the most important part, while the third could be omitted if we want - it's just nice as it adds an extra bit to the essential information.

You will still see the `X.keyword` field, when available.
dej611 marked this conversation as resolved.
Show resolved Hide resolved

[float]
[[how-to-handle-gaps-in-time-series-visualizations]]
===== How to handle gaps in time series visualizations?
dej611 marked this conversation as resolved.
Show resolved Hide resolved

*Lens* provides a set of features to handle missing values for *Area* and *Line* visualization.
dej611 marked this conversation as resolved.
Show resolved Hide resolved
This is useful for sparse data in time series.
dej611 marked this conversation as resolved.
Show resolved Hide resolved

To select a different way to represent missing values, click on the *brush* button above the visualization in the editor to see a selection of strategies to handle missing values. The default strategy is to hide the gaps.
dej611 marked this conversation as resolved.
Show resolved Hide resolved
dej611 marked this conversation as resolved.
Show resolved Hide resolved

[float]
[[is-it-possible-to-change-the-scale-of-Y-axis]]
===== Is it possible to change the scale of the Y axis in a visualization?
dej611 marked this conversation as resolved.
Show resolved Hide resolved

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!


[float]
[[is-it-possible-to-have-more-than-one-Y-axis-scale]]
===== Is it possible to have more than one Y axis scale in visualization?
dej611 marked this conversation as resolved.
Show resolved Hide resolved

*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.