Project 9: Internationalization
| Schedule | Flex Meld |
| Time allowed | 3 hours |
Update Realm
Update to the latest minor version of Realm.
At the time I write this, it's 0.88.2-rc.5.
Cheat: How to do this
Edit the package.json and replace the version of Realm with 0.88.2-rc.5 (or any other latest version).
"dependencies": { "@redocly/realm": "0.88.2-rc.5" }
This is an experimental RC version which may be a bit unstable. Known issues:
- Scorecard is not functional at all.
- Report code snippets in OpenAPI docs is broken.
Please, report any issues in the slack thread.
¡Hola! Bonjour! Guten Tag!
The boss wants to expand our API documentation's reach across the globe! It's time to add internationalization (i18n) support to our existing website. The goal is to provide documentation in at least one additional language.
Choose Your Language
Pick One (or More): Select at least one language to add to your website. Consider your target audience and the languages most relevant to them.
Create Locale Folders
Cheat: Link to the docs (if you need it)
Translation Time!
Content Translation:
- Markdown: Translate a few markdown pages. Start from the most important ones.
- (Optional) Other File Types: Consider translating other file types (e.g. images).
Translate UI elements of the website
Cheat: Link to the docs (if you need it)
Configure the language picker
Configure language picker labels and order.
Cheat: Link to the docs (if you need it)
Translate Your APIs (Optional)
To provide a truly localized experience, consider translating parts of your OpenAPI definitions.
Debrief
Debrief on your experience. What made you smile? What did you find confusing?