From 66644ef9b4899c929683273573f6ddf3687f2bd0 Mon Sep 17 00:00:00 2001 From: Liam Thompson Date: Mon, 28 Oct 2024 11:51:57 +0100 Subject: [PATCH 1/4] Update quickstart overview, add local install instructions --- .../full-text-filtering-tutorial.asciidoc | 13 +++++++++++++ .../quickstart/getting-started.asciidoc | 15 ++++++++++----- docs/reference/quickstart/index.asciidoc | 19 +++++++++++++++---- 3 files changed, 38 insertions(+), 9 deletions(-) diff --git a/docs/reference/quickstart/full-text-filtering-tutorial.asciidoc b/docs/reference/quickstart/full-text-filtering-tutorial.asciidoc index 46cadc19f2547..1e8be38a8f53c 100644 --- a/docs/reference/quickstart/full-text-filtering-tutorial.asciidoc +++ b/docs/reference/quickstart/full-text-filtering-tutorial.asciidoc @@ -19,6 +19,19 @@ The goal is to create search queries that enable users to: To achieve these goals we'll use different Elasticsearch queries to perform full-text search, apply filters, and combine multiple search criteria. +[discrete] +[[full-text-filter-tutorial-requirements]] +== Requirements + +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 <>: + +[source,sh] +---- +curl -fsSL https://elastic.co/start-local | sh +---- +// NOTCONSOLE + [discrete] [[full-text-filter-tutorial-create-index]] === Step 1: Create an index diff --git a/docs/reference/quickstart/getting-started.asciidoc b/docs/reference/quickstart/getting-started.asciidoc index a6d233d8b8abc..dabee9fbfe3ff 100644 --- a/docs/reference/quickstart/getting-started.asciidoc +++ b/docs/reference/quickstart/getting-started.asciidoc @@ -15,12 +15,17 @@ You can {kibana-ref}/console-kibana.html#import-export-console-requests[convert ==== [discrete] -[[getting-started-prerequisites]] -=== Prerequisites +[[getting-started-requirements]] +== Requirements -Before you begin, you need to have a running {es} cluster. -The fastest way to get started is with a <>. -Refer to <> for other deployment options. +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 <>: + +[source,sh] +---- +curl -fsSL https://elastic.co/start-local | sh +---- +// NOTCONSOLE //// [source,console] diff --git a/docs/reference/quickstart/index.asciidoc b/docs/reference/quickstart/index.asciidoc index ed4c128392994..3cdf3077722e2 100644 --- a/docs/reference/quickstart/index.asciidoc +++ b/docs/reference/quickstart/index.asciidoc @@ -9,7 +9,15 @@ Unless otherwise noted, these examples will use queries written in <> , or see our <>. +Run the following command in your terminal to set up a <>: + +[source,sh] +---- +curl -fsSL https://elastic.co/start-local | sh +---- +// NOTCONSOLE + +Alternatively, see our <>. [discrete] [[quickstart-list]] @@ -17,15 +25,18 @@ Get started <> , or see our <>. Learn about indices, documents, and mappings, and perform a basic search using the Query DSL. * <>. Learn about different options for querying data, including full-text search and filtering, using the Query DSL. +* <>: Learn how to create embeddings for your data with `semantic_text` and query using the `semantic` query. +** <>: Learn how to combine semantic search with full-text search. +* <>: Learn how to ingest dense vector embeddings into {es}. -[discrete] -[[quickstart-python-links]] -== Working in Python +.Working in Python +****************** If you're interested in using {es} with Python, check out Elastic Search Labs: * 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]. * 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. +****************** include::getting-started.asciidoc[] include::full-text-filtering-tutorial.asciidoc[] From d230ec47b0ed19cc3291e61a1c9dfd65e9c36813 Mon Sep 17 00:00:00 2001 From: Liam Thompson Date: Mon, 28 Oct 2024 12:11:02 +0100 Subject: [PATCH 2/4] Fix heading levels --- docs/reference/quickstart/full-text-filtering-tutorial.asciidoc | 2 +- docs/reference/quickstart/getting-started.asciidoc | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/reference/quickstart/full-text-filtering-tutorial.asciidoc b/docs/reference/quickstart/full-text-filtering-tutorial.asciidoc index 1e8be38a8f53c..fee4b797da724 100644 --- a/docs/reference/quickstart/full-text-filtering-tutorial.asciidoc +++ b/docs/reference/quickstart/full-text-filtering-tutorial.asciidoc @@ -21,7 +21,7 @@ To achieve these goals we'll use different Elasticsearch queries to perform full [discrete] [[full-text-filter-tutorial-requirements]] -== Requirements +=== Requirements 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 <>: diff --git a/docs/reference/quickstart/getting-started.asciidoc b/docs/reference/quickstart/getting-started.asciidoc index dabee9fbfe3ff..03bfb62548b25 100644 --- a/docs/reference/quickstart/getting-started.asciidoc +++ b/docs/reference/quickstart/getting-started.asciidoc @@ -16,7 +16,7 @@ You can {kibana-ref}/console-kibana.html#import-export-console-requests[convert [discrete] [[getting-started-requirements]] -== Requirements +=== Requirements 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 <>: From b99f155d82004a5854b02868f2d0a5edc8948c8e Mon Sep 17 00:00:00 2001 From: Liam Thompson Date: Mon, 28 Oct 2024 12:48:46 +0100 Subject: [PATCH 3/4] Simplify start-local info, validate code sample --- .../run-elasticsearch-locally.asciidoc | 19 ++----------------- 1 file changed, 2 insertions(+), 17 deletions(-) diff --git a/docs/reference/run-elasticsearch-locally.asciidoc b/docs/reference/run-elasticsearch-locally.asciidoc index 03885132e4050..371660f2da7c9 100644 --- a/docs/reference/run-elasticsearch-locally.asciidoc +++ b/docs/reference/run-elasticsearch-locally.asciidoc @@ -42,6 +42,7 @@ To set up {es} and {kib} locally, run the `start-local` script: curl -fsSL https://elastic.co/start-local | sh ---- // NOTCONSOLE +// REVIEWED[OCT.28.2024] This script creates an `elastic-start-local` folder containing configuration files and starts both {es} and {kib} using Docker. @@ -50,29 +51,13 @@ After running the script, you can access Elastic services at the following endpo * *{es}*: http://localhost:9200 * *{kib}*: http://localhost:5601 -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. +The script generates a random password for the `elastic` user, and an API key, stored in the `.env` file. [CAUTION] ==== 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`. ==== -[discrete] -[[api-access]] -=== API access - -An API key for {es} is generated and stored in the `.env` file as `ES_LOCAL_API_KEY`. -Use this key to connect to {es} with a https://www.elastic.co/guide/en/elasticsearch/client/index.html[programming language client] or the <>. - -From the `elastic-start-local` folder, check the connection to Elasticsearch using `curl`: - -[source,sh] ----- -source .env -curl $ES_LOCAL_URL -H "Authorization: ApiKey ${ES_LOCAL_API_KEY}" ----- -// NOTCONSOLE - [discrete] [[local-dev-additional-info]] === Learn more From 05a90a72ad2f85e7022358a8dec933a34fa887c8 Mon Sep 17 00:00:00 2001 From: Liam Thompson <32779855+leemthompo@users.noreply.github.com> Date: Mon, 28 Oct 2024 13:29:48 +0100 Subject: [PATCH 4/4] better accessibility MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Co-authored-by: István Zoltán Szabó --- docs/reference/quickstart/index.asciidoc | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/reference/quickstart/index.asciidoc b/docs/reference/quickstart/index.asciidoc index 3cdf3077722e2..3fa6d53e6345d 100644 --- a/docs/reference/quickstart/index.asciidoc +++ b/docs/reference/quickstart/index.asciidoc @@ -17,7 +17,7 @@ curl -fsSL https://elastic.co/start-local | sh ---- // NOTCONSOLE -Alternatively, see our <>. +Alternatively, refer to our <>. [discrete] [[quickstart-list]]