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] Whats new page for 8.9 #162271

Merged
merged 10 commits into from
Jul 20, 2023
Merged

Conversation

amyjtechwriter
Copy link
Contributor

This PR adds details about whats new to the 8.9 release on the whats new page: https://www.elastic.co/guide/en/kibana/8.9/whats-new.html

@amyjtechwriter amyjtechwriter added Team:Docs Team:Presentation Presentation Team for Dashboard, Input Controls, and Canvas release_note:skip Skip the PR/issue when compiling release notes backport:skip This commit does not require backporting Team:ResponseOps Label for the ResponseOps team (formerly the Cases and Alerting teams) docs documentation v8.9.0 labels Jul 19, 2023
@github-actions
Copy link
Contributor

Documentation preview:

@amyjtechwriter amyjtechwriter marked this pull request as ready for review July 19, 2023 17:57
@elasticmachine
Copy link
Contributor

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

@elasticmachine
Copy link
Contributor

Pinging @elastic/kibana-presentation (Team:Presentation)

@elasticmachine
Copy link
Contributor

Pinging @elastic/response-ops (Team:ResponseOps)

Copy link
Contributor

@szabosteve szabosteve left a comment

Choose a reason for hiding this comment

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

Thanks for compiling the page, LGTM! I left a couple of comments – only nits – about writing the UI element/plugin names in bold. Please take or leave them!

docs/user/whats-new.asciidoc Outdated Show resolved Hide resolved
docs/user/whats-new.asciidoc Outdated Show resolved Hide resolved
docs/user/whats-new.asciidoc Outdated Show resolved Hide resolved
docs/user/whats-new.asciidoc Outdated Show resolved Hide resolved
docs/user/whats-new.asciidoc Outdated Show resolved Hide resolved
docs/user/whats-new.asciidoc Outdated Show resolved Hide resolved
docs/user/whats-new.asciidoc Outdated Show resolved Hide resolved
amyjtechwriter and others added 7 commits July 20, 2023 12:21
Co-authored-by: István Zoltán Szabó <[email protected]>
Co-authored-by: István Zoltán Szabó <[email protected]>
Co-authored-by: István Zoltán Szabó <[email protected]>
Co-authored-by: István Zoltán Szabó <[email protected]>
Co-authored-by: István Zoltán Szabó <[email protected]>
Co-authored-by: István Zoltán Szabó <[email protected]>
Co-authored-by: István Zoltán Szabó <[email protected]>
@amyjtechwriter amyjtechwriter merged commit f04aab7 into elastic:8.9 Jul 20, 2023
@nreese
Copy link
Contributor

nreese commented Jul 20, 2023

Looks like this enhancement did not make the list #156618

Copy link
Contributor

@jrodewig jrodewig left a comment

Choose a reason for hiding this comment

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

Thanks for putting this together, @amyjtechwriter.

Can you work with @nreese to ensure his item gets added before the 8.9 release?

I also left some less-pressing feedback that you can address after the release. I'd like you to work with @gchaps and @szabosteve to rework these docs so they look more like ones we've had in previous releases.

Thanks again!


[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.
Copy link
Contributor

Choose a reason for hiding this comment

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

This paragraph could use a rewrite. For example, we could rephrase:

Dashboard now supports searching for strings that are found within the values shown in a control.

to something like:

You can now search for strings anywhere within a control.

We should almost never use phrases like "in order to".

[discrete]
==== Stacked bar chart legend

The order of stacked bar chart legends is now based on popularity with the most important element displayed on top. You no longer need to scroll to the bottom of the legend to find the most popular data in the chart.
Copy link
Contributor

Choose a reason for hiding this comment

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

The order of stacked bar chart legends is now based on popularity with the most important element displayed on top.

"Popularity" seems like odd phrasing here. We're basically saying "ranked by value in descending order."

Instead of "most popular element," I think it's more accurate to say the "segment with the highest total value."

You no longer need to scroll to the bottom of the legend to find the most popular data in the chart.

Do we need this sentence?

Comment on lines +60 to +66
Previously:
[role="screenshot"]
image::images/oldwayhighlighted.png[Example of the old ordering of the chart legend, width=80%]

New in 8.9:
[role="screenshot"]
image::images/newwayhighlighted.png[Example of the new ordering of the chart legend, width=80%]
Copy link
Contributor

Choose a reason for hiding this comment

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

We should avoid using phrases with colons to set off images. Generally, we treat images as "enriching but optional." In this case, I'd only include a screenshot of the new image.

We may also want to crop the photo so the legend is more in focus. It's difficult to read right now.

[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.
Copy link
Contributor

Choose a reason for hiding this comment

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

This also needs a rewrite. We should call this out as a line interpolation option. I'm also not sure why we're mentioning in the existing "straight" or "smooth" 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].
Copy link
Contributor

Choose a reason for hiding this comment

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

It permits us to get the terms that are important and likely the most critical for a given query.

Unless providing a recommendation, avoid first person in the docs. In this case, "us" refers to the user should you should use "you" (second person).

==== 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.
Copy link
Contributor

Choose a reason for hiding this comment

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

Elasticsearch

{es}

Comment on lines +98 to +99
[role="screenshot"]
image::images/annotation.gif[Example of how to save an annotation group to the visualize library]
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 bump up the size of the GIF here? It's hard for me to see?


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.

For items in technical preview, we should include a preview:[] admonition, similar to the ML one below.

@amyjtechwriter amyjtechwriter mentioned this pull request Jul 24, 2023
amyjtechwriter added a commit that referenced this pull request Jul 24, 2023
## Summary

Adding spatial join information to the whats new page for 8.9

Relates to: #162271

---------

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 documentation release_note:skip Skip the PR/issue when compiling release notes Team:Docs Team:Presentation Presentation Team for Dashboard, Input Controls, and Canvas Team:ResponseOps Label for the ResponseOps team (formerly the Cases and Alerting teams) v8.9.0
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants