-
-
Notifications
You must be signed in to change notification settings - Fork 6.5k
feat: migrate EditLink component #5271
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: migrate EditLink component #5271
Conversation
|
@HinataKah0 : Plz first to run the code formation check to verify your codes :) Thank you for your 1st contribution! npm run prettier:fix |
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.
There're still many things I want to mention for the "Edit on GitHub", and this problem has happened in "nodejs.dev":
“Edit on GitHub”'s Problem
First let's see a bug (Sorry I cannot send it directly to the nodejs.dev, bcoz it's now archived, and no-one has reported the bug yet):
1)Open the link something like this : https://nodejs.dev/zh-cn/about/
3)Notice we don't have a simplified translated file here yet, so this will return you a 404 page instead!

Reason
We don't have real translated file yet, so we cannot use "edit" in the baseURL, as what I've mentioned in the code-review.
Several Solutions:
Solution 1:Smart Jump
Any languages with the "Edit on GitHub", when clicking it, it will jump to either the language itself (if we really have the page), or jump to the English page (to edit in English). Because we use translations in Crowdin instead of in GitHub.
Solution 2:"Edit" with an "Adding" function when without the translated page
- If we don't the page, we use "new" in the base URL. Then an empty page will be returned to you in GitHub, where you can do whatever you can.
- If we have the translated page, just keep "edit" in the base URL instead.
PS: Do we really need "Edit on GitHub"? Bcoz we've translated files in Crowdin instead of in GitHub, and if we do that, the default one will be in GitHub, is it suitable?
Solution 3:"Edit on GitHub" in English and "Edit on Crowdin" for other translations
I tend to cope with this, bcoz we're translating and editing in Crowdin mainly. And another advantage is that no matter whether we've got the page or not, we can directly open the file in the English version, and choose the language you wanna to translate into. To simplifiy the problem ,we can just make the "Edit On GitHub"'s link something like this following:
https://crowdin.com/project/nodejs-website/(your current language prefix here)
Take the Simplified Chinese as an example:
https://crowdin.com/project/nodejs-website/zh-CN
Notice:Crowdin doesn't include English itself, maybe for English, we still need "Edit on GitHub", but "Edit on Crowdin" for other translations?
Others
How do check the code just depends on how we think of the "Edit On GitHub"'s problem. And that's the reason why I use "Request changes" here. I'm not saying the code is "right" or "wrong", it should rely on discussions bcoz there're many things maybe we've missed before.
|
Maybe "Edit On GitHub" for translations (for English pages/other translation pages) won't be too easy to migrate, it's nice for us to have a discussion here before deciding how to do XD |
5cdab56 to
0240b9b
Compare
Ran: npm i @fortawesome/react-fontawesome npm i @fortawesome/free-solid-svg-icons
Migrate EditLink component from nodejs.dev and create a new Story.
353689e to
e623d46
Compare
|
Hey @HinataKah0 I've re-created your branch with the updated Anyhow, can we use |
|
@MaledongGit About lint issue: About redirection URL: Thanks! Sure, It looks like I'll change my |
Before posting this suggestions, I didn't anything related to it on README, is it you that is voting for this idea? Still on discussion or……? But no matter what we do, if all of you can agree with the same idea or maybe a better one, that's nice, and I've cancelled my review now. |
"+1" means I vote for the idea. Actually, I think this is easily "revert"-able. So we can try any "easy-to-implement" idea first, then change it in the future if we see it doesn't fit well. |
|
I'm fine with whatever y'all decide :) |
English: redirect to GitHub edit page Non-English: redirect to TRANSLATION.md
This reverts commit 99c1814.
…eat/migrate-EditLink-component-2
|
The latest updates on your projects. Learn more about Vercel for Git ↗︎
|
|
@HinataKah0 no need to add screenshots of Storybooks here. Vercel Bot already adds preview link for Storybook 👀 |
…onent-2 Signed-off-by: Wai.Tung <[email protected]>
fix en.json's conflicts Signed-off-by: Wai.Tung <[email protected]>
ovflowd
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.
LGTM! Tremendous work :) Thank you for this amazing contribution <3
Yes, I must admin it looks not noticeable, mixed with other Latin-words. |
|
Can someone give the extra approval that this PR requires? :) cc @nodejs/website |
mikeesto
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.
LGTM, thanks for your contribution
…onent-2 Signed-off-by: Claudio Wunder <[email protected]>
Co-authored-by: Claudio Wunder <[email protected]> Co-authored-by: Wai.Tung <[email protected]>
* feat(unit-test): introduce unit test on website redesign branch (#5178 feat(unit-test): introduce unit test * chore(minor): just a tiny design nitpick * chore: set up storybook (#5191) (#5214) * chore: set up testing-library jest extend (#5231) Co-authored-by: Manish Kumar ⛄ <[email protected]> * chore(dependencies): updated dependencies * feat: create section title component (#5237) Co-authored-by: Wai.Tung <[email protected]> * 📎 chore(migration): migrate banner component (#5233) Co-authored-by: Shanmughapriyan S <[email protected]> Co-authored-by: Michael Esteban <[email protected]> Co-authored-by: Claudio Wunder <[email protected]> * feat: migrate AnimatedPlaceholder component (#5238 Migrate AnimatedPlaceholder component from nodejs.dev and create a new Story. * feat: create article alert component (#5243) * feat: migrate blockquote component (#5259) * feat(stylelint,storybook): fixed styleling misconfig and fixed storybooks (#5281) * feat: create article data tag component (#5280) * feat: migrate AuthorList component and add story 🎉 (#5277) Co-authored-by: Michael Esteban <[email protected]> * chore(migration): migrate language selector component (#5266) Co-authored-by: Claudio Wunder <[email protected]> Co-authored-by: Teja Sai Sandeep Reddy Konala <[email protected]> Co-authored-by: Shanmughapriyan S <[email protected]> Co-authored-by: Michael Esteban <[email protected]> * feat(DarkModeToggler): Migrate and add stories to theme toggler 🎉 (#5236) Co-authored-by: Claudio Wunder <[email protected]> Co-authored-by: Claudio Wunder <[email protected]> * chore: updated contributing guidelines, eslint rules and storybook templates (#5294) Co-authored-by: Shanmughapriyan S <[email protected]> Co-authored-by: Manish Kumar ⛄ <[email protected]> * chore: contributing quick fix of example Signed-off-by: Claudio Wunder <[email protected]> * chore: story guide and react spreading Signed-off-by: Claudio Wunder <[email protected]> * chore: remove base styles from old styling * chore: fix storybook styles, imports, typescript config and dependencies (#5319 * chore: optimises tsconfig * chiore: add missing dependencies * chore: type storybook constants * chore: styles moved styles to somewhere else * chore: add global json type definition * chore: i18n aria-label instead of sr-only * chore: added open sans font family and space between imports * chore: moved styles and fixed styles and updated banner stories * fix: stylelint rules * chore: updated tsconfig * chore: fix tests * fix: darkmodetoggle test * chore: stories use index.stories.tsx * chore: adopt turborepo (#5316 * chore: revert pnpm use plain npm * fix: package.json * chore: remove warnings and add node_env * chore: cross-env * fix: fix turbo pipelines * chore: only cache certain files * chore: turbo shouldn't care about coverage outputs * chore: proper inputs and outputs for pipelines * chore: do not store some outputs and updated inputs for lint * chore: added prettier configs * chore: remove console.info * chore: updated inputs of all other entries * fix(package.json) Lint command is missing slashes (#5321 fix(package.json) lint:fix missing slashes * moved `DataTag` to `components/Api` (#5317) Co-authored-by: vasanth9 <cheepurupalli.vasanthkumar.com> Co-authored-by: Shanmughapriyan S <[email protected]> * hot-fix: dependency updates and fix dev runtime * chore: updated start command * migration(Layout): newFooter (#5320) Co-authored-by: Claudio Wunder <[email protected]> * feat: migrate EditLink component (#5271) Co-authored-by: Claudio Wunder <[email protected]> Co-authored-by: Wai.Tung <[email protected]> * feat(blog) Migrate BlogCard component (#5323) Co-authored-by: Michael Esteban <[email protected]> * Issue#5307 - Add framer-motion to the dependency list (#5318) * chore: add remote turbo cache and simplified gh actions cache (#5326)Co-authored-by: Aymen Naghmouchi <[email protected]> * chore: add remote turbo cache and simplified gh actions cache * chore: updated cache rules * chore: more cache rules --------- Co-authored-by: Aymen Naghmouchi <[email protected]> * chore: fix storybook local development mode (#5335) * chore: migrate pagination component (#5331) Co-authored-by: Teja Sai Sandeep Reddy Konala <[email protected]> Co-authored-by: Claudio Wunder <[email protected]> Co-authored-by: Wai.Tung <[email protected]> * Chore(node feat) (#5338) Co-authored-by: Claudio Wunder <[email protected]> * chore: migrate releases types (#5324) * hotfix: first element no margin-top * (website redesign) Feat(shellbox): migration (#5234) Co-authored-by: Manish Kumar ⛄ <[email protected]> Co-authored-by: Claudio Wunder <[email protected]> Co-authored-by: Shanmughapriyan S <[email protected]> Co-authored-by: Michael Esteban <[email protected]> Co-authored-by: Wai.Tung <[email protected]> * fix(i18n): translation key (#5347) Co-authored-by: Shanmughapriyan S <[email protected]> Co-authored-by: Claudio Wunder <[email protected]> * chore: updated dependencies * chore: vercel enable middleware and i18n redirection (#5300) * feat(unit-test): introduce unit test on website redesign branch (#5178 feat(unit-test): introduce unit test * chore: set up storybook (#5191) (#5214) * feat(stylelint,storybook): fixed styleling misconfig and fixed storybooks (#5281) * feat(DarkModeToggler): Migrate and add stories to theme toggler 🎉 (#5236) Co-authored-by: Claudio Wunder <[email protected]> Co-authored-by: Claudio Wunder <[email protected]> * chore: updated contributing guidelines, eslint rules and storybook templates (#5294) Co-authored-by: Shanmughapriyan S <[email protected]> Co-authored-by: Manish Kumar ⛄ <[email protected]> * chore: fix storybook styles, imports, typescript config and dependencies (#5319 * chore: optimises tsconfig * chiore: add missing dependencies * chore: type storybook constants * chore: styles moved styles to somewhere else * chore: add global json type definition * chore: i18n aria-label instead of sr-only * chore: added open sans font family and space between imports * chore: moved styles and fixed styles and updated banner stories * fix: stylelint rules * chore: updated tsconfig * chore: fix tests * fix: darkmodetoggle test * chore: stories use index.stories.tsx * chore: adopt turborepo (#5316 * chore: revert pnpm use plain npm * fix: package.json * chore: remove warnings and add node_env * chore: cross-env * fix: fix turbo pipelines * chore: only cache certain files * chore: turbo shouldn't care about coverage outputs * chore: proper inputs and outputs for pipelines * chore: do not store some outputs and updated inputs for lint * chore: added prettier configs * chore: remove console.info * chore: updated inputs of all other entries * feat(stability): migrate component * chore(snapshot): update * Update components/Api/Stability/index.tsx Co-authored-by: Claudio Wunder <[email protected]> Signed-off-by: Augustin Mauroy <[email protected]> * Update components/Api/Stability/index.tsx Co-authored-by: Claudio Wunder <[email protected]> Signed-off-by: Augustin Mauroy <[email protected]> * Update components/Api/Stability/index.tsx Co-authored-by: Claudio Wunder <[email protected]> Signed-off-by: Augustin Mauroy <[email protected]> * fea(stability): update stories + fix * Update components/Api/Stability/index.stories.tsx Co-authored-by: Claudio Wunder <[email protected]> Signed-off-by: Augustin Mauroy <[email protected]> * fix(i18n): update turkish language direction (#5182) * chore: rollback CODEOWNER changes (#5183) * Sync: merge `major/website-redesign` into `main` (#5356) Co-authored-by: Manish Kumar ⛄ <[email protected]> Co-authored-by: Wai.Tung <[email protected]> Co-authored-by: Shanmughapriyan S <[email protected]> Co-authored-by: Michael Esteban <[email protected]> Co-authored-by: Claudio Wunder <[email protected]> Co-authored-by: Teja Sai Sandeep Reddy Konala <[email protected]> Co-authored-by: Claudio Wunder <[email protected]> Co-authored-by: vasanth9 <cheepurupalli.vasanthkumar.com> Co-authored-by: Aymen Naghmouchi <[email protected]> Co-authored-by: Teja Sai Sandeep Reddy Konala <[email protected]> Co-authored-by: Augustin Mauroy <[email protected]> Co-authored-by: Guilherme Araújo <[email protected]> Co-authored-by: Augustin Mauroy <[email protected]> Co-authored-by: HinataKah0 <[email protected]> Co-authored-by: Olaleye Blessing <[email protected]> Co-authored-by: ktssr <[email protected]> Co-authored-by: Harkunwar Kochar <[email protected]> Co-authored-by: vasanthkumar <[email protected]> Co-authored-by: Floran Hachez <[email protected]> Co-authored-by: Jatin <[email protected]> * feat(stability): update snapshot * Update components/Api/Stability/index.tsx Co-authored-by: Jithil P Ponnan <[email protected]> Signed-off-by: Augustin Mauroy <[email protected]> * code format * Update components/Api/Stability/index.tsx Co-authored-by: Jithil P Ponnan <[email protected]> Signed-off-by: Augustin Mauroy <[email protected]> --------- Signed-off-by: Claudio Wunder <[email protected]> Signed-off-by: Augustin Mauroy <[email protected]> Co-authored-by: Claudio Wunder <[email protected]> Co-authored-by: Guilherme Araújo <[email protected]> Co-authored-by: Manish Kumar ⛄ <[email protected]> Co-authored-by: Claudio Wunder <[email protected]> Co-authored-by: Wai.Tung <[email protected]> Co-authored-by: Shanmughapriyan S <[email protected]> Co-authored-by: Michael Esteban <[email protected]> Co-authored-by: HinataKah0 <[email protected]> Co-authored-by: Olaleye Blessing <[email protected]> Co-authored-by: ktssr <[email protected]> Co-authored-by: Teja Sai Sandeep Reddy Konala <[email protected]> Co-authored-by: Harkunwar Kochar <[email protected]> Co-authored-by: vasanthkumar <[email protected]> Co-authored-by: Jatin <[email protected]> Co-authored-by: Aymen Naghmouchi <[email protected]> Co-authored-by: Teja Sai Sandeep Reddy Konala <[email protected]> Co-authored-by: Yagiz Nizipli <[email protected]> Co-authored-by: Nick Schonning <[email protected]> Co-authored-by: Floran Hachez <[email protected]> Co-authored-by: Jithil P Ponnan <[email protected]>





Migrate EditLink component from nodejs.dev
and create a new Story.
Related to: #5242