-
Notifications
You must be signed in to change notification settings - Fork 47.2k
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
[WIP] Docs i18n #4633
[WIP] Docs i18n #4633
Conversation
@zpao Tell me if there are what I can do for this change. |
@zpao I checked the testing server. I think it looks good. Please tell me if there is I can do. |
Seems great, thanks @zpao ! Been waiting for this. Many Korean users (as far as I have seen) are still reading English docs, even though full translation is available in Korean. I usually give people URL of our separate docs website (http://reactkr.github.io/react/docs/getting-started.html) It would be also great if this approach can be applied to other libs like Relay, Flux, React Native, whatever lib React developers usually gets into. If enough consensus is made, React-KR contributors may be able do the same i18n job for other libs' websites. Regarding the localization url, most of the people whom participated in the translation project agreed using 'ko', instead of 'ko-KR'. Not entirely sure North Korean or Korean-Chinese people agrees that. ;) /cc @marocchino @dittos @arkist @dalinaum Not mentioning it needs to be done right now, but one more feature request is language-specific CSS. The docs website does not really look good when it is written in Korean ( Thanks, and please tell us if there's anything needed. 👍 |
Thanks for the feedback, I think we'll move forward with this and get it into shape for 0.14 launch (if not before). And it sounds like the general consensus is to use the short urls. I'm not sure how many North Koreans are using the site but they'll have to survive for a bit longer ;) We can always move to a longer url if we need. There's nothing for you all to do just yet, but stay tuned here - we'll have a little bit to do soon.
I'm hoping we land on something that can at least conceptually be shared. Right now we're using a different site generator than those projects. I'd like us to converge on a shared stack soon so that we can solve these things once but we haven't yet.
Ah, I hadn't even thought about that! Thanks, will definitely see what we can do about that. |
While reading through docs, I found one more thing needs to be done: fixing broken fragment identifiers. Example: http://reacti18n.zpao.com/react/ko-KR/docs/getting-started.html If you click on subheaders, you will see it does not work and most of non-ascii characters got cut out. |
@sairion Good catch. I'll see what we can do about that. |
@zpao How is it going? Should I update translation or wait for this PR? 😐 |
Sorry, no update here yet. I'll try to come back to it later this week. Feel free to update translations in the meantime! |
- side nav picks up the right translation - does not link to the right place - ditto for next/prev links
@zpao updated the pull request. |
Came back to this for a little bit tonight - luckily rebasing was pretty painless since I'm mostly just touching the metadata. Sidebar links and next / prev work and stay within the language you're already on. |
@zpao Anything I can help with? Typography, language links, etc? I stumbled across this after feeling your pain of updating prev/next links 👍 |
It seems likely that we’ll revamp the docs completely in the coming months so maybe this isn’t worth the effort at this point. I’ll leave it open though. |
Nothing actionable at this point. I'm still considering options that aren't Jekyll to make this better. I also want to get an external service setup with will help translators know what needs to be translated - the situation we're in with partial translations and not picking up updates to content consistently is rough. I'll leave it open because I think what I've spent time on is valuable at least as a reference for whatever happens next, and it's good for people to know it's (at least sort of) being worked on. |
@gaearon Can you say more about which revamp you mean? I know @joecritch is interested in helping out with docs updates. |
I was referring to one of the weekly meetings but maybe I got it wrong. I thought at some point I heard that the existing docs were not written very cohesively, and somebody (from the Parse team?) might eventually help us write some of them from scratch. |
FWIW, there's nothing set in stone in regards to a content revamp, just some general hopes that it'll happen. |
Do you have any plan for to translate New Docs? #7864 |
@lacker What's the plan about this? |
@thejameskyle is building an open-source-docs-translations-pipeline thingy for Yarn and we were hoping to reuse some of it for the React docs. @ericnakagawa and I will sync up with him when he's back in CA |
@lacker That's so awesome! |
I'm closing as too outdated. |
We've launched our first translations, and many need more contributors. https://reactjs.org/blog/2019/02/23/is-react-translated-yet.html |
We went past the tipping point on this a while ago and we need to surface our translated docs. I spent some time this week looking into other options for generating our site but this gets us there way faster with minimal changes. It's only half the work though - there but there's still a bunch to do. The infra is here now but we're still going to have some hacks we have to do to make links work right.
How it works (we're using http://jekyll-langs.liaohuqiu.net/):
_i18n/lang.yml
. I've done as much of the Korean as I can (copy + paste from the titles in the docs files){% t string|key %}
outputs the value and will fall back to English (default).Give it a try:
I set up a testing server - http://reacti18n.zpao.com/react/ko-KR/docs/getting-started.html
Links are definitely broken right now so no need to remind me :)
But I wanted to get some feedback before I took it any further, namely from the people who have been doing the bulk of the translation work - @tako-black, @makky3939, @marocchino, @sairion (and many others, perhaps you can spread the word amongst the translators you've been working with?), @spicyj . Does this approach so far seem like it's more maintainable for you moving forward? All of your current links will be broken but I'm not too worried about that (are you?).
TODO:
/ko-KR/
vs/ko/
,/ja-JP/
vs/ja/
,/zh-CN/
vs/zh/ (or cn?)
)