Skip to content

Commit

Permalink
#226 switch localization to Weblate in docs
Browse files Browse the repository at this point in the history
  • Loading branch information
andrewtavis committed Jul 28, 2024
1 parent 39af5a8 commit c8bfc45
Show file tree
Hide file tree
Showing 9 changed files with 58 additions and 12 deletions.
2 changes: 1 addition & 1 deletion .github/ISSUE_TEMPLATE/localization.yml
Original file line number Diff line number Diff line change
Expand Up @@ -23,4 +23,4 @@ body:
- type: markdown
attributes:
value: |
Thanks for your efforts to bring activist to other languages!
Thanks for your efforts to bring activist to other languages! Please join us in the [localization project on Weblate](https://hosted.weblate.org/projects/activist/activist) and the [Localization channel on Matrix](https://matrix.to/#/!DzbdYyfhjinQBWXgQe:matrix.org?via=matrix.org) to get involved!
2 changes: 1 addition & 1 deletion CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -56,7 +56,7 @@ Emojis for the following are chosen based on [gitmoji](https://gitmoji.dev/).

- Localization switching is achieved via a dropdown with routing applied to links.
- All platform texts are written in JSON files for easy localization.
- A localization process has been set up with [Transifex](https://www.transifex.com/).
- A localization process has been set up with [Weblate](https://weblate.org).
- Aria labels are written using translatable strings for localized accessibility.

### ♻️ Code Quality
Expand Down
6 changes: 4 additions & 2 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -63,7 +63,7 @@ The following are the current and planned technologies for [activist.org](https:

### Localization

- [Nuxt I18n](https://github.com/nuxt-modules/i18n)[Transifex](https://www.transifex.com/) ([activist on Transifex](https://explore.transifex.com/activist-org/activist))
- [Nuxt I18n](https://github.com/nuxt-modules/i18n)[Weblate](https://weblate.org) ([activist on Weblate](https://hosted.weblate.org/projects/activist/activist))

### Analytics

Expand Down Expand Up @@ -422,7 +422,9 @@ Thank you in advance for your contributions!
## Localization [`⇧`](#contents)
Localization for activist happens within our [public localization project on Transifex](https://explore.transifex.com/activist-org/activist). Join us there if you'd like to help bring activist to other languages!
<a href="https://hosted.weblate.org/projects/activist/activist"><img src="https://raw.githubusercontent.com/activist-org/Organization/main/resources/images/logos/WeblateLogo.png" height="100" alt="Visit Weblate project" align="right"></a>
Localization for activist happens on our [public localization project on Weblate](https://hosted.weblate.org/projects/activist/activist). Join us there if you'd like to help bring activist to other languages!
To find issues related to localization, please see the [`localization`](https://github.com/activist-org/activist/issues?q=is%3Aopen+is%3Aissue+label%3Alocalization) label in the [issues](https://github.com/activist-org/activist/issues), and to report a localization issue use the [localization issue form](https://github.com/activist-org/activist/issues/new?assignees=&labels=localization&projects=activist-org%2F1&template=localization.yml). Please also see the [style guide](https://github.com/activist-org/activist/blob/main/STYLEGUIDE.md) for more information on how to create new localization keys.
Expand Down
33 changes: 33 additions & 0 deletions LOCALIZATION.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,33 @@
# Localizing via Weblate

<a href="https://hosted.weblate.org/projects/activist/activist"><img src="https://raw.githubusercontent.com/activist-org/Organization/main/resources/images/logos/WeblateLogo.png" height="100" alt="Visit Weblate project" align="right"></a>

[Weblate](https://weblate.org) localization is as easy as making an account and jumping into the activist project!

1. First [register at Weblate](https://hosted.weblate.org/accounts/register/) (you can also authenticate with GitHub or other accounts)

- We suggest that you do link your GitHub account so you get credit for the localization commits!

2. Navigate to the activist project at [weblate.org/projects/activist/activist](https://hosted.weblate.org/projects/activist/activist)

3. Click on a language you want to start translating

4. You can browse the available strings or start translating directly

- When translating a word, be sure to check the glossary context if you're not sure what the string's use is

- You can also make use of Automatic suggestions to see machine translations if you need help

5. Hit `Save and continue` when you're ready to move to the next string

6. Maintainers will open up pull requests from [Weblate](https://weblate.org) to the activist repo to bring in the new strings

- Changes are also automatically sent every 24 hours

Thanks so much for your interest in supporting activist's localization!

### Localization coverage

<a href="https://hosted.weblate.org/projects/activist/activist">
<img src="https://hosted.weblate.org/widget/activist/activist/multi-auto.svg" alt="Translation status" />
</a>
17 changes: 14 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,7 @@
[![license](https://img.shields.io/github/license/activist-org/activist-iOS.svg?label=%20)](https://github.com/activist-org/activist/blob/main/LICENSE.txt)
[![coc](https://img.shields.io/badge/Contributor%20Covenant-ff69b4.svg)](https://github.com/activist-org/activist/blob/main/.github/CODE_OF_CONDUCT.md)
[![instagram](https://img.shields.io/badge/Instagram-8134AF.svg?logo=instagram&logoColor=ffffff)](https://instagram.com/activist_org)
[![weblate](https://img.shields.io/badge/Weblate-144D3F.svg?logo=weblate&logoColor=ffffff)](https://hosted.weblate.org/projects/activist/activist)
[![matrix](https://img.shields.io/badge/Matrix-000000.svg?logo=matrix&logoColor=ffffff)](https://matrix.to/#/#activist_community:matrix.org)

<details><summary>🌐 Language</summary>
Expand Down Expand Up @@ -108,7 +109,7 @@ We would be happy to discuss granting you further rights as a contributor after
- [Reporting bugs](https://github.com/activist-org/activist/issues/new?assignees=&labels=bug&template=bug_report.yml) as they're found 🐞
- Working with us on [new features](https://github.com/activist-org/activist/issues?q=is%3Aissue+is%3Aopen+label%3Afeature)
- [Localizing](https://github.com/activist-org/activist/issues?q=is%3Aissue+is%3Aopen+label%3Alocalization) content for the platform 🌐
- Please join our [public localization project on Transifex](https://explore.transifex.com/activist-org/activist)!
- Please join our [public localization project on Weblate](https://hosted.weblate.org/projects/activist/activist)!
- [Documentation](https://github.com/activist-org/activist/issues?q=is%3Aissue+is%3Aopen+label%3Adocumentation) for onboarding and project cohesion 📝
- [Sharing activist.org](https://github.com/activist-org/activist/issues/23) with others! 🚀

Expand Down Expand Up @@ -251,7 +252,7 @@ The following are the current and planned technologies for [activist.org](https:

### Internationalization

- [Nuxt I18n](https://github.com/nuxt-modules/i18n) • [Transifex](https://www.transifex.com/) ([activist on Transifex](https://explore.transifex.com/activist-org/activist))
- [Nuxt I18n](https://github.com/nuxt-modules/i18n) • [Weblate](https://weblate.org) ([activist on Weblate](https://hosted.weblate.org/projects/activist/activist))

### Analytics

Expand Down Expand Up @@ -372,10 +373,20 @@ We are still developing our operating principles and will always update them bas

# Localization [`⇧`](#contents)

<a href="https://hosted.weblate.org/projects/activist/activist"><img src="https://raw.githubusercontent.com/activist-org/Organization/main/resources/images/logos/WeblateLogo.png" height="100" alt="Visit Weblate project" align="right"></a>

We need to break down language barriers in order to mobilize larger and more diverse coalitions. Translation requests will be available for several assets on the platform - organization profiles, events and resources - and we are growing our network of volunteer contributors to facilitate this.

> [!NOTE]
> Want to join our translators working group? Please join our [public localization project on Transifex](https://explore.transifex.com/activist-org/activist).
> Want to join our translators working group? Please join the [Localization channel in our Matrix space](https://matrix.to/#/!DzbdYyfhjinQBWXgQe:matrix.org?via=matrix.org).

Localization of activist is done via [Weblate](https://weblate.org). Please see the [localization guide](https://github.com/activist-org/activist/blob/main/CONTRIBUTING.md) for information on how to get started!

### Localization coverage [`⇧`](#contents)

<a href="https://hosted.weblate.org/projects/activist/activist">
<img src="https://hosted.weblate.org/widget/activist/activist/multi-auto.svg" alt="Translation status" />
</a>

<a id="supporters-partners"></a>

Expand Down
2 changes: 1 addition & 1 deletion STYLEGUIDE.md
Original file line number Diff line number Diff line change
Expand Up @@ -238,7 +238,7 @@ activist is a global platform and must function in countless different regions a
> All keys should be defined within the [en-US.json file](https://github.com/activist-org/activist/blob/main/frontend/i18n/en-US.json)
>
> - This is the source from which all the other languages are translated from
> - Edits to the other files need to be made on activist's [public localization project on Transifex](https://explore.transifex.com/activist-org/activist)
> - Edits to the other files should be made on activist's [public localization project on Weblate](https://hosted.weblate.org/projects/activist/activist)
> - Please alphabetize the keys, with your code editor likely having built in functionality for this
> - Do not put the dictionary into different levels!
> - The purpose of one flat dictionary is so that we can search for the key in the codebase and easily find its uses and where it's defined
Expand Down
2 changes: 1 addition & 1 deletion frontend/components/page/PageCommunityFooter.vue
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,7 @@
{{ $t("_global.visit-our") }}
<a
class="focus-brand link-text items-center"
href="https://explore.transifex.com/activist-org/activist/"
href="https://hosted.weblate.org/projects/activist/activist"
target="_blank"
>
{{ $t("components.page-community-footer.invite-text-4-2") }}
Expand Down
4 changes: 2 additions & 2 deletions frontend/i18n/en-US.json
Original file line number Diff line number Diff line change
Expand Up @@ -372,7 +372,7 @@
"components.page-community-footer.invite-text-2-3": "to contribute code or request a feature",
"components.page-community-footer.invite-text-3-1": "Join us in our",
"components.page-community-footer.invite-text-3-3": "to share ideas or chat with the team :)",
"components.page-community-footer.invite-text-4-2": "Transifex project",
"components.page-community-footer.invite-text-4-2": "Weblate project",
"components.page-community-footer.invite-text-4-3": "if you want to help us localize the platform",
"components.page-community-footer.need-help": "Need help? Please get in touch!",
"components.page-community-footer.need-help-text-1-1": "Reach out to us in our",
Expand Down Expand Up @@ -714,7 +714,7 @@
"pages.supporters.join.section-5-paragraph-1-1": "Be it artistic contributions or legal consulting, we'd love to discuss how we could work together. We'd be happy to give credit in the Contributors section of our",
"pages.supporters.join.section-5-paragraph-1-2": "supporters page",
"pages.supporters.join.section-5-subheader": "Help activist with your skills",
"pages.supporters.join.section-6-paragraph-1-2": "Transifex",
"pages.supporters.join.section-6-paragraph-1-2": "Weblate",
"pages.supporters.join.section-6-paragraph-1-3": "page to help today.",
"pages.supporters.join.section-6-subheader": "Localization",
"pages.supporters.showcase.section-1-paragraph-1-1": "The following is an overview of organizations and individuals that have supported the development of activist. Those interested in providing support can read more about how they can help on the",
Expand Down
2 changes: 1 addition & 1 deletion frontend/pages/supporters/join.vue
Original file line number Diff line number Diff line change
Expand Up @@ -73,7 +73,7 @@
{{ $t("_global.visit-our") }}
<a
class="focus-brand link-text"
href="https://explore.transifex.com/activist-org/activist"
href="https://hosted.weblate.org/projects/activist/activist"
target="_blank"
>
{{ $t("pages.supporters.join.section-6-paragraph-1-2") }}
Expand Down

0 comments on commit c8bfc45

Please sign in to comment.