Improve visibility and copy of SQL in-product help

[gchaps]

Per #147481, the user did not find the in-product SQL reference doc. Is there something we can do to make it more visible? Add SQL reference to the Help menu when the user changes to SQL?

Here is a proposal for a more specific title to the popup and streamlined intro text that is easier to scan.

About Elasticsearch SQL

Use Elasticsearch SQL to search and aggregate data inside Elasticsearch. This query language provides full text search with a familiar syntax. Here is an example query:

Elasticsearch SQL:

• Provides a comprehensive set of built-in operators and functions.
• Follows SQL terminology and conventions.
• Accepts one command per line. A command is a sequence of tokens terminated by the end of input stream

[elasticmachine]

Pinging @elastic/kibana-visualizations @elastic/kibana-visualizations-external (Team:Visualizations)

[stratoula]

Maybe we just need to also add a link to the documentation (elasticsearch docs) on the advanced settings. Still SQL is on tech preview and we target ESQL for now.

I can do the documentation fixes, about the visibility I will ping @MichaelMarcialis, he might have some ideas

[MichaelMarcialis]

If it's been found that there is a pattern of users not being able to discover the SQL in-product documentation in the unified search interface, there are a few things that come to mind that we can do to increase visibility, such as:

• Reorder documentation button to appear before the expanded/compact mode button.
• Supplement button icon with text (ex. "SQL reference).

However, before we make any such changes, has there been a pattern of this sort of feedback? Or is this the first noted instance of a user missing the in-product documentation? If this is only the first instance, I'd hesitate to make any knee-jerk changes. I'd prefer we first establish that there is a pattern of users not being able to find the documentation before making changes. It's hard to judge by the Full Story metrics, since very few users are turning on the SQL feature, but the documentation button does appear to be getting at least some traction in those cases. If we prefer to be proactive about it, perhaps we can involve the user research team to see about performing some discoverability testing on it. Thoughts?

[elasticmachine]

Pinging @elastic/kibana-esql (Team:ESQL)

[stratoula]

I am closing this as we did changed the position of the button and the icon and I havent received any feedback lately about the discoverability.