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

Update Discover content for 2.0 features #8177

Open
wants to merge 24 commits into
base: main
Choose a base branch
from
Open

Update Discover content for 2.0 features #8177

wants to merge 24 commits into from

Conversation

vagimeli
Copy link
Contributor

@vagimeli vagimeli commented Sep 5, 2024

Closes #8141

Description

Updates Discover documentation to refresh existing text and add new 2.0 features

Issues Resolved

#4418 #4686 #2561

Version

2.17

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.

Dev to provide

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.

Signed-off-by: Melissa Vagi <vagimeli@amazon.com>
Copy link

github-actions bot commented Sep 5, 2024

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.

@vagimeli vagimeli added v2.17.0 2 - In progress Issue/PR: The issue or PR is in progress. labels Sep 5, 2024
@vagimeli
Copy link
Contributor Author

@sejli Please use this PR to add the initial draft content as soon as possible. Once you add the content, tag me so that I can doc review and move the PR forward for publishing by release. Thank you.

Signed-off-by: Melissa Vagi <vagimeli@amazon.com>
Signed-off-by: Melissa Vagi <vagimeli@amazon.com>
- Data selector with **Data Explorer** that supports index patterns, indexes, and Amazon S3 connections and data configuration that supports selecting the appropriate query language based on the data type
- Link sharing through URLs without needing write permission to create an index pattern

All existing functionality remains in OpenSearch 2.17, and the new features are designed to improve your data exploration experience. The **Enable query enhancements** is currently not on a minimum distribution. <SME: Do we need to add text about plugins?>. You can leave your feedback at <insert-link> to help the OpenSearch Project improve.
Copy link
Contributor Author

Choose a reason for hiding this comment

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

@sejli Will you provide me with the link for users to leave feedback about these features? Also, please review this paragraph. Do we need to add text about plugins?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

@sejli Confirming this is on for 2.18. Do we have updates to the draft text?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

@sejli No one has provided any updates. The developers write the initial drafts for new features and the tech writer refines the content. Any updates developers can make in the PR.

@vagimeli vagimeli added v2.18.0 and removed v2.17.0 labels Sep 16, 2024
@vagimeli vagimeli added 3 - Tech review PR: Tech review in progress dashboards and removed 2 - In progress Issue/PR: The issue or PR is in progress. labels Sep 30, 2024
- Data selector with **Data Explorer** that supports index patterns, indexes, and Amazon S3 connections and data configuration that supports selecting the appropriate query language based on the data type
- Link sharing through URLs without needing write permission to create an index pattern

All existing functionality remains in OpenSearch 2.17, and the new features are designed to improve your data exploration experience. The **Enable query enhancements** is currently not on a minimum distribution. <SME: Do we need to add text about plugins?>. You can leave your feedback at <insert-link> to help the OpenSearch Project improve.
Copy link
Member

Choose a reason for hiding this comment

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

  • In a distribution of just OpenSearch and OpenSearch Dashboards, query enhancements will not provide access to PPL or SQL. This requires the OpenSearch SQL plugin. I think we can make it known that query enhancements does work with just OpenSearch, but will require the SQL plugin and others to make SQL, PPL, and external datasource queries work.
  • Other than making a note for getting SQL and PPL to work, looks good to me. May need some more input from @kavilla as well.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Revised the Note text to add this information.

Signed-off-by: Melissa Vagi <vagimeli@amazon.com>
Signed-off-by: Melissa Vagi <vagimeli@amazon.com>
Signed-off-by: Melissa Vagi <vagimeli@amazon.com>
Signed-off-by: Melissa Vagi <vagimeli@amazon.com>
Signed-off-by: Melissa Vagi <vagimeli@amazon.com>
Signed-off-by: Melissa Vagi <vagimeli@amazon.com>
Signed-off-by: Melissa Vagi <vagimeli@amazon.com>
Signed-off-by: Melissa Vagi <vagimeli@amazon.com>
Signed-off-by: Melissa Vagi <vagimeli@amazon.com>
Signed-off-by: Melissa Vagi <vagimeli@amazon.com>
Signed-off-by: Melissa Vagi <vagimeli@amazon.com>
Signed-off-by: Melissa Vagi <vagimeli@amazon.com>
Signed-off-by: Melissa Vagi <vagimeli@amazon.com>
Signed-off-by: Melissa Vagi <vagimeli@amazon.com>
Signed-off-by: Melissa Vagi <vagimeli@amazon.com>
@vagimeli
Copy link
Contributor Author

vagimeli commented Nov 1, 2024

@kavilla @sejli Please provide a status update for this PR. Is this feature being released for 2.18? If so, please see my doc review changes and comments. Once info gaps are addressed and we have your approval on the content changes, I can move this forward for editorial review. Please note that editorial has a 2-day SLA. Thank you.

@ashwin-pc
Copy link
Member

@vagimeli this can be move to 2.19 for now. The correct reelase for this issue will be hen we go GA with this feature (for future reference when we revisit this issue in 2.19).

@ashwin-pc ashwin-pc added v2.19.0 and removed v2.18.0 labels Nov 1, 2024
@kolchfa-aws kolchfa-aws assigned Naarcha-AWS and unassigned vagimeli Dec 2, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
3 - Tech review PR: Tech review in progress dashboards v2.19.0
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[DOC] Add documentation for Discover 2.0
5 participants