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

[Documentation]: Outdated tutorial docs #26394

Open
crimson206 opened this issue Mar 9, 2024 · 7 comments
Open

[Documentation]: Outdated tutorial docs #26394

crimson206 opened this issue Mar 9, 2024 · 7 comments
Assignees

Comments

@crimson206
Copy link

Describe the problem

Outdated translation of a tutorial

https://storybook.js.org/tutorials/intro-to-storybook/react/ko/simple-component/

Additional context

It requires migration and not works properly.

@jonniebigodes
Copy link
Contributor

@crimson206, thanks for reaching out to us by opening up this issue. We appreciate it 🙏 ! For context, the translations we currently support are based on contributions from our community. In this case, a whole team did the work, leaving me to review it from a technical standpoint and get it merged. If you're interested in updating them, can you close this issue and leave a message in this issue and ping me, expressing your interest in getting them updated? I'd be more than happy to follow up with you with any additional issues you have.

Have a great day.

Stay safe

@jonniebigodes jonniebigodes self-assigned this Mar 10, 2024
@jonniebigodes jonniebigodes moved this to Backlog in Learning Team Mar 10, 2024
@crimson206
Copy link
Author

@jonniebigodes
Unfortunately, I don't have enough time. I am just afraid that some koreans leave the page without trying the english version.
If the Korean version doesn't work, it would be better to remove it from the docs, or guide them to the english version.

@jonniebigodes
Copy link
Contributor

@crimson206 appreciate you following up with me. And as we're almost releasing a new Storybook version, I'll reach out to the team behind the translation and see if they have the time to update it. Does that sound reasonable to you?

@crimson206
Copy link
Author

@jonniebigodes
Does it mean that the tutorial might be rewritten again?
I am fine with everything because I can just read the english version.
I looked up more, and I found that the tutorial in other languages are also outdated.

If I am allowed to add some opinions,

  • add some version control(if possible) to the tutorial, so that
    • the contributions are valid longer even when they are outdated.
    • you can keep the docs cleaner without errors even after updating.
  • make it clear that they are outdated, with a link to a contribution guidance page.

You can close this issue whenever you want. Thank you. :)

@craigz
Copy link

craigz commented Mar 14, 2024

I've just been caught by this issue, having made it perhaps 3 or 4 steps thru the Simple Component tutorial.

At the point of adding the now found to be incompatible with the project @storybook/addon-a11y addon everything kind of fell apart, with a cascade of errors that after a few steps became apparent that there was not a simple fix.

For myself, I think I'lll step away from the tutorial, as I'm doing the opposite of becoming familiar with a new tool while stuck in npx um, heck.

I understand that Storybook 8 was just released and appears to be fairly major, and refactoring old tutorials is likely not high on the tasks list at the moment. I'd suggest dropping a banner or something in this and any other older tutorial, stating the latest supported version so folks don't follow in my steps and end up leaving in frustration.

Best.

@crimson206
Copy link
Author

@craigz
Thank you for joining this issue. I agree with you. No matter how this project good is, someone might not try further if their first experience is bad. Programming is always the chain of frustration. 😭

@jonniebigodes
Copy link
Contributor

@craigz appreciate you following up on this issue, and I am sorry you're having problems with it. So that you're aware, the tutorials (including code) will be updated shortly; they weren't due to some other documentation-related items related to the recent release that took precedence.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
Status: Backlog
Development

No branches or pull requests

4 participants