Skip to content

Clarify deployment options in Elasticsearch basics quickstart #1489

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

Open
wants to merge 5 commits into
base: main
Choose a base branch
from

Conversation

charlotte-hoblik
Copy link
Contributor

Made the quickstart intro clearer to show that that it works with any Elasticsearch deployment, not just local Docker.
Based on: https://github.com/elastic/developer-docs-team/issues/292

@charlotte-hoblik charlotte-hoblik self-assigned this May 26, 2025
@charlotte-hoblik charlotte-hoblik requested a review from a team as a code owner May 26, 2025 13:58
@charlotte-hoblik charlotte-hoblik added documentation Improvements or additions to documentation Team:Developer Issues owned by the Developer Docs Team labels May 26, 2025
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.

Suggested a slight reordering to lead with the escape hatch for users who already have a cluster, then provide a link to all deployment types and finally lead into the "OK OK I just want to spin up the fastest local cluster possible right now without reading any more docs" option :-)

You’ll need a running {{es}} cluster, together with {{kib}} to use the Dev Tools API Console. Run the following command in your terminal to set up a [single-node local cluster in Docker](get-started.md):
You can follow this guide using any {{es}} deployment. If you already have a deployment up and running, you can skip ahead to the [first step](#getting-started-index-creation).

If not, refer to [choose your deployment type](/deploy-manage/deploy#choosing-your-deployment-type) for your options. To get started quickly, you can spin up a cluster [locally in Docker](get-started.md):
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
If not, refer to [choose your deployment type](/deploy-manage/deploy#choosing-your-deployment-type) for your options. To get started quickly, you can spin up a cluster [locally in Docker](get-started.md):
If not, refer to [choose your deployment type](/deploy-manage/deploy.md#choosing-your-deployment-type) for your options. To get started quickly, you can spin up a cluster [locally in Docker](get-started.md):

Copy link
Contributor

Choose a reason for hiding this comment

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

my fault I think 🙈

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation Team:Developer Issues owned by the Developer Docs Team
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants