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

docs: 📚 fix/replace current Storybook-Badge plugin #1673

Open
3 of 7 tasks
karlbaumhauer opened this issue Nov 22, 2024 · 0 comments
Open
3 of 7 tasks

docs: 📚 fix/replace current Storybook-Badge plugin #1673

karlbaumhauer opened this issue Nov 22, 2024 · 0 comments
Labels
A11y Audit Identifies tasks related to accessibility improvements identified in the A11y audit of the DS 🔧 code needs changes in code

Comments

@karlbaumhauer
Copy link
Contributor

karlbaumhauer commented Nov 22, 2024

Description

As the current plugin (@geometricpanda/storybook-addon-badges) is not supported anymore, we need to replace and/or fix the plugin. Within this task, we also need to add a new tag to each component, following the issue #1670

Acceptance Criteria:

  1. A new plugin has been added or the old one has been modified in order to continue the existing badges,
  2. New A11y badge:
    • Each component has a new "A11y status" badge.
    • The badge can have the value "No known issues" / "known issues" and a version where compliance was achieved (e.g., “since 1.1.1”).
  3. Label Design:
    • The badge should visually align with existing status badge (e.g., “Stable”).
    Image
    • Label text and color must comply with our colors.
  4. Content Management:
    • The information must be easy to update as compliance or known issues change.
    • Versioning must be clear to indicate when updates occurred.

Where to put the documentation

Storybook

DoR

  • Item has business value
  • Item has been estimated by the team
  • Item is clear and well-defined
  • Item dependencies have been identified

DoD

  • Relevant stories (Features, A11y) are created/updated
  • Migration Guide has been created/updated (if applicable)
  • Implementation works successfully on feature branch
@karlbaumhauer karlbaumhauer added A11y Audit Identifies tasks related to accessibility improvements identified in the A11y audit of the DS 🔧 code needs changes in code labels Nov 22, 2024
@karlbaumhauer karlbaumhauer moved this to 🛠️ To be pre-refined in Solid Design System Project Board Nov 22, 2024
@karlbaumhauer karlbaumhauer changed the title docs: 📚 fix/repleace current tag plugin docs: 📚 fix/repleace current Storybook-Badge plugin Nov 22, 2024
@mariohamann mariohamann changed the title docs: 📚 fix/repleace current Storybook-Badge plugin docs: 📚 fix/replace current Storybook-Badge plugin Nov 22, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
A11y Audit Identifies tasks related to accessibility improvements identified in the A11y audit of the DS 🔧 code needs changes in code
Projects
Status: 🛠️ To be pre-refined
Development

No branches or pull requests

1 participant