[DOCS][101] Update first quick start with mappings examples #113558
Conversation
|
Documentation preview: |
leemthompo
changed the title
Added my-explicit-mappings-books to TESTSETUP and TEARDOWN. Skipped the initial PUT /books test as the index is already set up. Modified the GET /_cat/indices command to include specific parameters. Changed a PUT request to POST for adding a document. Updated the description of the dynamically added field's data type from keyword to text. Made minor wording adjustments throughout the document.
| ++++ | ||
| <titleabbrev>Basics: Add data using APIs</titleabbrev> | ||
| <titleabbrev>Basics: Indices, documents, and mappings</titleabbrev> | ||
| ++++ | ||
|
|
||
| In this quick start guide, you'll learn how to do the following tasks: |
There was a problem hiding this comment.
Quickstart articles like this should still have an introductory paragraph. Introductory paragraphs can help search engines when searching for content.
There was a problem hiding this comment.
because the intro paragraph will be prose version of the "in this quick start you'll learn how to do x,y,z" list, wonder if should remove that list entirely and let the "On this page" serve that porpoise 🐬
There was a problem hiding this comment.
add intro in 31d8006
There was a problem hiding this comment.
provided mostly tutorial style and depth comments inline. regarding your question on direction: I like the idea of a quick "index a doc and see a result" type tutorial to get people familiar with playing with the API, but I wonder if, in a better IA world, this would be a top-level tutorial in an index series, that we could just link to prominently. the thought in the back of my mind is: we need tutorials in the index content, so what would go there, if not this style of tutorial?
given that we don't live in said world, I'm cool with this getting published
- Updated title and titleabbrev to focus on indexing and searching using APIs - Added links - Clarified explanation about code examples and language conversion - Added numbered steps (1-5) - Added example responses - Included more detailed explanations with numbered annotations in code snippets - Added tip about other ways to add data to Elasticsearch - Added more context and explanations for search operations
|
Thanks I've made updates in 3a3a9a4. See commit message for summary. |
| Indexed documents are available for search in near real-time. | ||
| Explicit mappings are defined at index creation, and documents must conform to these mappings. | ||
| When an index has the `dynamic` flag set to `true`, you can add new fields to documents without updating the mapping. | ||
| This allows you to <<mapping-combine-explicit-dynamic,combine explicit and dynamic mappings>>. |
There was a problem hiding this comment.
new section added to main mappings page in c0eba9f
|
🤔 Because we're doing a lot of explanation here, with response annotations and links to every concept/API call, we're already in tutorial rather than quick start territory. Perhaps tutorials is a better umbrella. These are a lot more pedagogical than "copy these few commands and be on your way". |
leemthompo
added
auto-backport-and-merge
v8.16.0
v8.15.0
>docs
|
Pinging @elastic/es-docs (Team:Docs) |
|
@elasticmachine update branch |
| @@ -344,7 +350,8 @@ GET /books/_mapping | |||
| [[getting-started-explicit-mapping]] | |||
| ==== Define explicit mapping | |||
|
|
|||
| Create an index named `my-explicit-mappings-books` with explicit mappings: | |||
| Create an index named `my-explicit-mappings-books` with explicit mappings. | |||
| Pass each field's properties as a JSON object. This object should contain the field type and any additional <<mapping-params,mapping parameters>>. | |||
There was a problem hiding this comment.
🤔 do we want a link to available types here?
that will be a Brave New World |
💔 Backport failedThe backport operation could not be completed due to the following error: You can use sqren/backport to manually backport by running |
💚 All backports created successfully
Questions ?Please refer to the Backport tool documentation |
📸URL PREVIEW
Originally envisioned this being standalone companion to basics page about indices, documents, mappings but we discussed that might actually fit right into the first quick start?
My only concern is this is a little long now 🤔
TODO: