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

feat: convert mdx components in web app to mdx-components package #1423

Merged

Conversation

jharvey10
Copy link
Contributor

@jharvey10 jharvey10 commented Oct 6, 2022

Closes #1103
Closes #1384
Closes #1413
Closes #1496

Things to check

  • Did we remember to remove the components from components.js?
  • Did we remember to add each component to mdx-components/src/main/index.ts?
  • Did we remember to add the styles for each component to mdx-components/src/main/index.scss?
  • Did we remember to move over the stories files?
  • Did we remove all components that are re-exports of carbon ones in favor if the core carbon version?
  • Did we remember to update the unit test snapshots?
  • Did we remember to export the typescript props interface from each component (and export it from index.ts)?

Open questions

Testing / reviewing

Compare the component visuals and functionality to what they were before the conversion.

@jharvey10 jharvey10 linked an issue Oct 6, 2022 that may be closed by this pull request
58 tasks
@mattrosno
Copy link
Member

@jdharvey-ibm @alisonjoseph we shouldn't need this page, once all of these MDX components are documented in individual Storybook stories.

https://next.carbondesignsystem.com/mdx

@alisonjoseph
Copy link
Member

@mattrosno @jdharvey-ibm Let's wait until everything looks good and is approved before removing the test mdx pages, so we can review things in the site easily and compare to live.

@francinelucca
Copy link
Collaborator

we removed most prop warnings @jdharvey-ibm and the ones left behind are reasonable!

jharvey10 and others added 5 commits November 11, 2022 12:47
- fix title to use h4 without autolink (use p instead of an h4)
- adjust style of some components as siblings of headers
- add new "header" utility class to h1-h4

Co-authored-by: Francine Lucca <[email protected]>
@carbon-bot
Copy link
Contributor

The commits in this PR will result in the following version changes:

🌟 MINOR release: @carbon-platform/mdx-components
🌟 MINOR release: @carbon-platform/web-app

@sonarcloud
Copy link

sonarcloud bot commented Nov 11, 2022

Kudos, SonarCloud Quality Gate passed!    Quality Gate passed

Bug A 0 Bugs
Vulnerability A 0 Vulnerabilities
Security Hotspot A 0 Security Hotspots
Code Smell A 4 Code Smells

94.5% 94.5% Coverage
0.5% 0.5% Duplication

@jharvey10 jharvey10 merged commit 203085f into main Nov 11, 2022
@jharvey10 jharvey10 deleted the 1103-convert-mdx-components-in-web-app-to-mdx-components-package branch November 11, 2022 22:12
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
6 participants