-
Notifications
You must be signed in to change notification settings - Fork 13
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(storybook): upgrade story book to support mdx files #210
Conversation
Quality Gate passedIssues Measures |
@evegufy Can you pls check dependency issue here? |
I checked an the issue in the PR checks is specific to this PR and connected to some storybook package upgrade, not a general issue. |
After some investigation Storybook from v8.1.0 onwards requires prettier to be added as a peer dependency. So I moved it from devDependencies to dependencies and the prettier check is now running. |
<br /> | ||
<br /> | ||
|
||
## NOTICE |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@manojava-gk coming back to our discussion from yesterday, as you were asking me if an md file necessarily needs this notice footer (with this example https://github.com/catenax-ng/tx-portal-assets/blob/main/docs/user/Style-Guide/button%20load%20more.md), I was answering with yes because markdown files are considered documentation.
I realised after our discussion that you're moving the contents into mdx files, which can be considered source code, so you should change to file header like for any other source file and remove the notice footer.
CHANGELOG.md
Outdated
@@ -1,5 +1,9 @@ | |||
# Changelog | |||
|
|||
## 3.0.23 | |||
|
|||
- Support mdx file |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I don't think this is an accurate description of what's happening, something like "Integrate style-guide documentation into shared components and enable MDX support" would be more appropriate
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
agree and where do we have the storybook version upgrade?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
please also raise the minor version to 3.1.0, as this merits a minor change and not just a patch
@@ -0,0 +1,81 @@ | |||
{/**\*\*\*\***\*\***\*\*\*\***\*\*\*\***\*\*\*\***\*\***\*\*\*\***\***\*\*\*\***\*\***\*\*\*\***\*\*\*\***\*\*\*\***\*\***\*\*\*\*** |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
this is a kinda strange way to set comments are you sure about that? this comment applies to all mdx files
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
this is auto generated after running yarn pretty
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Please also fix failing linter https://github.com/eclipse-tractusx/portal-shared-components/actions/runs/9611276695/job/26509514085?pr=210
IP Issues created: |
There is no issue in the local, when I run |
For me it is also failing on local:
|
@oyo I tried from my end. I do not see any error in local |
@evegufy Any update on Dependency file? |
@manojava-gk I created those I issues and they appear to be closed, did you change the versions? If so, change them back. |
@evegufy I have not added any new packages here. I cleaned up my local and generated new yarn.lock file by running @oyo you want to add anything here? |
You did change the versions of the packages very evidently from 7323404 - which is when I created the IP issues - to f9891d8, what made the created IP issues useless for this pull request. I had to create now new IP issues: I assume some of them will ran again in a manual review, so expect a wait time from at leat two weeks. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Change title of pull request, it doesn't summarise the contents well
we do not manually change the yarn.lock file. It is auto generated based on package.json and currently available version from the internet. It got changed as the new version is available in the internet. |
IP issues currently still under review: |
Quality Gate passedIssues Measures |
Hi @manojava-gk as the catenax-ng GitHub org was recreated, I was able to reopen the PR... please reopen the PR as soon as possible from your own fork as the catenax-ng GitHub org will be deleted again. |
Description
update storybook versions and support mdx files
add new component specific mdx files
table component content also added
Why
move design guidelines to storybook from assets
Issue
#115
#223
Checklist
Please delete options that are not relevant.