-
Notifications
You must be signed in to change notification settings - Fork 861
chore(eui): remove src-docs folder #8624
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
chore(eui): remove src-docs folder #8624
Conversation
e397ddf to
460eba4
Compare
acstll
left a comment
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.
Overall this looks perfect — thank you for tackling this one!
I ran yarn clean in the root before QA/testing. I got unexpected results in 2 of the tests (I hope it's not something related to my environment):
When you run yarn start in packages/eui, it should launch Storybook
it does launch it but there's a compile error, seems related to importing the illustration in empty_prompt.stories.tsx
ERROR in ./src/components/empty_prompt/empty_prompt.stories.tsx
Module build failed (from ./node_modules/babel-loader/lib/index.js):
Error: /Users/arturo/Developer/eui/packages/eui/src/components/empty_prompt/empty_prompt.stories.tsx: Plugin name should be specified
also, if you run it for the first time, it's going to miss the theme packages, so maybe it's a good idea to suggest in the updated .md files, to run yarn build:workspaces in packages/eui when running locally the first time?
When you run yarn build in packages/eui, it should copy files from src/themes/json to /dist
it does copy the files and it looks correct, however there's also the following error printed:
cp: copyFileSync: could not write to dest file (code=ENOENT):es/themes/json/eui_theme_amsterdam_dark.json
cp: copyFileSync: could not write to dest file (code=ENOENT):optimize/es/themes/json/eui_theme_amsterdam_dark.json
cp: copyFileSync: could not write to dest file (code=ENOENT):lib/themes/json/eui_theme_amsterdam_dark.json
cp: copyFileSync: could not write to dest file (code=ENOENT):optimize/lib/themes/json/eui_theme_amsterdam_dark.json
cp: copyFileSync: could not write to dest file (code=ENOENT):test-env/themes/json/eui_theme_amsterdam_dark.json
cp: copyFileSync: could not write to dest file (code=ENOENT):es/themes/json/eui_theme_amsterdam_light.json
cp: copyFileSync: could not write to dest file (code=ENOENT):optimize/es/themes/json/eui_theme_amsterdam_light.json
cp: copyFileSync: could not write to dest file (code=ENOENT):lib/themes/json/eui_theme_amsterdam_light.json
cp: copyFileSync: could not write to dest file (code=ENOENT):optimize/lib/themes/json/eui_theme_amsterdam_light.json
cp: copyFileSync: could not write to dest file (code=ENOENT):test-env/themes/json/eui_theme_amsterdam_light.json
cp: copyFileSync: could not write to dest file (code=ENOENT):es/themes/json/eui_theme_borealis_dark.json
cp: copyFileSync: could not write to dest file (code=ENOENT):optimize/es/themes/json/eui_theme_borealis_dark.json
cp: copyFileSync: could not write to dest file (code=ENOENT):lib/themes/json/eui_theme_borealis_dark.json
cp: copyFileSync: could not write to dest file (code=ENOENT):optimize/lib/themes/json/eui_theme_borealis_dark.json
cp: copyFileSync: could not write to dest file (code=ENOENT):test-env/themes/json/eui_theme_borealis_dark.json
cp: copyFileSync: could not write to dest file (code=ENOENT):es/themes/json/eui_theme_borealis_light.json
cp: copyFileSync: could not write to dest file (code=ENOENT):optimize/es/themes/json/eui_theme_borealis_light.json
cp: copyFileSync: could not write to dest file (code=ENOENT):lib/themes/json/eui_theme_borealis_light.json
cp: copyFileSync: could not write to dest file (code=ENOENT):optimize/lib/themes/json/eui_theme_borealis_light.json
cp: copyFileSync: could not write to dest file (code=ENOENT):test-env/themes/json/eui_theme_borealis_light.json
EuiEmptyPrompt stories display correctly
there shouldn't be any issues with this, but I couldn't check because of the Storybook webpack compile error
|
@acstll I fixed the issue with Storybook. Now there's no compilation error and the
Importing media assets works out-of-box in Storybook. BUT our Babel configuration specifies
Lines 32 to 43 in d658067
so what I did is moved the I'm looking into the JSON files copying now. |
378df77 to
f58b5bf
Compare
f58b5bf to
89df182
Compare
💚 Build SucceededHistory
|
💚 Build Succeeded
History
|
acstll
left a comment
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.
Works as expected, thank you for taking care of this! LGTM 🟢

Summary
Closes #8602
On this PR:
src-docsfolderillustration.svgthat's referenced by aEuiEmptyPromptstory tosrc/components/empty_promptfoldersrc/themes/json, and updatecompile-scss.jsscript to keep the current functionalitysrc-docsmentions from old release scripts (packages/eui/scripts/update-changelog.js) but we should probably remove them whole soonyo-docscript and the associated Yeoman generator (we could create a new generator for MDX content in the future: https://github.com/elastic/eui-private/issues/302)prop-loader.jsscript which couldn't have been migrated totypescript@5and now that we swapped to the new docs we can proceed with Upgradetypescriptto latest v5 #7344QA
yarn lint-esinpackages/eui, it should run linter without any issuesyarn startinpackages/eui, it should launch Storybookyarn buildinpackages/eui, it should copy files fromsrc/themes/jsonto/distEuiEmptyPromptstories display correctlysrc/themes/json) include recent severity palette changes