Skip to content

Localize README.md

Jump to bottom
ehom edited this page May 21, 2019 · 3 revisions

Here's some information if you get your README.md localized.

TODO: document some practices to make your README.md localizable.

Puppet Forge will look in <module-name>/readmes for README_<locale-id>.md if the browser language is not set to English. It will fallback to the default version if the corresponding non-English version is not found.

For Instance:

The README.md from puppetlabs-mysql gets localized and then goes here:

puppetlabs-mysql/readmes as README_ja_JP.md

Contributor Summit Project Month

Internationalize a Puppet module

  1. Setting up
  2. Puppet module i18n: Ruby code
  3. Puppet module i18n: Puppet code
  4. Add module metadata
  5. Produce a single .pot file for localization
  6. Target locations for the localized files
Clone this wiki locally