Skip to content

Conversation

ketkee-aryamane
Copy link
Contributor

Linked to #3564
Adds a warning to the UI navigation instructions for Search apps.

@ketkee-aryamane ketkee-aryamane requested a review from a team as a code owner October 21, 2025 12:20
@github-actions
Copy link

github-actions bot commented Oct 21, 2025

🔍 Preview links for changed docs

Copy link
Member

@kderusso kderusso left a comment

Choose a reason for hiding this comment

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

Is this type of warning something we typically call out in our docs? I don't remember us adding warning for previous nav changes, including when we removed app search from the nav. I'll defer to @leemthompo if this is necessary or not.

Copy link
Contributor

@leemthompo leemthompo left a comment

Choose a reason for hiding this comment

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

Thanks, just some minor comments

```{applies_to}
serverless: unavailable
```
::::{warning}
Copy link
Contributor

Choose a reason for hiding this comment

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

We can add applies_to's to admonitions now, so we don't have to spell out the deployment stuff in prose.

See https://elastic.github.io/docs-builder/syntax/admonitions/#applies-to-information

@leemthompo
Copy link
Contributor

leemthompo commented Oct 21, 2025

Is this type of warning something we typically call out in our docs?

I think it makes sense because folks running pre 9.2 deployments will still have access to the feature. It differs from the App Search case, because App Search disappeared in a major bump that coincided with docs migration for 9.0. I'd say it's a 70/30 call, but not a huge difference either way :-)

The alternative would be to use applies_to's to say that the feature is available in 9.0-9.1 but unavailable in 9.2. Same message, but less visible and I think the callout edges it in terms of clarity.

Copy link
Contributor

@leemthompo leemthompo left a comment

Choose a reason for hiding this comment

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

@ketkee-aryamane
Copy link
Contributor Author

ketkee-aryamane commented Oct 21, 2025

@kderusso
Could we also recommend users to use https://www.elastic.co/docs/solutions/search/search-templates instead of search apps in the warning?

@leemthompo
Copy link
Contributor

Could we also recommend users to use https://www.elastic.co/docs/solutions/search/search-templates instead of search apps in the warning?

That's a good idea, much better than just an unavailable warning 👍

"We recommended building with search templates instead."

In fact we could also have this recommendation at the top of each page TBH.

@kderusso
Copy link
Member

I'm a little on the fence for the redirect, because if people are using search applications for the endpoint then that won't be an applicable replacement.

@leemthompo
Copy link
Contributor

I'm a little on the fence for the redirect, because if people are using search applications for the endpoint then that won't be an applicable replacement.

Right maybe if we are clear that this would be a recommendation for brand new users who haven't yet used any Search
Applications functionalities. But perhaps it's too messy either way.

@leemthompo
Copy link
Contributor

leemthompo commented Oct 21, 2025

@ketkee-aryamane I vote we merge this now as is, and we can revisit adding additional recommendations when the API conversation matures

@ketkee-aryamane ketkee-aryamane merged commit 5fb67e3 into main Oct 23, 2025
7 checks passed
@ketkee-aryamane ketkee-aryamane deleted the add-warning-in-searchapps-page branch October 23, 2025 08:20
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants