Repository navigation
Conversation
Elastic Docs AI PR menuCheck the box to run an AI review for this pull request.
Powered by GitHub Agentic Workflows and docs-actions. For more information, reach out to the docs team. |
✅ 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. |
leemthompo
left a comment
There was a problem hiding this comment.
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)
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>
Co-authored-by: Liam Thompson <leemthompo@gmail.com>
Co-authored-by: Liam Thompson <leemthompo@gmail.com>
|
|
||
| # 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. |
There was a problem hiding this comment.
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
There was a problem hiding this comment.
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
There was a problem hiding this comment.
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.
There was a problem hiding this comment.
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.
Co-authored-by: shainaraskas <58563081+shainaraskas@users.noreply.github.com>
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>
shainaraskas
left a comment
There was a problem hiding this comment.
thanks for addressing all of the feedback 🙏 I've commented a couple more things to consider - nothing blocking
|
|
||
| :::::::{stepper} | ||
|
|
||
| ::::::{step} Connect to {{es}} |
There was a problem hiding this comment.
perhaps "Set environment variables" ?
| ::::: | ||
|
|
||
| :::::: | ||
| :::::{dropdown} Example responses |
There was a problem hiding this comment.
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). |
There was a problem hiding this comment.
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)
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