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

[DOCS] Corrections to whats new 8.9 page. #163938

Merged
merged 1 commit into from
Aug 15, 2023

Conversation

amyjtechwriter
Copy link
Contributor

Summary

Corrections to the Whats new page for 8.9.

Original PR here with the actionable feedback.

Closes: #150

@amyjtechwriter amyjtechwriter added Team:Docs backport:skip This commit does not require backporting docs Team:ML Team label for ML (also use :ml) v8.9.0 labels Aug 15, 2023
@amyjtechwriter amyjtechwriter removed the Team:ML Team label for ML (also use :ml) label Aug 15, 2023
@github-actions
Copy link
Contributor

Documentation preview:

@amyjtechwriter amyjtechwriter marked this pull request as ready for review August 15, 2023 13:55
@elasticmachine
Copy link
Contributor

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

@amyjtechwriter amyjtechwriter added the release_note:skip Skip the PR/issue when compiling release notes label Aug 15, 2023
@amyjtechwriter amyjtechwriter requested review from a team and removed request for gchaps and jrodewig August 15, 2023 14:12
Copy link
Contributor

@lcawl lcawl left a comment

Choose a reason for hiding this comment

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

LGTM

@amyjtechwriter amyjtechwriter merged commit 970687d into elastic:8.9 Aug 15, 2023
Copy link
Contributor

@gchaps gchaps left a comment

Choose a reason for hiding this comment

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

I see that this is already merged, but there are a few things you might change for accessiblity reasons.

@@ -44,7 +44,7 @@ To learn more, check out cases in the {observability-guide}/create-cases.html[{o

[discrete]
==== Wildcard search in dashboard controls
**Dashboard** now supports searching for strings that are found within the values shown in a control. Previously, it was required for the string to be located at the start of the value in order to be found. However this is a more expensive option then just searching for the prefix, so it’s disabled by default. To enable it in **Dashboard** select Edit control > Options list settings > Contains.
You can now search for strings anywhere within a control. Previously, the string had to be located at the start of the value in order to be found. This option is disabled by default as it is a more expensive option then just searching for the prefix. To enable it in **Dashboard** select Edit control > Options list settings > Contains.
Copy link
Contributor

Choose a reason for hiding this comment

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

Shorten to "Previously, the string had to be at the start of the value."?

To enable it in Dashboard, (add comma)

We put Edit control > Options list settings > Contains in bold, as you do in the Lens section.


[discrete]
==== Step curve

**Lens** now supports three new options for line charts. The three options are straight, smooth, and step. Step curve line charts help users see clearly when data changes at irregular intervals, which helps to avoid misinterpretation. When creating visualizations select **Line** in the visualization type dropdown. Then use the visual options menu to choose between straight, smooth, or step in the Line interpolation dropdown.
**Lens** now supports a new line interpolation option for line charts. Step curve line charts help users see clearly when data changes at irregular intervals, reducing misinterpretation. When creating visualizations select **Line** in the visualization type dropdown. Then use the **Visual options** menu to choose step in the **Line interpolation** dropdown.
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** now supports a new line interpolation option for line charts. Step curve line charts help users see clearly when data changes at irregular intervals, reducing misinterpretation. When creating visualizations select **Line** in the visualization type dropdown. Then use the **Visual options** menu to choose step in the **Line interpolation** dropdown.
**Lens** now supports a line interpolation option for line charts. Step curve line charts help users clearly understand when data changes at irregular intervals, reducing misinterpretation. When creating visualizations, select **Line** in the visualization type dropdown. Then use the **Visual options** menu to choose step in the **Line interpolation** dropdown.

Avoid "see" for accessibility reasons
Missing comma


[role="screenshot"]
image::images/stepcurve.gif[An short video displaying the three new chart options]

[discrete]
==== Significance (significant terms)

This new ranking method in the top values breakdown displays data by significance (significant terms). It permits us to get the terms that are important and likely the most critical for a given query. It’s a powerful way to find anomalies in your data with multiple use cases. Read more {ref}/search-aggregations-bucket-significantterms-aggregation.html[here].
This is not just based on the most popular terms in a set. When calculating significant terms, Elasticsearch looks for significant changes in popularity of a specific term between two sets of data. A foreground set (the data returned by a query) and a background set (the data in our indices). This is supported on all charts.
This new ranking method in the top values breakdown displays data by significance (significant terms). It helps you identify the key and most crucial terms for a specific query. It’s a powerful way to find anomalies in your data with multiple use cases. Read more {ref}/search-aggregations-bucket-significantterms-aggregation.html[here].
Copy link
Contributor

Choose a reason for hiding this comment

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

Using "here" for a link is not good for accessibility. Instead say something specific like, "Refer to the xxx docs".


[role="screenshot"]
image::images/significant-terms.png[Example of a donut chart organized by significant terms, width=70%]

[discrete]
==== Tag cloud

You can now create a word cloud in **Lens** using Tag cloud, which is currently in technical preview. When creating new visualizations, select **Tag cloud** in the visualization type dropdown. From the available fields drag and drop the desired field into the workspace to visualize keywords.
preview:[] You can now create a word cloud in **Lens** using Tag cloud, which is currently in technical preview. When creating new visualizations, select **Tag cloud** in the visualization type dropdown. From the available fields drag and drop the desired field into the workspace to visualize keywords.
Copy link
Contributor

Choose a reason for hiding this comment

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

Because you have preview at the beginning, you don't need "which is currently in technical preview".

Command after "From the available fields,"

amyjtechwriter added a commit that referenced this pull request Aug 22, 2023
## Summary

Accessibility feedback added to [whats-new page for
8.9.](https://www.elastic.co/guide/en/kibana/8.9/whats-new.html)

Based on feedback from: #163938

---------

Co-authored-by: István Zoltán Szabó <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
backport:skip This commit does not require backporting docs release_note:skip Skip the PR/issue when compiling release notes Team:Docs v8.9.0
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants