michael-s-molina opened a new pull request, #21090: URL: https://github.com/apache/superset/pull/21090
### SUMMARY **Adds the MetadataBar component** The metadata bar component is used to display additional information about an entity. Some of the common applications in Superset are: - Display the chart’s metadata in Explore to help the user understand what dashboards this chart is added to and get to know the details of the chart - Display the database’s metadata in a drill to detail modal to help the user understand what data they are looking at while accessing the feature in the dashboard The metadata bar is by default a static component (besides the links in text). The variations in this component are related to content and entity type as all of the details are predefined in the code and should be specific for each metadata object. Content types are predefined and consistent across the whole app. This means that they will be displayed and behave in a consistent manner, keeping the same ordering, information formatting, and interactions. For example, the Owner content type will always have the same icon and when hovered it will present who created the entity, its current owners, and when the entity was created. The Overview page in the Storybook contains the component's documentation with the available content types and their properties. **Configures the Storybook to display MDX content** This will allow developers to create documentation pages about each component using the whole power of [MDX](https://storybook.js.org/docs/react/writing-docs/mdx). This is one of the improvements we're working on to improve our current design system. **Configures the Storybook to read and display [JSDocs](https://en.wikipedia.org/wiki/JSDoc)** With this configuration, JSDocs added to Typescript metadata will be available in the controls panel in the Storybook. This will reduce the burden when writing stories and promote well-documented components. @kasiazjc @jess-dillard @eric-briscoe ### BEFORE/AFTER SCREENSHOTS OR ANIMATED GIF https://user-images.githubusercontent.com/70410625/184633200-d9c2770f-1afb-4c45-858c-0af0b54d45cd.mov ### TESTING INSTRUCTIONS All requirements have associated RTL tests. You can interact with the component in the Storybook. ### ADDITIONAL INFORMATION - [ ] Has associated issue: - [ ] Required feature flags: - [ ] Changes UI - [ ] Includes DB Migration (follow approval process in [SIP-59](https://github.com/apache/superset/issues/13351)) - [ ] Migration is atomic, supports rollback & is backwards-compatible - [ ] Confirm DB migration upgrade and downgrade tested - [ ] Runtime estimates and downtime expectations provided - [x] Introduces new feature or API - [ ] Removes existing feature or API -- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. To unsubscribe, e-mail: [email protected] For queries about this service, please contact Infrastructure at: [email protected] --------------------------------------------------------------------- To unsubscribe, e-mail: [email protected] For additional commands, e-mail: [email protected]
