Skip to content

Commit 321a39c

Browse files
authored
Merge branch 'master' into translate/handling-events
2 parents eec235f + 22f7f24 commit 321a39c

39 files changed

+569
-121
lines changed

content/authors.yml

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -73,6 +73,9 @@ sophiebits:
7373
steveluscher:
7474
name: Steven Luscher
7575
url: https://twitter.com/steveluscher
76+
tesseralis:
77+
name: Nat Alison
78+
url: https://twitter.com/tesseralis
7679
timer:
7780
name: Joe Haddad
7881
url: https://twitter.com/timer150
Lines changed: 76 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,76 @@
1+
---
2+
title: "Is React Translated Yet? ¡Sí! Sim! はい!"
3+
author: [tesseralis]
4+
---
5+
6+
We’re excited to announce an ongoing effort to maintain official translations of the React documentation website into different languages. Thanks to the dedicated efforts of React community members from around the world, React is now being translated into *over 30* languages! You can find them on the new [Languages](/languages) page.
7+
8+
In addition, the following three languages have completed translating most of the React Docs! 🎉
9+
10+
* **Spanish: [es.reactjs.org](https://es.reactjs.org)**
11+
* **Japanese: [ja.reactjs.org](https://ja.reactjs.org)**
12+
* **Brazilian Portuguese: [pt-br.reactjs.org](https://pt-br.reactjs.org)**
13+
14+
Special congratulations to [Alejandro Ñáñez Ortiz](https://github.com/alejandronanez), [Rainer Martínez Fraga](https://github.com/carburo), [David Morales](https://github.com/dmorales), [Miguel Alejandro Bolivar Portilla](https://github.com/Darking360), and all the contributors to the Spanish translation for being the first to *completely* translate the core pages of the docs!
15+
16+
## Why Localization Matters
17+
18+
React already has many meetups and conferences around the world, but many programmers don't use English as their primary language. We’d love to support local communities who use React by making our documentation available in most popular languages.
19+
20+
In the past, React community members have created unofficial translations for [Chinese](https://github.com/discountry/react), [Arabic](https://wiki.hsoub.com/React), and [Korean](https://github.com/reactjs/ko.reactjs.org/issues/4); by making an official channel for these translated docs we're hoping to make them easier to find and help make sure that non-English-speaking users of React aren't left behind.
21+
22+
## Contributing
23+
24+
If you would like to help out on a current translation, check out the [Languages](/languages) page and click on the "Contribute" link for your language.
25+
26+
Can't find your language? If you'd like to maintain your langauge's translation fork, follow the instructions in the [translation repo](https://github.com/reactjs/reactjs.org-translation#starting-a-new-translation)!
27+
28+
## Backstory
29+
30+
Hi everyone! I'm [Nat](https://twitter.com/tesseralis)! You may know me as the [polyhedra lady](https://www.youtube.com/watch?v=Ew-UzGC8RqQ). For the past few weeks, I've been helping the React team coordinate their translation effort. Here's how I did it.
31+
32+
Our original approach for translations was to use a SaaS platform that allows users to submit translations. There was already a [pull request](https://github.com/reactjs/reactjs.org/pull/873) to integrate it and my original responsibility was to finish that integration. However, we had concerns about the feasibility of that integration and the current quality of translations on the platform. Our primary concern was ensuring that translations kept up to date with the main repo and didn't become "stale".
33+
34+
[Dan](https://twitter.com/dan_abramov) encouraged me to look for alternate solutions, and we stumbled across how [Vue](https://vuejs.org) maintained its translations -- through different forks of the main repo on GitHub. In particular, the [Japanese translation](https://jp.vuejs.org) used a bot to periodically check for changes in the English repo and submits pull requests whenever there is a change.
35+
36+
This approach appealed to us for several reasons:
37+
38+
* It was less code integration to get off the ground.
39+
* It encouraged active maintainers for each repo to ensure quality.
40+
* Contributors already understand GitHub as a platform and are motivated to contribute directly to the React organization.
41+
42+
We started of with an initial trial period of three languages: Spanish, Japanese, and Simplified Chinese. This allowed us to work out any kinks in our process and make sure future translations are set up for success. I wanted to give the translation teams freedom to choose whatever tools they felt comfortable with. The only requirement is a [checklist](https://github.com/reactjs/reactjs.org-translation/blob/master/PROGRESS.template.md) that outlines the order of importance for translating pages.
43+
44+
After the trial period, we were ready to accept more languages. I created [a script](https://github.com/reactjs/reactjs.org-translation/blob/master/scripts/create.js) to automate the creation of the new language repo, and a site, [Is React Translated Yet?](https://isreacttranslatedyet.com), to track progress on the different translations. We started *10* new translations on our first day alone!
45+
46+
Because of the automation, the rest of the maintance went mostly smoothly. We eventually created a [Slack channel](https://rt-slack-invite.herokuapp.com) to make it easier for translators to share information, and I released a guide solidifying the [responsibilities of maintainers](https://github.com/reactjs/reactjs.org-translation/blob/master/maintainer-guide.md). Allowing translators to talk with each other was a great boon -- for example, the Arabic, Persian, and Hebrew translations were able to talk to each other in order to get [right-to-left text](https://en.wikipedia.org/wiki/Right-to-left) working!
47+
48+
## The Bot
49+
50+
The most challenging part was getting the bot to sync changes from the English version of the site. Initially we were using the [che-tsumi](https://github.com/vuejs-jp/che-tsumi) bot created by the Japanese Vue translation team, but we soon decided to build our own bot to suit our needs. In particular, the che-tsumi bot works by [cherry picking](https://git-scm.com/docs/git-cherry-pick) new commits. This ended up causing a cavalade of new issues that were interconnected, especially when [Hooks were released](/blog/2019/02/06/react-v16.8.0.html).
51+
52+
In the end, we decided that instead of cherry picking each commit, it made more sense to merge all new commits and create a pull request around once a day. Conflicts are merged as-is and listed in the [pull request](https://github.com/reactjs/pt-BR.reactjs.org/pull/114), leaving a checklist for maintainers to fix.
53+
54+
Creating the [sync script](https://github.com/reactjs/reactjs.org-translation/blob/master/scripts/sync.js) was easy enough: it downloads the translated repo, adds the original as a remote, pulls from it, merges the conflicts, and creates a pull request.
55+
56+
The problem was finding a place for the bot to run. I'm a frontend developer for a reason -- Heroku and its ilk are alien to me and *endlessly* frustrating. In fact, until this past Tuesday, I was running the script by hand on my local machine!
57+
58+
The biggest challenge was space. Each fork of the repo is around 100MB -- which takes minutes to clone on my local machine. We have *32* forks, and the free tiers or most deployment platforms I checked limited you to 512MB of storage.
59+
60+
After lots of notepad calculations, I found a solution: delete each repo once we've finished the script and limit the concurrency of `sync` scripts that run at once to be within the storage requirements. Luckily, Heroku dynos have a much faster Internet connection and are able to clone even the React repo quickly.
61+
62+
There were other smaller issues that I ran into. I tried using the [Heroku Scheduler](https://elements.heroku.com/addons/scheduler) add-on so I didn't have to write any actual `watch` code, but it end up running too inconsistently, and I [had an existential meltdown on Twitter](https://twitter.com/tesseralis/status/1097387938088796160) when I couldn't figure out how to send commits from the Heroku dyno. But in the end, this frontend engineer was able to get the bot working!
63+
64+
There are, as always, improvements I want to make to the bot. Right now it doesn't check whether there is an outstanding pull request before pushing another one. It's still hard to tell the exact change that happened in the original source, and it's possible to miss out on a needed translation change. But I trust the maintainers we've chosen to work through these issues, and the bot is [open source](https://github.com/reactjs/reactjs.org-translation) if anyone wants to help me make these improvements!
65+
66+
## Thanks
67+
68+
Finally, I would like to extend my gratitude to the following people and groups:
69+
70+
* All the translation maintainers and contributors who are helping translate React to more than thirty languages.
71+
* The [Vue.js Japan User Group](https://github.com/vuejs-jp) for initiating the idea of having bot-managed translations, and especially [Hanatani Takuma](https://github.com/potato4d) for helping us understand their approach and helping maintain the Japanese translation.
72+
* [Soichiro Miki](https://github.com/smikitki) for many [contributions](https://github.com/reactjs/reactjs.org/pull/1636) and thoughtful comments on the overall translation process, as well as for maintaining the Japanese translation.
73+
* [Eric Nakagawa](https://github.com/ericnakagawa) for managing our previous translation process.
74+
* [Brian Vaughn](https://github.com/bvaughn) for setting up the [languages page](/languages) and managing all the subdomains.
75+
76+
And finally, thank you to [Dan Abramov](https://twitter.com/dan_abramov) for giving me this opportunity and being a great mentor along the way.

content/docs/accessibility.md

Lines changed: 19 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -19,8 +19,8 @@ The [Web Content Accessibility Guidelines](https://www.w3.org/WAI/intro/wcag) pr
1919
The following WCAG checklists provide an overview:
2020

2121
- [WCAG checklist from Wuhcag](https://www.wuhcag.com/wcag-checklist/)
22-
- [WCAG checklist from WebAIM](http://webaim.org/standards/wcag/checklist)
23-
- [Checklist from The A11Y Project](http://a11yproject.com/checklist.html)
22+
- [WCAG checklist from WebAIM](https://webaim.org/standards/wcag/checklist)
23+
- [Checklist from The A11Y Project](https://a11yproject.com/checklist.html)
2424

2525
### WAI-ARIA {#wai-aria}
2626

@@ -114,7 +114,7 @@ Every HTML form control, such as `<input>` and `<textarea>`, needs to be labeled
114114
The following resources show us how to do this:
115115

116116
- [The W3C shows us how to label elements](https://www.w3.org/WAI/tutorials/forms/labels/)
117-
- [WebAIM shows us how to label elements](http://webaim.org/techniques/forms/controls)
117+
- [WebAIM shows us how to label elements](https://webaim.org/techniques/forms/controls)
118118
- [The Paciello Group explains accessible names](https://www.paciellogroup.com/blog/2017/04/what-is-an-accessible-name/)
119119

120120
Although these standard HTML practices can be directly used in React, note that the `for` attribute is written as `htmlFor` in JSX:
@@ -129,13 +129,13 @@ Although these standard HTML practices can be directly used in React, note that
129129
Error situations need to be understood by all users. The following link shows us how to expose error texts to screen readers as well:
130130

131131
- [The W3C demonstrates user notifications](https://www.w3.org/WAI/tutorials/forms/notifications/)
132-
- [WebAIM looks at form validation](http://webaim.org/techniques/formvalidation/)
132+
- [WebAIM looks at form validation](https://webaim.org/techniques/formvalidation/)
133133

134134
## Focus Control {#focus-control}
135135

136136
Ensure that your web application can be fully operated with the keyboard only:
137137

138-
- [WebAIM talks about keyboard accessibility](http://webaim.org/techniques/keyboard/)
138+
- [WebAIM talks about keyboard accessibility](https://webaim.org/techniques/keyboard/)
139139

140140
### Keyboard focus and focus outline {#keyboard-focus-and-focus-outline}
141141

@@ -152,13 +152,13 @@ Provide a mechanism to allow users to skip past navigation sections in your appl
152152
Skiplinks or Skip Navigation Links are hidden navigation links that only become visible when keyboard users interact with the page. They are very easy to implement with
153153
internal page anchors and some styling:
154154

155-
- [WebAIM - Skip Navigation Links](http://webaim.org/techniques/skipnav/)
155+
- [WebAIM - Skip Navigation Links](https://webaim.org/techniques/skipnav/)
156156

157157
Also use landmark elements and roles, such as `<main>` and `<aside>`, to demarcate page regions as assistive technology allow the user to quickly navigate to these sections.
158158

159159
Read more about the use of these elements to enhance accessibility here:
160160

161-
- [Accessible Landmarks](http://www.scottohara.me/blog/2018/03/03/landmarks.html)
161+
- [Accessible Landmarks](https://www.scottohara.me/blog/2018/03/03/landmarks.html)
162162

163163
### Programmatically managing focus {#programmatically-managing-focus}
164164

@@ -387,7 +387,7 @@ These are toolboxes filled with HTML attributes that are fully supported in JSX
387387
Each type of widget has a specific design pattern and is expected to function in a certain way by users and user agents alike:
388388

389389
- [WAI-ARIA Authoring Practices - Design Patterns and Widgets](https://www.w3.org/TR/wai-aria-practices/#aria_ex)
390-
- [Heydon Pickering - ARIA Examples](http://heydonworks.com/practical_aria_examples/)
390+
- [Heydon Pickering - ARIA Examples](https://heydonworks.com/practical_aria_examples/)
391391
- [Inclusive Components](https://inclusive-components.design/)
392392

393393
## Other Points for Consideration {#other-points-for-consideration}
@@ -396,7 +396,7 @@ Each type of widget has a specific design pattern and is expected to function in
396396

397397
Indicate the human language of page texts as screen reader software uses this to select the correct voice settings:
398398

399-
- [WebAIM - Document Language](http://webaim.org/techniques/screenreader/#language)
399+
- [WebAIM - Document Language](https://webaim.org/techniques/screenreader/#language)
400400

401401
### Setting the document title {#setting-the-document-title}
402402

@@ -412,15 +412,15 @@ Ensure that all readable text on your website has sufficient color contrast to r
412412

413413
- [WCAG - Understanding the Color Contrast Requirement](https://www.w3.org/TR/UNDERSTANDING-WCAG20/visual-audio-contrast-contrast.html)
414414
- [Everything About Color Contrast And Why You Should Rethink It](https://www.smashingmagazine.com/2014/10/color-contrast-tips-and-tools-for-accessibility/)
415-
- [A11yProject - What is Color Contrast](http://a11yproject.com/posts/what-is-color-contrast/)
415+
- [A11yProject - What is Color Contrast](https://a11yproject.com/posts/what-is-color-contrast/)
416416

417-
It can be tedious to manually calculate the proper color combinations for all cases in your website so instead, you can [calculate an entire accessible color palette with Colorable](http://jxnblk.com/colorable/).
417+
It can be tedious to manually calculate the proper color combinations for all cases in your website so instead, you can [calculate an entire accessible color palette with Colorable](https://jxnblk.com/colorable/).
418418

419419
Both the aXe and WAVE tools mentioned below also include color contrast tests and will report on contrast errors.
420420

421421
If you want to extend your contrast testing abilities you can use these tools:
422422

423-
- [WebAIM - Color Contrast Checker](http://webaim.org/resources/contrastchecker/)
423+
- [WebAIM - Color Contrast Checker](https://webaim.org/resources/contrastchecker/)
424424
- [The Paciello Group - Color Contrast Analyzer](https://www.paciellogroup.com/resources/contrastanalyser/)
425425

426426
## Development and Testing Tools {#development-and-testing-tools}
@@ -471,7 +471,7 @@ You can also use the [react-axe](https://github.com/dylanb/react-axe) module to
471471

472472
#### WebAIM WAVE {#webaim-wave}
473473

474-
The [Web Accessibility Evaluation Tool](http://wave.webaim.org/extension/) is another accessibility browser extension.
474+
The [Web Accessibility Evaluation Tool](https://wave.webaim.org/extension/) is another accessibility browser extension.
475475

476476
#### Accessibility inspectors and the Accessibility Tree {#accessibility-inspectors-and-the-accessibility-tree}
477477

@@ -498,7 +498,7 @@ Please note that browser / screen reader combinations matter. It is recommended
498498

499499
Refer to the following guides on how to best use NVDA:
500500

501-
- [WebAIM - Using NVDA to Evaluate Web Accessibility](http://webaim.org/articles/nvda/)
501+
- [WebAIM - Using NVDA to Evaluate Web Accessibility](https://webaim.org/articles/nvda/)
502502
- [Deque - NVDA Keyboard Shortcuts](https://dequeuniversity.com/screenreaders/nvda-keyboard-shortcuts)
503503

504504
#### VoiceOver in Safari {#voiceover-in-safari}
@@ -507,26 +507,26 @@ VoiceOver is an integrated screen reader on Apple devices.
507507

508508
Refer to the following guides on how activate and use VoiceOver:
509509

510-
- [WebAIM - Using VoiceOver to Evaluate Web Accessibility](http://webaim.org/articles/voiceover/)
510+
- [WebAIM - Using VoiceOver to Evaluate Web Accessibility](https://webaim.org/articles/voiceover/)
511511
- [Deque - VoiceOver for OS X Keyboard Shortcuts](https://dequeuniversity.com/screenreaders/voiceover-keyboard-shortcuts)
512512
- [Deque - VoiceOver for iOS Shortcuts](https://dequeuniversity.com/screenreaders/voiceover-ios-shortcuts)
513513

514514
#### JAWS in Internet Explorer {#jaws-in-internet-explorer}
515515

516-
[Job Access With Speech](http://www.freedomscientific.com/Products/Blindness/JAWS) or JAWS, is a prolifically used screen reader on Windows.
516+
[Job Access With Speech](https://www.freedomscientific.com/Products/software/JAWS/) or JAWS, is a prolifically used screen reader on Windows.
517517

518518
Refer to the following guides on how to best use JAWS:
519519

520-
- [WebAIM - Using JAWS to Evaluate Web Accessibility](http://webaim.org/articles/jaws/)
520+
- [WebAIM - Using JAWS to Evaluate Web Accessibility](https://webaim.org/articles/jaws/)
521521
- [Deque - JAWS Keyboard Shortcuts](https://dequeuniversity.com/screenreaders/jaws-keyboard-shortcuts)
522522

523523
### Other Screen Readers {#other-screen-readers}
524524

525525
#### ChromeVox in Google Chrome {#chromevox-in-google-chrome}
526526

527-
[ChromeVox](http://www.chromevox.com/) is an integrated screen reader on Chromebooks and is available [as an extension](https://chrome.google.com/webstore/detail/chromevox/kgejglhpjiefppelpmljglcjbhoiplfn?hl=en) for Google Chrome.
527+
[ChromeVox](https://www.chromevox.com/) is an integrated screen reader on Chromebooks and is available [as an extension](https://chrome.google.com/webstore/detail/chromevox/kgejglhpjiefppelpmljglcjbhoiplfn?hl=en) for Google Chrome.
528528

529529
Refer to the following guides on how best to use ChromeVox:
530530

531531
- [Google Chromebook Help - Use the Built-in Screen Reader](https://support.google.com/chromebook/answer/7031755?hl=en)
532-
- [ChromeVox Classic Keyboard Shortcuts Reference](http://www.chromevox.com/keyboard_shortcuts.html)
532+
- [ChromeVox Classic Keyboard Shortcuts Reference](https://www.chromevox.com/keyboard_shortcuts.html)

0 commit comments

Comments
 (0)