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

Remove Experimental Tag From Search Comparison Tool #144

Closed
2 tasks
macohen opened this issue Jan 30, 2023 · 5 comments · Fixed by #302
Closed
2 tasks

Remove Experimental Tag From Search Comparison Tool #144

macohen opened this issue Jan 30, 2023 · 5 comments · Fixed by #302
Assignees
Labels
good first issue Good for newcomers v2.11.0

Comments

@macohen
Copy link
Collaborator

macohen commented Jan 30, 2023

What/Why

What are you proposing?

I believe that the comparison tool is stable and have no immediate plans to make changes to it. IMO, we should remove the experimental tag from the tool in an upcoming release.

What problems are you trying to solve?

We should try to minimize the amount of time anything is considered experimental.

What is the developer experience going to be?

None

Are there any security considerations?

No

Are there any breaking changes to the API

No

What is the user experience going to be?

I believe the "Experimental Feature" label should be removed, but the box it's in with the description, link to documentation, and forum should remain. https://searchapps.playground.opensearch.org/app/searchRelevance#/.

Screen Shot 2023-01-30 at 5 53 55 PM

Are there breaking changes to the User Experience?

No

Why should it be built? Any reason not to?

Experimental features are meant for features that are not ready for production due to potential API changes or performance concerns. This feature has neither of those concerns.

What will it take to execute?

@macohen
Copy link
Collaborator Author

macohen commented Jan 31, 2023

What do you think? @dagneyb @elfisher @lauralexis @dblock @macrakis

@macohen macohen added the good first issue Good for newcomers label Feb 2, 2023
@macohen macohen moved this from 🆕 New to 👀 In review in Search Project Board Feb 3, 2023
@macohen macohen added v2.6.0 and removed untriaged labels Feb 6, 2023
@macohen macohen moved this from 👀 In review to Now(This Quarter) in Search Project Board Feb 6, 2023
@macohen macohen changed the title [PROPOSAL] Remove Experimental Tag From Search Comparison Tool Remove Experimental Tag From Search Comparison Tool Feb 6, 2023
@macohen
Copy link
Collaborator Author

macohen commented Feb 6, 2023

This is the approach we're going to take. Moving this into "Next" in the project and removed "Proposal".

@macohen
Copy link
Collaborator Author

macohen commented Mar 9, 2023

We're delaying removal of the experimental tag until a later date.

@macohen macohen closed this as completed Mar 9, 2023
@github-project-automation github-project-automation bot moved this from Now(This Quarter) to ✅ Done in Search Project Board Mar 9, 2023
@macohen macohen moved this from ✅ Done to Next (Next Quarter) in Search Project Board Sep 7, 2023
@macohen macohen added the v2.11.0 label Sep 7, 2023
@macohen macohen reopened this Sep 7, 2023
@github-project-automation github-project-automation bot moved this from Next (Next Quarter) to 🏗 In progress in Search Project Board Sep 7, 2023
@macohen macohen removed the untriaged label Sep 7, 2023
@sejli
Copy link
Member

sejli commented Sep 13, 2023

Wanted to clarify the original issue description

I believe the "Experimental Feature" label should be removed, but the box it's in with the description, link to documentation, and forum should remain.

@noCharger made a good point in this comment on my previous attempt, EuiCallout may not be a consistent component to use to hold the description for the Search Comparison Tool.

For example, VizBuilder, another experimental OpenSearch Dashboards feature, uses EuiCallout to communicate to the user that the feature is experimental.

Any suggestions/ideas on what to use for displaying the tool description, if at all? Is EuiCallout the conventional component to indicate experimental status in OpenSearch Dashboards?

cc: @kgcreative

@kgcreative
Copy link
Member

kgcreative commented Sep 13, 2023

Thanks y'all.

My recommendation would be to move the content to a paragraph under the title. I believe Laura's design for beyond P0 accounts for this:

image

I like the clarity of explicitly linking to documentation and forums, so I'm ok if that text remains for now.

@sejli sejli linked a pull request Sep 30, 2023 that will close this issue
@sejli sejli moved this from 🏗 In progress to 👀 In review in Search Project Board Oct 2, 2023
@sejli sejli closed this as completed in #302 Oct 5, 2023
@github-project-automation github-project-automation bot moved this from 👀 In review to ✅ Done in Search Project Board Oct 5, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
good first issue Good for newcomers v2.11.0
Projects
Status: Done
Development

Successfully merging a pull request may close this issue.

3 participants