Skip to content
This repository has been archived by the owner on May 24, 2024. It is now read-only.

Update About.1.doc.mdx for Terra Status #4015

Merged
merged 5 commits into from
Jan 30, 2024
Merged

Update About.1.doc.mdx for Terra Status #4015

merged 5 commits into from
Jan 30, 2024

Conversation

mjpalazzo
Copy link
Contributor

@mjpalazzo mjpalazzo commented Jan 16, 2024

Added deprecation notice and badge to Terra Status About page

Summary

What was changed:
Added deprecation notice and badge to Terra Status About page

Why it was changed:

Component is no longer supported and will not be included in Redwood theme project

Testing

This change was tested using:

  • WDIO
  • Jest
  • Visual testing (please attach a screenshot or recording)
  • Other (please describe below)
  • No tests are needed

Reviews

In addition to engineering reviews, this PR needs:

  • UX review
  • Accessibility review
  • Functional review
  • Tech writer review

Additional Details

This PR resolves:

UXPLATFORM-9930


Thank you for contributing to Terra.
@cerner/terra

Added deprecation notice and badge to Terra Status About page
@mjpalazzo mjpalazzo self-assigned this Jan 16, 2024
@mjpalazzo mjpalazzo marked this pull request as ready for review January 16, 2024 21:38
@mjpalazzo mjpalazzo requested a review from a team as a code owner January 16, 2024 21:38
@JessieRandle
Copy link
Contributor

What component are we recommending consumers use in place of terra-status. If we don't have an alternative, why is terra-status being deprecated?

# Terra Status

<Notice variant="deprecation">

`terra-status` is no longer supported. If you are using `terra-status`, consider replacing it with a supported component.
Copy link
Contributor

Choose a reason for hiding this comment

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

What is the supported alternative? We should probably link it here.

Choose a reason for hiding this comment

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

I agree with adding a supported component.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Thanks for the feedback. This component does not meet accessibility criteria, and I am not aware of any alternative that we can point to. @eawww - do you have any suggestions for replacing terra-status? Is there an alternative or does the consumer need to work with UX on a different approach?

Copy link
Contributor

Choose a reason for hiding this comment

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

@mjpalazzo @sdadn yeah this is an unfortunately common pattern in Cerner stuff that needs to go away. The alternative will largely depend on context but a nice plug-n-play replacement could often be iconography where meaning is conveyed by shape (and color if appropriate) and accessible alt-text.

I'd say it would usually be best to work with UX on a per-use-case basis.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Thanks @eawww So would terra-icon and terra-image be appropriate alternatives? These components have accessibility guides which provide guidance about alt-text, etc.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Updated notice with reason, terra status does not comply with accessibility guidelines and alternatives.

Copy link

@RachaelMarso RachaelMarso left a comment

Choose a reason for hiding this comment

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

Reviewed and approved per OHAIUAD

Copy link
Contributor

@adoroshk adoroshk left a comment

Choose a reason for hiding this comment

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

Needs Changelog update, otherwise LGTM.
Screenshot 2024-01-22 at 4 56 24 PM

@mjpalazzo
Copy link
Contributor Author

Needs Changelog update, otherwise LGTM. Screenshot 2024-01-22 at 4 56 24 PM

@adoroshk - This is a change log entry but it is on a different branch. I will ping you for help on how to fix that.

@github-actions github-actions bot temporarily deployed to preview-pr-4015 January 30, 2024 20:59 Destroyed
@mjpalazzo mjpalazzo merged commit 2c8031e into main Jan 30, 2024
22 checks passed
@mjpalazzo mjpalazzo deleted the mjpalazzo-patch-4 branch January 30, 2024 21:12
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

7 participants