documentation-website
documentation-website copied to clipboard
opensearch-project
Add metadata fields for mappings (content gap initiative)
Description
Add documentation to address content gaps
Issues Resolved
Closes #4300 See also PR #7115
Checklist
- [X] By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license and subject to the Developers Certificate of Origin. For more information on following Developer Certificate of Origin and signing off your commits, please check here.
Status = Need SME for tech review and to answer the following questions:
- What are the mapping limits settings, their default values, and how to configure them if needed.
- Does OpenSearch allow removal of mapping types and defining mapping types within an index? If so, SME should provide information to include in documentation. Do we have guidance on how to structure data without relying on mapping types?
- How does user delete a mapping? Provide example tutorial.
Does OpenSearch allow removal of mapping types and defining mapping types within an index?
Do you mean custom types here which were present in earlier versions on elasticsearch? If yes, the mapping types have been deprecated since OS 1.0 itself
Does OpenSearch allow removal of mapping types and defining mapping types within an index?
Do you mean custom types here which were present in earlier versions on elasticsearch? If yes, the mapping types have been deprecated since OS 1.0 itself
We can note this in the documentation. We do need to include information and examples about deleting a mapping. Will you help with that topic too?
@mgodwan I've added first-pass drafts of the mappings documentation. When you review these docs, please verify that the code examples are relevant (I tested them using Dev Tools, but am not sure if these examples are most relevant to our users.) Also, please verify that the narrative text is accurate and I haven't miscommunicated any information. Thank you!
coming from #4300 i had hoped to find some more content on the analyzer, normalizer, etc. attributes in this PR but don't see them here. i think it'd be great if this could be documented a bit more as it seems that not all of these can be used with all field types (e.g. normalizer seems to work with keyword but not text fields while analyzer works with text but not keyword?). even just having the information that these are type-specific would be nice, and then additionally the per-type documentation should go into details. or maybe the overview could also contain a list of field types supporting each of the attributes?
these pseudo-generic attributes (exist everywhere but can't be set everywhere) are quite hard to deal with without (good) documentation
@rursprung I see this PR as more of metadata fields being documented and not mapping params for field types.
See this PR for for mapping parameters: https://github.com/opensearch-project/documentation-website/pull/7115 which contain params like analyzer, doc_values, etc.
Once we add more documentation for each field type (e.g. keyword, text), we can mention there what params each field type supports.
@mgodwan I've addressed your feedback. Will you give this a final review and approval? Once you're good with it, I'll move it forward to editorial review and then publish it. Thank you for all your support :)
Thanks for helping with improving the feature documentation :slightly_smiling_face:
A few small fixes and suggestions, otherwise LGTM.
@Naarcha-AWS Thank you for reviewing this PR. I accepted your suggestions and revised areas where you left comments.
@natebower This PR is ready for editorial at your availability. Thank you.