From fb2a7d6a47b475441b112a54c142eb8faf7ea2fc Mon Sep 17 00:00:00 2001 From: lcawl Date: Tue, 26 Aug 2025 09:48:27 -0700 Subject: [PATCH 1/3] Remove Elasticsearch API quickstart page --- .../self-managed/_snippets/start-local.md | 2 +- redirects.yml | 2 ++ solutions/search/api-quickstarts.md | 36 ------------------- solutions/search/get-started.md | 4 +-- solutions/search/get-started/quickstarts.md | 15 ++++---- solutions/search/querying-for-search.md | 3 +- .../serverless-elasticsearch-get-started.md | 2 +- solutions/toc.yml | 1 - 8 files changed, 16 insertions(+), 49 deletions(-) delete mode 100644 solutions/search/api-quickstarts.md diff --git a/deploy-manage/deploy/self-managed/_snippets/start-local.md b/deploy-manage/deploy/self-managed/_snippets/start-local.md index 461d3d6fa1..9c227c00f9 100644 --- a/deploy-manage/deploy/self-managed/_snippets/start-local.md +++ b/deploy-manage/deploy/self-managed/_snippets/start-local.md @@ -36,4 +36,4 @@ For more detailed information about the `start-local` setup, refer to the [READM ## Next steps [local-dev-next-steps] -Use our [quick start guides](/solutions/search/api-quickstarts.md) to learn the basics of {{es}}. +Use our [quick start guides](/solutions/search/get-started/quickstarts.md) to learn the basics of {{es}}. diff --git a/redirects.yml b/redirects.yml index 57b65585c8..2e0e737c41 100644 --- a/redirects.yml +++ b/redirects.yml @@ -330,3 +330,5 @@ redirects: # Related to https://github.com/elastic/elasticsearch/pull/133362 'solutions/search/querydsl-full-text-filter-tutorial.md': 'elasticsearch://reference/query-languages/query-dsl/full-text-filter-tutorial.md' + + 'solutions/search/api-quickstarts.md': 'solutions/search/get-started/quickstarts.md' \ No newline at end of file diff --git a/solutions/search/api-quickstarts.md b/solutions/search/api-quickstarts.md deleted file mode 100644 index 5ea765f4f4..0000000000 --- a/solutions/search/api-quickstarts.md +++ /dev/null @@ -1,36 +0,0 @@ ---- -mapped_pages: - - https://www.elastic.co/guide/en/elasticsearch/reference/current/quickstart.html -applies_to: - stack: - serverless: -products: - - id: elasticsearch ---- -# API quickstarts - -:::{tip} -Prefer working in Python? Check out our executable [Python notebooks](https://github.com/elastic/elasticsearch-labs/tree/main/notebooks#readme) in the Elasticsearch Labs repository. -:::: - -Use the following quickstarts to get hands-on experience with Elasticsearch APIs and tools: - -- [Index and search data using Elasticsearch APIs](get-started/index-basics.md): Learn about indices, documents, and mappings, and perform a basic search using the Query DSL. -- [Basic full-text search and filtering in Elasticsearch](elasticsearch://reference/query-languages/query-dsl/full-text-filter-tutorial.md): Learn about different options for querying data, including full-text search and filtering, using the Query DSL. -- [Analyze eCommerce data with aggregations using Query DSL](/explore-analyze/query-filter/aggregations/tutorial-analyze-ecommerce-data-with-aggregations-using-query-dsl.md): Learn how to analyze data using different types of aggregations, including metrics, buckets, and pipelines. -% - [Getting started with {{esql}}](esql-getting-started.md): Learn how to query and aggregate your data using {{esql}}. -- [Search and filter with {{esql}}](elasticsearch://reference/query-languages/esql/esql-search-tutorial.md): Learn how to perform full-text and semantic search in {{esql}}, combined with filtering. -- [Semantic search](semantic-search/semantic-search-semantic-text.md): Learn how to create embeddings for your data with `semantic_text` and query using the `semantic` query. - - [Hybrid search](hybrid-semantic-text.md): Learn how to combine semantic search using`semantic_text` with full-text search. -- [Bring your own dense vector embeddings](vector/bring-own-vectors.md): Learn how to ingest dense vector embeddings into Elasticsearch. - -:::{note} -To run the quickstarts, you need a running Elasticsearch cluster. Use [`start-local`](https://github.com/elastic/start-local) to set up a fast local dev environment in Docker, together with Kibana. Run the following command in your terminal: - -```sh -curl -fsSL https://elastic.co/start-local | sh -``` -
-Alternatively, refer to our other [deployment options](/deploy-manage/index.md). -% TODO: UPDATE LINK -::: \ No newline at end of file diff --git a/solutions/search/get-started.md b/solutions/search/get-started.md index 61c0c15273..e8015fc4e9 100644 --- a/solutions/search/get-started.md +++ b/solutions/search/get-started.md @@ -28,5 +28,5 @@ Building a search experience with {{es}} requires a number of fundamental implem Each decision builds on the previous ones, offering flexibility to mix and match approaches based on your needs. ::::{tip} -Already have an {{es}} deployment? You can get started with our hands-on [quick start tutorials](api-quickstarts.md), or check out our [Python notebooks](https://github.com/elastic/elasticsearch-labs/tree/main/notebooks#readme). -:::: \ No newline at end of file +Already have an {{es}} deployment? You can get started with our hands-on [quick starts](/solutions/search/get-started/quickstarts.md), or check out our [Python notebooks](https://github.com/elastic/elasticsearch-labs/tree/main/notebooks#readme). +:::: diff --git a/solutions/search/get-started/quickstarts.md b/solutions/search/get-started/quickstarts.md index fe86e90a48..05f7494693 100644 --- a/solutions/search/get-started/quickstarts.md +++ b/solutions/search/get-started/quickstarts.md @@ -1,5 +1,8 @@ --- +mapped_pages: + - https://www.elastic.co/guide/en/elasticsearch/reference/current/quickstart.html applies_to: + stack: serverless: ga products: - id: elasticsearch @@ -7,7 +10,7 @@ products: # {{es}} quickstarts -Our quickstarts reduce your time-to-value by offering a fast path to learn about search strategies. +Quickstarts reduce your time-to-value by offering a fast path to learn about search strategies. Each quickstart provides: - A highly opinionated, fast path to a specific use case @@ -15,13 +18,13 @@ Each quickstart provides: Follow the steps in these guides to get started quickly: +- [](/solutions/search/get-started/index-basics.md) - [](/solutions/search/get-started/keyword-search-python.md) - [](/solutions/search/get-started/semantic-search.md) -- [](/solutions/search/vector/bring-own-vectors.md) - -For more advanced API examples, check out [](/solutions/search/api-quickstarts.md). ## Related resources -- [](/get-started/index.md): an introduction to Elastic -- [](/manage-data/ingest.md): an overview of data ingestion methods +- [Get started with Query DSL search and filters](elasticsearch://reference/query-languages/query-dsl/full-text-filter-tutorial.md) +- [Get started with ES|QL queries](elasticsearch://reference/query-languages/esql/esql-getting-started.md) +- [Analyze eCommerce data with aggregations using Query DSL](/explore-analyze/query-filter/aggregations/tutorial-analyze-ecommerce-data-with-aggregations-using-query-dsl.md) +- [](/solutions/search/hybrid-semantic-text.md) diff --git a/solutions/search/querying-for-search.md b/solutions/search/querying-for-search.md index 7469547aef..aa3bed22e8 100644 --- a/solutions/search/querying-for-search.md +++ b/solutions/search/querying-for-search.md @@ -33,7 +33,6 @@ These query languages are complementary, not mutually exclusive. You can use dif You can use the [{{es}} REST APIs](https://www.elastic.co/docs/api/doc/elasticsearch) to search your data using any HTTP client, including the [{{es}} client libraries](site-or-app/clients.md), or directly in [Console](/explore-analyze/query-filter/tools/console.md). You can also run searches using [Discover](/explore-analyze/discover.md) in the UI. :::: - ::::{tip} -Try our hands-on [quick start tutorials](api-quickstarts.md) to get started, or check out our [Python notebooks](https://github.com/elastic/elasticsearch-labs/tree/main/notebooks#readme). +Try our hands-on [quick starts](/solutions/search/get-started/quickstarts.md) to get started, or check out our [Python notebooks](https://github.com/elastic/elasticsearch-labs/tree/main/notebooks#readme). :::: diff --git a/solutions/search/serverless-elasticsearch-get-started.md b/solutions/search/serverless-elasticsearch-get-started.md index 56769e58c4..8b2da277a7 100644 --- a/solutions/search/serverless-elasticsearch-get-started.md +++ b/solutions/search/serverless-elasticsearch-get-started.md @@ -121,4 +121,4 @@ If you’re already familiar with Elasticsearch, you can jump right into setting ## Next steps [elasticsearch-next-steps] * Once you’ve added data to your {{es-serverless}} project, you can use [Playground](rag/playground.md) to test and tweak {{es}} queries and chat with your data, using GenAI. -* You can also try our hands-on [quick start tutorials](/solutions/search/api-quickstarts.md) in the core {{es}} documentation. +* You can also try our hands-on [quick starts](/solutions/search/get-started/quickstarts.md) in the core {{es}} documentation. diff --git a/solutions/toc.yml b/solutions/toc.yml index 40006f2634..be798bb0d8 100644 --- a/solutions/toc.yml +++ b/solutions/toc.yml @@ -13,7 +13,6 @@ toc: - file: search/get-started/index-basics.md - file: search/get-started/keyword-search-python.md - file: search/get-started/semantic-search.md - - file: search/api-quickstarts.md - file: search/ingest-for-search.md children: - file: search/search-pipelines.md From 88e2b587cd4d6fce168187029f9e245705841e38 Mon Sep 17 00:00:00 2001 From: lcawl Date: Tue, 26 Aug 2025 09:50:58 -0700 Subject: [PATCH 2/3] Update redirects --- redirects.yml | 1 + 1 file changed, 1 insertion(+) diff --git a/redirects.yml b/redirects.yml index 2e0e737c41..fcd3d51792 100644 --- a/redirects.yml +++ b/redirects.yml @@ -331,4 +331,5 @@ redirects: # Related to https://github.com/elastic/elasticsearch/pull/133362 'solutions/search/querydsl-full-text-filter-tutorial.md': 'elasticsearch://reference/query-languages/query-dsl/full-text-filter-tutorial.md' +# Related to https://github.com/elastic/docs-content/pull/2719 'solutions/search/api-quickstarts.md': 'solutions/search/get-started/quickstarts.md' \ No newline at end of file From 394556a6bceab946d80a5a0713067fe479014cf7 Mon Sep 17 00:00:00 2001 From: lcawl Date: Tue, 26 Aug 2025 11:52:16 -0700 Subject: [PATCH 3/3] Fix quickstart spelling --- solutions/search/get-started.md | 2 +- solutions/search/querying-for-search.md | 2 +- solutions/search/serverless-elasticsearch-get-started.md | 2 +- 3 files changed, 3 insertions(+), 3 deletions(-) diff --git a/solutions/search/get-started.md b/solutions/search/get-started.md index e8015fc4e9..85fe56fc1d 100644 --- a/solutions/search/get-started.md +++ b/solutions/search/get-started.md @@ -28,5 +28,5 @@ Building a search experience with {{es}} requires a number of fundamental implem Each decision builds on the previous ones, offering flexibility to mix and match approaches based on your needs. ::::{tip} -Already have an {{es}} deployment? You can get started with our hands-on [quick starts](/solutions/search/get-started/quickstarts.md), or check out our [Python notebooks](https://github.com/elastic/elasticsearch-labs/tree/main/notebooks#readme). +Already have an {{es}} deployment? You can get started with our hands-on [quickstart guides](/solutions/search/get-started/quickstarts.md), or check out our [Python notebooks](https://github.com/elastic/elasticsearch-labs/tree/main/notebooks#readme). :::: diff --git a/solutions/search/querying-for-search.md b/solutions/search/querying-for-search.md index aa3bed22e8..f16e7ec181 100644 --- a/solutions/search/querying-for-search.md +++ b/solutions/search/querying-for-search.md @@ -34,5 +34,5 @@ You can use the [{{es}} REST APIs](https://www.elastic.co/docs/api/doc/elasticse :::: ::::{tip} -Try our hands-on [quick starts](/solutions/search/get-started/quickstarts.md) to get started, or check out our [Python notebooks](https://github.com/elastic/elasticsearch-labs/tree/main/notebooks#readme). +Try our hands-on [quickstart guides](/solutions/search/get-started/quickstarts.md) to get started, or check out our [Python notebooks](https://github.com/elastic/elasticsearch-labs/tree/main/notebooks#readme). :::: diff --git a/solutions/search/serverless-elasticsearch-get-started.md b/solutions/search/serverless-elasticsearch-get-started.md index 8b2da277a7..8f68135775 100644 --- a/solutions/search/serverless-elasticsearch-get-started.md +++ b/solutions/search/serverless-elasticsearch-get-started.md @@ -121,4 +121,4 @@ If you’re already familiar with Elasticsearch, you can jump right into setting ## Next steps [elasticsearch-next-steps] * Once you’ve added data to your {{es-serverless}} project, you can use [Playground](rag/playground.md) to test and tweak {{es}} queries and chat with your data, using GenAI. -* You can also try our hands-on [quick starts](/solutions/search/get-started/quickstarts.md) in the core {{es}} documentation. +* You can also try our hands-on [quickstart guides](/solutions/search/get-started/quickstarts.md) in the core {{es}} documentation.