314 minor fixes for guides #2371
Open
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
bmorelli25
approved these changes
Aug 1, 2025
| 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.md#choosing-your-deployment-type) for your options. To get started quickly, you can spin up a cluster [locally in Docker](get-started.md): | ||
| You can follow this guide using any {{es}} deployment. If you have a deployment setup ready, skip ahead to the [first step](#getting-started-index-creation). If not, refer [choose your deployment type](/deploy-manage/deploy.md#choosing-your-deployment-type) to see all deployment options. To get started quickly, spin up a cluster [locally in Docker](run-elasticsearch-locally.md): |
There was a problem hiding this comment.
Do we need setup here?
Suggested change
| You can follow this guide using any {{es}} deployment. If you have a deployment setup ready, skip ahead to the [first step](#getting-started-index-creation). If not, refer [choose your deployment type](/deploy-manage/deploy.md#choosing-your-deployment-type) to see all deployment options. To get started quickly, spin up a cluster [locally in Docker](run-elasticsearch-locally.md): | |
| You can follow this guide using any {{es}} deployment. If you have a deployment ready, skip ahead to the [first step](#getting-started-index-creation). If not, refer to [choose your deployment type](/deploy-manage/deploy.md#choosing-your-deployment-type) to see all deployment options. To get started quickly, spin up a cluster [locally in Docker](run-elasticsearch-locally.md): |
| View the mapping for the `books` index with the [Get mapping API](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-get-mapping). The new field `language` has been added to the mapping with a `text` data type. | ||
|
|
||
| ```console | ||
| GET /books/_mapping | ||
| ``` | ||
|
|
||
| The following response displays the mappings that were created by Elasticsearch. |
There was a problem hiding this comment.
Suggested change
| The following response displays the mappings that were created by Elasticsearch. | |
| The following response displays the mappings that were created by {{es}}. |
| @@ -131,8 +125,6 @@ POST /_bulk | |||
| {"name": "The Handmaids Tale", "author": "Margaret Atwood", "release_date": "1985-06-01", "page_count": 311} | |||
| ``` | |||
|
|
|||
| You should receive a response indicating there were no errors. | |||
There was a problem hiding this comment.
I noticed you removed this response explanation but added explanations to responses below:
The following response displays the mappings that were created by Elasticsearch.
The following response indicates a successful operation.
Should we keep this explanation for consistency?
|
|
||
| ## Learn more [full-text-filter-tutorial-learn-more] | ||
|
|
||
| This tutorial introduced the basics of creating indices, adding data and performing basic searches with {{es}}. Following resources will help you understand {{es}} concepts better and dive into the basics of query languages for searching data: |
There was a problem hiding this comment.
Suggested change
| This tutorial introduced the basics of creating indices, adding data and performing basic searches with {{es}}. Following resources will help you understand {{es}} concepts better and dive into the basics of query languages for searching data: | |
| This tutorial introduced the basics of creating indices, adding data and performing basic searches with {{es}}. The following resources will help you understand {{es}} concepts better and dive into the basics of query languages for searching data: |
szabosteve
approved these changes
Aug 7, 2025
| @@ -6,7 +6,7 @@ applies_to: | |||
| # Basics quickstart [getting-started] | |||
|
|
|||
|
|
|||
| This quick start guide is a hands-on introduction to the fundamental concepts of Elasticsearch: [indices, documents, and field type mappings](../../manage-data/data-store/index-basics.md). You’ll learn how to create an index, add data as documents, work with dynamic and explicit mappings, and perform your first basic searches. | |||
| This quickstart provides a hands-on introduction to the fundamental concepts of Elasticsearch: [indices, documents, and field type mappings](../../manage-data/data-store/index-basics.md). You'll learn how to create an index, add documents, work with dynamic and explicit mappings, and perform your first basic searches. | |||
There was a problem hiding this comment.
Suggested change
| This quickstart provides a hands-on introduction to the fundamental concepts of Elasticsearch: [indices, documents, and field type mappings](../../manage-data/data-store/index-basics.md). You'll learn how to create an index, add documents, work with dynamic and explicit mappings, and perform your first basic searches. | |
| This quickstart provides a hands-on introduction to the fundamental concepts of {{es}}: [indices, documents, and field type mappings](../../manage-data/data-store/index-basics.md). You'll learn how to create an index, add documents, work with dynamic and explicit mappings, and perform your first basic searches. |
| 4. `result`: The result of the indexing operation. | ||
| 5. `_shards`: Information about the number of [shards](../../deploy-manage/distributed-architecture/clusters-nodes-shards.md) that the indexing operation was executed on and the number that succeeded. | ||
| 6. `total`: The total number of shards for the index. | ||
| 7. `successful`: The number of shards that the indexing operation was executed on. |
There was a problem hiding this comment.
Suggested change
| 7. `successful`: The number of shards that the indexing operation was executed on. | |
| 7. `successful`: The number of shards that the indexing operation was performed on. |
| 10. The `_source` field contains the original JSON object submitted during indexing | ||
| 1. `took`: The time in milliseconds for {{es}} to execute the search | ||
| 2. `timed_out`: Indicates if the search timed out | ||
| 3. `_shards`: Information about the number of [shards](/reference/glossary/index.md) that the search was executed on and the number that succeeded |
There was a problem hiding this comment.
Suggested change
| 3. `_shards`: Information about the number of [shards](/reference/glossary/index.md) that the search was executed on and the number that succeeded | |
| 3. `_shards`: Information about the number of [shards](/reference/glossary/index.md) that the search was performed on and the number that succeeded |
| @@ -5,23 +5,21 @@ applies_to: | |||
| navigation_title: Search and filter with ES|QL | |||
| --- | |||
|
|
|||
| # Tutorial: Search and filter with {{esql}} | |||
| # Search and filter with {{esql}} | |||
There was a problem hiding this comment.
Consider keeping "Tutorial" in the title to identify the purpose of the page more easily.
| @@ -9,31 +9,31 @@ products: | |||
| - id: elasticsearch | |||
| --- | |||
|
|
|||
| # Tutorial: Full-text search and filtering with Query DSL [full-text-filter-tutorial] | |||
| # Full-text search and filtering with Query DSL [full-text-filter-tutorial] | |||
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Linked to https://github.com/elastic/developer-docs-team/issues/314 and includes fixes for API quickstarts:
Minor rephrasing of sentences
Shortened sentences
Fixes for broken links
Also, removed the redundant migrated content after the main header in
explore-analyze/query-filter/languages/querydsl.md