Skip to content

[New search IA] Adds Set up section - #8603

Open
kosabogi wants to merge 61 commits into
mainfrom
search-ia-set-up
Open

kosabogi wants to merge 61 commits into
mainfrom
search-ia-set-up

Conversation

@kosabogi

@kosabogi kosabogi commented Sep 30, 2026 •

Copy link
Copy Markdown
Member

This PR introduces a Set up section for Elasticsearch search. It walks through choosing where Elasticsearch runs, getting an endpoint and API key, and connecting a language client.

Set up Elasticsearch for search: section overview

Related issues:

Fixes #8602
#8601

@kosabogi
kosabogi requested review from a team as code owners September 30, 2026 11:47
@kosabogi
kosabogi marked this pull request as draft September 30, 2026 11:48
@github-actions

Copy link
Copy Markdown
Contributor

Elastic Docs AI PR menu

Check the box to run an AI review for this pull request.

  • Review docs changes (docs-review). Status: not started.

Powered by GitHub Agentic Workflows and docs-actions. For more information, reach out to the docs team.

@github-actions

Copy link
Copy Markdown
Contributor

✅ Elastic Docs Style Checker (Vale)

No issues found on modified lines!


The Vale linter checks documentation changes against the Elastic Docs style guide. To use Vale locally or report issues, refer to Elastic style guide for Vale.

Comment thread solutions/search/set-up/api-key-and-endpoints.md Outdated
@kosabogi
kosabogi marked this pull request as ready for review October 8, 2026 11:26
@kosabogi
kosabogi requested review from a team as code owners October 8, 2026 11:26

@leemthompo leemthompo left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

The flow is looking tighter now, but I still have some issues around the "start a deployment' step, and some language suggestions.

(Ideally we'd have onboarding tokens for free trials that weren't just vector too eventually)

Comment thread solutions/search/set-up/choose-a-deployment-type.md Outdated
Comment thread solutions/search/set-up/choose-a-deployment-type.md Outdated
Comment thread solutions/search/set-up/choose-a-deployment-type.md Outdated
Comment thread solutions/search/set-up/choose-a-deployment-type.md Outdated
Comment thread solutions/search/set-up/choose-a-deployment-type.md Outdated
Comment thread solutions/search/set-up.md Outdated
Comment thread error-start-local.log Outdated
Comment thread solutions/elasticsearch-solution-project/_snippets/find-elasticsearch-endpoint.md Outdated
kosabogi and others added 4 commits October 12, 2026 10:16
Co-authored-by: Liam Thompson <leemthompo@gmail.com>
Co-authored-by: Liam Thompson <leemthompo@gmail.com>
Co-authored-by: Liam Thompson <leemthompo@gmail.com>
Co-authored-by: Liam Thompson <leemthompo@gmail.com>
kosabogi and others added 2 commits October 22, 2026 15:05
Co-authored-by: Liam Thompson <leemthompo@gmail.com>
Co-authored-by: Liam Thompson <leemthompo@gmail.com>

@shainaraskas shainaraskas left a comment •

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

a couple of categories of comments:

  • some positioning around deployment types (minor)
  • some issues with the api key + endpoint retrieval instructions (unfortunately the ground keeps shifting under our feet here)
  • some stepper/formatting/blahblah nits

Comment thread solutions/search/set-up.md Outdated

# Choose an {{es}} deployment type [choose-a-deployment-type]

{{es}} is at the core of every Elastic deployment type. The deployment type you choose determines who manages the infrastructure, scaling, and upgrades, and how usage is billed. Use this page to compare the options and find the best fit for your operational needs.

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

I think we're not doing any comparison on this page at all. instead, this page just says "pick one, here's the bare minimum info" -> "run a quickstart". positioning could use some work

would be a step forward to organize around decision criteria rather than the deployment type

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

instead, this page just says "pick one, here's the bare minimum info"

i think that's intended because otherwise this page shouldn't exist tbh, because if we expand the scope of this page to more comprehensive decision criteria

honestly not sure we need another page like that outside of deploy/manage and i have struggled with whether this new page should exist at all

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

that's fine - it's just that the title and framing of the page don't match what's happening on the page, so readers might feel shortchanged.

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

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

I think Shaina has a good point, the title and intro position this page as something different from what it actually is. That happened because we went through a few iterations and the focus shifted a bit. I’d suggest rewriting the title to “Get {{es}} running for search” and updating the intro to:

{{es}} is at the core of every Elastic deployment type. The deployment type you choose determines who manages the infrastructure, scaling, and upgrades, and how usage is billed. This page briefly introduces the deployment types you can use to get {{es}} running quickly, and points you to resources that compare them in detail.

Comment thread solutions/search/set-up/get-elasticsearch-running-for-search.md
Comment thread solutions/search/set-up/choose-a-deployment-type.md Outdated
Comment thread solutions/search/set-up/api-key-and-endpoints.md Outdated
Comment thread solutions/elasticsearch-solution-project/search-connection-details.md Outdated
Comment thread solutions/search/set-up/connect-with-an-sdk.md
Comment thread solutions/search/set-up/connect-with-an-sdk.md Outdated
Comment thread solutions/search/set-up/connect-with-an-sdk.md Outdated
Co-authored-by: shainaraskas <58563081+shainaraskas@users.noreply.github.com>
kosabogi and others added 10 commits October 26, 2026 11:31
Co-authored-by: shainaraskas <58563081+shainaraskas@users.noreply.github.com>
Co-authored-by: shainaraskas <58563081+shainaraskas@users.noreply.github.com>
…csearch-endpoint.md

Co-authored-by: shainaraskas <58563081+shainaraskas@users.noreply.github.com>
…csearch-endpoint.md

Co-authored-by: shainaraskas <58563081+shainaraskas@users.noreply.github.com>
…csearch-endpoint.md

Co-authored-by: shainaraskas <58563081+shainaraskas@users.noreply.github.com>
…csearch-endpoint.md

Co-authored-by: shainaraskas <58563081+shainaraskas@users.noreply.github.com>
…csearch-endpoint.md

Co-authored-by: shainaraskas <58563081+shainaraskas@users.noreply.github.com>
…csearch-endpoint.md

Co-authored-by: shainaraskas <58563081+shainaraskas@users.noreply.github.com>
…csearch-endpoint.md

Co-authored-by: shainaraskas <58563081+shainaraskas@users.noreply.github.com>
…csearch-endpoint.md

Co-authored-by: shainaraskas <58563081+shainaraskas@users.noreply.github.com>
kosabogi and others added 4 commits October 26, 2026 12:15
Co-Authored-By: Claude Sonnet 5.5 <noreply@anthropic.com>
…csearch-endpoint.md

Co-authored-by: shainaraskas <58563081+shainaraskas@users.noreply.github.com>
@kosabogi
kosabogi requested a review from shainaraskas October 26, 2026 15:38

@shainaraskas shainaraskas left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

thanks for addressing all of the feedback 🙏 I've commented a couple more things to consider - nothing blocking


:::::::{stepper}

::::::{step} Connect to {{es}}

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

perhaps "Set environment variables" ?

:::::

::::::
:::::{dropdown} Example responses

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

I think this would be nicer with an example response in each tab in the tabset above but will not block on that basis

1. [](/solutions/search/set-up/get-elasticsearch-running-for-search.md): Compare fully managed and self-managed options, and select the one that fits how much infrastructure you want to run.
2. [](/solutions/search/set-up/api-key-and-endpoints.md): Find your endpoint URL and create an API key.
3. If you want to connect programmatically, you can [connect with an SDK](/solutions/search/set-up/connect-with-an-sdk.md), install a language client, and send a request from code. You can also get started with {{es}} in the {{kib}} [{{dev-tools-app}} Console](/explore-analyze/query-filter/tools/console.md).
3. [Connect programmatically](/solutions/search/set-up/connect-with-an-sdk.md): Connect with an SDK, install a language client, and send a request from code. If you don't want to connect programmatically, you can also get started with {{es}} in the {{kib}} [{{dev-tools-app}} Console](/explore-analyze/query-filter/tools/console.md).

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

is the sdk step and the client install step separate really? usually sdks and clients are somewhat synonymous

does not mirror the steps in the linked tutorial (also the titles are now slightly out of sync)

shainaraskas

This comment was marked as duplicate.

This branch was successfully deployed

1 active deployment
docs-preview — 724fca62 Deployed Oct 26, 2026 by github-actions[bot]
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.

Add the Set up section of the new search IA

5 participants