Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Documentation for query field name and datatype in query shape #8631

Merged

Conversation

deshsidd
Copy link
Contributor

Description

As a followup to : #8173
Need to add documentation for field name and field type settings and field that is included in the query structure while grouping top b by similarity.

  • Need to add documentation for the 2 settings
  • Need to modify the example query shape to now show field name and field data type and mention that we take this into account for the query shape.

Issues Resolved

Closes #8539

Version

List the OpenSearch version to which this PR applies, e.g. 2.14, 2.12--2.14, or all.

Frontend features

If you're submitting documentation for an OpenSearch Dashboards feature, add a video that shows how a user will interact with the UI step by step. A voiceover is optional.

Checklist

  • 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.

Copy link

Thank you for submitting your PR. The PR states are In progress (or Draft) -> Tech review -> Doc review -> Editorial review -> Merged.

Before you submit your PR for doc review, make sure the content is technically accurate. If you need help finding a tech reviewer, tag a maintainer.

When you're ready for doc review, tag the assignee of this PR. The doc reviewer may push edits to the PR directly or leave comments and editorial suggestions for you to address (let us know in a comment if you have a preference). The doc reviewer will arrange for an editorial review.

@kolchfa-aws
Copy link
Collaborator

@deshsidd Is this PR ready for review? And is it for 2.18? Thanks!

@deshsidd
Copy link
Contributor Author

@kolchfa-aws You are quick was just about to tag you! :) Yes this is ready for review and its for 2.18.

@kolchfa-aws kolchfa-aws added release-notes PR: Include this PR in the automated release notes 4 - Doc review PR: Doc review in progress labels Oct 29, 2024
deshsidd and others added 2 commits October 29, 2024 15:25
Signed-off-by: Siddhant Deshmukh <[email protected]>
Signed-off-by: Fanit Kolchina <[email protected]>
Copy link
Collaborator

@natebower natebower left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@kolchfa-aws One comment and one change. Can you tag me on the rewrite of line 73? Thanks!

}
```

The following query on the preceding index:
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This needs a little more context/clarity of phrasing to indicate that it's connected to the next sentence and not the preceding one.

Copy link
Collaborator

@kolchfa-aws kolchfa-aws Oct 30, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@natebower Reworded - please check. be00833

Copy link
Collaborator

@natebower natebower left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@kolchfa-aws LGTM. Thanks!

@kolchfa-aws kolchfa-aws merged commit 3e95f5f into opensearch-project:main Oct 30, 2024
6 checks passed
epugh pushed a commit to o19s/documentation-website that referenced this pull request Nov 23, 2024
…earch-project#8631)

* Documentation for query field name and datatype in query shape

Signed-off-by: Siddhant Deshmukh <[email protected]>

* Address review dog comments

Signed-off-by: Siddhant Deshmukh <[email protected]>

* Doc review

Signed-off-by: Fanit Kolchina <[email protected]>

* Update _observing-your-data/query-insights/grouping-top-n-queries.md

Co-authored-by: Nathan Bower <[email protected]>
Signed-off-by: kolchfa-aws <[email protected]>

* Rewording

Signed-off-by: Fanit Kolchina <[email protected]>

---------

Signed-off-by: Siddhant Deshmukh <[email protected]>
Signed-off-by: Fanit Kolchina <[email protected]>
Signed-off-by: kolchfa-aws <[email protected]>
Co-authored-by: Fanit Kolchina <[email protected]>
Co-authored-by: kolchfa-aws <[email protected]>
Co-authored-by: Nathan Bower <[email protected]>
Signed-off-by: Eric Pugh <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
4 - Doc review PR: Doc review in progress release-notes PR: Include this PR in the automated release notes v2.18.0
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[DOC] Query field name and type in query insights documentation
3 participants