Skip to content

Commit 687c591

Browse files
committed
Update quickstart overview, add local install instructions (#115746)
(cherry picked from commit ab558e6)
1 parent 821fccf commit 687c591

File tree

4 files changed

+40
-26
lines changed

4 files changed

+40
-26
lines changed

docs/reference/quickstart/full-text-filtering-tutorial.asciidoc

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -19,6 +19,19 @@ The goal is to create search queries that enable users to:
1919

2020
To achieve these goals we'll use different Elasticsearch queries to perform full-text search, apply filters, and combine multiple search criteria.
2121

22+
[discrete]
23+
[[full-text-filter-tutorial-requirements]]
24+
=== Requirements
25+
26+
You'll need a running {es} cluster, together with {kib} to use the Dev Tools API Console.
27+
Run the following command in your terminal to set up a <<run-elasticsearch-locally,single-node local cluster in Docker>>:
28+
29+
[source,sh]
30+
----
31+
curl -fsSL https://elastic.co/start-local | sh
32+
----
33+
// NOTCONSOLE
34+
2235
[discrete]
2336
[[full-text-filter-tutorial-create-index]]
2437
=== Step 1: Create an index

docs/reference/quickstart/getting-started.asciidoc

Lines changed: 10 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -15,12 +15,17 @@ You can {kibana-ref}/console-kibana.html#import-export-console-requests[convert
1515
====
1616

1717
[discrete]
18-
[[getting-started-prerequisites]]
19-
=== Prerequisites
18+
[[getting-started-requirements]]
19+
=== Requirements
2020

21-
Before you begin, you need to have a running {es} cluster.
22-
The fastest way to get started is with a <<run-elasticsearch-locally,local development environment>>.
23-
Refer to <<elasticsearch-intro-deploy,Run {es}>> for other deployment options.
21+
You'll need a running {es} cluster, together with {kib} to use the Dev Tools API Console.
22+
Run the following command in your terminal to set up a <<run-elasticsearch-locally,single-node local cluster in Docker>>:
23+
24+
[source,sh]
25+
----
26+
curl -fsSL https://elastic.co/start-local | sh
27+
----
28+
// NOTCONSOLE
2429

2530
////
2631
[source,console]

docs/reference/quickstart/index.asciidoc

Lines changed: 15 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -9,23 +9,34 @@ Unless otherwise noted, these examples will use queries written in <<query-dsl,Q
99
== Requirements
1010

1111
You'll need a running {es} cluster, together with {kib} to use the Dev Tools API Console.
12-
Get started <<run-elasticsearch-locally,locally in Docker>> , or see our <<elasticsearch-intro-deploy,other deployment options>>.
12+
Run the following command in your terminal to set up a <<run-elasticsearch-locally,single-node local cluster in Docker>>:
13+
14+
[source,sh]
15+
----
16+
curl -fsSL https://elastic.co/start-local | sh
17+
----
18+
// NOTCONSOLE
19+
20+
Alternatively, refer to our <<elasticsearch-intro-deploy,other deployment options>>.
1321

1422
[discrete]
1523
[[quickstart-list]]
1624
== Hands-on quick starts
1725

1826
* <<getting-started,Basics: Index and search data using {es} APIs>>. Learn about indices, documents, and mappings, and perform a basic search using the Query DSL.
1927
* <<full-text-filter-tutorial, Basics: Full-text search and filtering>>. Learn about different options for querying data, including full-text search and filtering, using the Query DSL.
28+
* <<semantic-search-semantic-text, Semantic search>>: Learn how to create embeddings for your data with `semantic_text` and query using the `semantic` query.
29+
** <<semantic-text-hybrid-search, Hybrid search with `semantic_text`>>: Learn how to combine semantic search with full-text search.
30+
* <<bring-your-own-vectors, Bring your own dense vector embeddings>>: Learn how to ingest dense vector embeddings into {es}.
2031

21-
[discrete]
22-
[[quickstart-python-links]]
23-
== Working in Python
32+
.Working in Python
33+
******************
2434
2535
If you're interested in using {es} with Python, check out Elastic Search Labs:
2636
2737
* https://github.com/elastic/elasticsearch-labs[`elasticsearch-labs` repository]: Contains a range of Python https://github.com/elastic/elasticsearch-labs/tree/main/notebooks[notebooks] and https://github.com/elastic/elasticsearch-labs/tree/main/example-apps[example apps].
2838
* https://www.elastic.co/search-labs/tutorials/search-tutorial/welcome[Tutorial]: This walks you through building a complete search solution with {es} from the ground up using Flask.
39+
******************
2940

3041
include::getting-started.asciidoc[]
3142
include::full-text-filtering-tutorial.asciidoc[]

docs/reference/run-elasticsearch-locally.asciidoc

Lines changed: 2 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -42,6 +42,7 @@ To set up {es} and {kib} locally, run the `start-local` script:
4242
curl -fsSL https://elastic.co/start-local | sh
4343
----
4444
// NOTCONSOLE
45+
// REVIEWED[OCT.28.2024]
4546

4647
This script creates an `elastic-start-local` folder containing configuration files and starts both {es} and {kib} using Docker.
4748

@@ -50,29 +51,13 @@ After running the script, you can access Elastic services at the following endpo
5051
* *{es}*: http://localhost:9200
5152
* *{kib}*: http://localhost:5601
5253

53-
The script generates a random password for the `elastic` user, which is displayed at the end of the installation and stored in the `.env` file.
54+
The script generates a random password for the `elastic` user, and an API key, stored in the `.env` file.
5455

5556
[CAUTION]
5657
====
5758
This setup is for local testing only. HTTPS is disabled, and Basic authentication is used for {es}. For security, {es} and {kib} are accessible only through `localhost`.
5859
====
5960

60-
[discrete]
61-
[[api-access]]
62-
=== API access
63-
64-
An API key for {es} is generated and stored in the `.env` file as `ES_LOCAL_API_KEY`.
65-
Use this key to connect to {es} with a https://www.elastic.co/guide/en/elasticsearch/client/index.html[programming language client] or the <<rest-apis,REST API>>.
66-
67-
From the `elastic-start-local` folder, check the connection to Elasticsearch using `curl`:
68-
69-
[source,sh]
70-
----
71-
source .env
72-
curl $ES_LOCAL_URL -H "Authorization: ApiKey ${ES_LOCAL_API_KEY}"
73-
----
74-
// NOTCONSOLE
75-
7661
[discrete]
7762
[[local-dev-additional-info]]
7863
=== Learn more

0 commit comments

Comments
 (0)