Skip to content

Translating

Hans5958 edited this page Aug 23, 2023 · 20 revisions

This page contains all things related to translating the Scratch Addons website.

Hosting

All localization files are uploaded to https://github.com/ScratchAddons/website-i18n (later will be called the i18n repository), with translatable strings being uploaded to Transifex on https://app.transifex.com/scratch-addons/scratch-addons-website. All translations should be done on the mentioned Transifex project.

The localized strings will be uploaded to the i18n repository, which then triggers the build workflow on https://github.com/ScratchAddons/website-v2 (later will be called the Hugo repository). These updates will be done at 00:30 GMT, with an offset of hours depending on traffic.

Resources

There are various resources that you can translate on Transifex. The current types of resources that can be translated are listed below.

¹ This type is separated into multiple resources.

For more information, read i18n repository files.

Threshold

The threshold of all of the resources are 0%. This means that the every resources will always be updated when it is changed on Transifex. If the strings haven't been translated, it will use the English one.

Priority

The priority of these translations are listed below. Keep in mind that this is just a recommendation. You can do it in any order.

  1. Hugo i18n strings → all except strings ended with Page (e.g. AddonsPage)
  2. Hugo i18n strings → IndexPage
    HTML, front matter - /
  3. HTML, content - /welcome
    HTML, content - /farewell
    HTML, front matter - /welcome
    HTML, front matter - /farewell
  4. HTML, content → others
    HTML, front matter → others
    Hugo i18n strings → others
  5. Markdown
    Contributor types
    Changelog

Notes and warnings

General

  1. It is recommended to translate the extension counterpart before coming here. The website is more like a side project.
  2. Unlike the extension counterpart, the translation of the website is quite lenient and flexible. There is no deadline; no need to rush. Start, stop, and continue at any time.
  3. Make sure to not miss any tags. It is recommend to copy the tags before translating it. This will ensure that it will be displayed correctly.
  4. It is recommended to sort by priority and do it from the highest. Also, use the search feature to filter through the available resources. All resources are tagged appropriately.
  5. Be comfortable with Markdown. Other than the Markdown resources, Markdown could be used in other parts/resources. Here are some resources that you can take a look.
  6. Any big changes will be announced through Transifex.

Documentation

The Documentation is probably the largest section to translate on the whole website, yet only select people read it. So, if you are quite ambitious and think you have enough time and effort to translate Scratch Addons, you can go ahead and translate it. But, there are more things that you need to know before translating it.

  1. Try to finish other resources before translating it.
  2. Familiarity with Markdown and the Scratch Addons extension is required.
  3. Content may change at any time, with or without warning.
  4. Remember, there is no deadline! Start, stop, and continue at any time.

Offsite resources

The website is using these off-site resources for it's translation, and it is listed below. You can check out the available links if you want to translate them.

  1. Scratch Addons (the extension itself)

    This is used for addons-data, which is used on the addons page. Indirectly, the translations are taken from the Scratch Addons Extension project, so translation should be done there.

    This will be manually updated on each Scratch Addons release.

  2. giscus (comments system)

    This is used for the comments section of select pages. To translate, read Adding localizations on giscus' CONTRIBUTING.md.

    If it is recently added, it will be included in the next site deployment.