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 to reflect guidelines #8297

Merged
merged 3 commits into from
Jan 31, 2025
Merged

Update to reflect guidelines #8297

merged 3 commits into from
Jan 31, 2025

Conversation

ryankeairns
Copy link
Contributor

@ryankeairns ryankeairns commented Jan 29, 2025

Closes #8295

Summary

Update docs example to follow more closely our guidelines while keeping the component as-is for non-Elastic use cases.

Change included

  • Show 'DEPRECATED' for subdued and warning
  • Do not display icon-only versions for subdued and warning

Unrelated tweaks

  • Section headings
  • Spacing

Preview

Current site

New site

QA

Remove or strikethrough items that do not apply to your PR.

General checklist

  • Browser QA
    • Checked in both light and dark modes
    • Checked in mobile
    • Checked in Chrome, Safari, Edge, and Firefox
    • Checked for accessibility including keyboard-only and screenreader modes
  • Docs site QA
  • Code quality checklist
  • Release checklist
    • A changelog entry exists and is marked appropriately.
    • If applicable, added the breaking change issue label (and filled out the breaking change checklist)
  • Designer checklist
    • If applicable, file an issue to update EUI's Figma library with any corresponding UI changes. (This is an internal repo, if you are external to Elastic, ask a maintainer to submit this request)

@ryankeairns ryankeairns marked this pull request as ready for review January 29, 2025 05:30
@ryankeairns ryankeairns requested a review from a team as a code owner January 29, 2025 05:30
@mgadewoll
Copy link
Contributor

mgadewoll commented Jan 29, 2025

@ryankeairns We should also sync the updates for the new EUI+ docs 🙂

https://github.com/elastic/eui/blob/main/packages/website/docs/components/display/badge/beta_badge.mdx

@JasonStoltz
Copy link
Member

@ryankeairns Thanks for taking the initiative here @ryankeairns!

@ryankeairns
Copy link
Contributor Author

Thanks for the feedback. Added a screenshot of the changes in the new site.

@ryankeairns ryankeairns requested a review from mgadewoll January 29, 2025 17:53
@kibanamachine
Copy link

Preview staging links for this PR:

@elasticmachine
Copy link
Collaborator

💚 Build Succeeded

History

Copy link
Contributor

@mgadewoll mgadewoll left a comment

Choose a reason for hiding this comment

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

Thanks for ensuring the docs are more clear! 🎉

@ryankeairns ryankeairns merged commit 10f853d into main Jan 31, 2025
5 checks passed
@ryankeairns ryankeairns deleted the rk/8295-beta-badge-docs branch January 31, 2025 06:05
weronikaolejniczak pushed a commit to cee-chen/eui that referenced this pull request Feb 10, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[EuiBetaBadge] Update docs examples to align with intended use
5 participants