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

Enhance OUIBetaBadge for experimental releases #93

Closed
2 of 5 tasks
KrooshalUX opened this issue Oct 21, 2022 · 11 comments
Closed
2 of 5 tasks

Enhance OUIBetaBadge for experimental releases #93

KrooshalUX opened this issue Oct 21, 2022 · 11 comments
Assignees
Labels
enhancement New feature or request

Comments

@KrooshalUX
Copy link
Contributor

KrooshalUX commented Oct 21, 2022

  • Change "Beta" to "Experimental"

Screen Shot 2022-10-21 at 11 50 14 AM

  • Change label inside tooltip to "experimental"

  • Remove option for "E"

  • Remove styling option "accent"

  • Identify how introduce the name OuiExperimentalBadge and if OuiBetaBadge and OuiExperimentalBadge can be used interchangeably

@KrooshalUX KrooshalUX added the enhancement New feature or request label Oct 21, 2022
@KrooshalUX KrooshalUX transferred this issue from opensearch-project/ux Oct 21, 2022
@kgcreative
Copy link
Member

I really like this for Experimental features. I'm not opposed to keeping the lab icon to reinforce experimental

@kgcreative
Copy link
Member

(In fact, i prefer it to E or Exp)

@KrooshalUX
Copy link
Contributor Author

@kgcreative the idea is to enhance this for Experimental so we can use the lab or "beaker" icon on small components (like tables cells). I have given guidance in opensearch-project/ux#49 to replace the "E" with OuiBadge using beaker icon.

@KrooshalUX KrooshalUX mentioned this issue Oct 21, 2022
9 tasks
@KrooshalUX
Copy link
Contributor Author

@kaddy645 can you weigh in on the last to-do of this list about naming?

@BSFishy
Copy link
Contributor

BSFishy commented Oct 28, 2022

For the last item, I don't think we need a completely separate component. The beta badge currently expects a label property, which can be easily changed to say experimental. I suppose we could make a separate component and have the OuiBetaBadge component default to label being Beta and OuiExperimentalBadge default to label being Experimental, but that seems very redundant to me.

2022-10-28 12_05_13-Badge - OpenSearch UI Framework

@KrooshalUX
Copy link
Contributor Author

KrooshalUX commented Oct 28, 2022

@BSFishy the last item has to do with aliasing and implementation. We do not want designers or builders using "beta", we want them to use "experimental". That is why I want to make the change to the component itself vs relying on the implementer to change beta to experimental (different task item). For naming - right now OSD & plug-ins can call EuiBetaBadge which because it's aliased will then actually call OuiBetaBadge - but since we want to move away from "Beta" language we need to either map EuiBetaBadge to OuiExperimentalBadge or allow EuiBetaBadge to be called which points to OuiBetaBadge which contains the changes as well and allow OuiExperimentalBadge to be called when OUI is used directly. I am not sure what is involved in a change like this when we need to change the name of a component for clarity.

@KrooshalUX KrooshalUX moved this to Icebox (No Dev) in OUI Components Nov 1, 2022
@KrooshalUX KrooshalUX moved this from Icebox : Do Not Action to In Progress: Engineering in OUI Components Nov 1, 2022
@KrooshalUX
Copy link
Contributor Author

We need to decide on how we want to go about releasing these changes before everything gets merged, correct? I am good with the plan to introduce OuiExperimentalBadge and deprecate OuiBetaBadge, but not sure what is involved in that process. Can someone please outline next steps? @AMoo-Miki @BSFishy @kaddy645 ?

@BSFishy
Copy link
Contributor

BSFishy commented Nov 1, 2022

We need to decide on how we want to go about releasing these changes before everything gets merged, correct?

Yes, some of these changes are potentially breaking, warranting a major version bump.

  1. Change "Beta" to "Experimental" text in docs should be fine. That isn't a user-facing change.
  2. Removing the "accent" color option is a breaking change. We could just leave the PR open until we're ready for a major version bump.
  3. Introducing OuiExperimentalBadge and deprecating OuiBetaBadge should be a minor version bump. All I've done so far is rename all instances of OuiBetaBadge to OuiExperimentalBadge and rename some of the CSS classes, but it seems that OuiBetaBadge stretches outside of that. It is unlikely that the changes are going to be breaking, but not out of the picture.

Here's how I think versions will need to be bumped for these merges:

  • Doc change "Beta" to "Experimental": No bump - no change to code
  • Remove "accent" color option: Major version bump - functionality removed
  • Introduce OuiExperimentalBadge, deprecate OuiBetaBadge: Minor version bump - interfaces added/updated (*PROJECTED*)

@AMoo-Miki can confirm this and discuss how we can go about merging these for proper version bumping

@KrooshalUX
Copy link
Contributor Author

KrooshalUX commented Nov 8, 2022

@BSFishy One last change has occurred to me, we do not want to use the "E" abbreviated version, only "experimental" or the beaker version (updated issue to-do list). So, we need to make an additional breaking change to remove that option as well.

@AMoo-Miki
Copy link
Collaborator

@BSFishy please don't remove the existing component in the 1.0; (1) create a new component, even if it is identical to the old one + name change, (2) mark the beta one deprecated and include it in the changelog as being deprecated.

When OUI 2 is being released, we would simply delete the beta one.

@KrooshalUX
Copy link
Contributor Author

Closing in favor of issue #161

@github-project-automation github-project-automation bot moved this from In Progress: Engineering to Done in OUI Components Mar 10, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
No open projects
Status: Done
Development

No branches or pull requests

4 participants