Skip to content

Latest commit

 

History

History
69 lines (40 loc) · 3.12 KB

CONTRIBUTING.md

File metadata and controls

69 lines (40 loc) · 3.12 KB

Contributing

First off, thanks for taking the time to contribute!

To contribute to code or an existing note in this repository, first create a fork and then make a change on your fork. Next, create a pull request that contains your changes to a document. Your pull request will be reviewed by a project maintainer and then merged into the main repository.

Help with website translations

If you're comfortable with code, please follow the instructions below. If you're not comfortable with code but still want to help, reach out to us in the #translation channel of the OWA Discord.

Adding a new language

1. Translate the global content

Global content is located in two files:

  • _data/languages_base.json
  • _data/navigation.json

In _data/languages_base.json, add the new language to the supported array, using the the ISO language code.

Duplicate the english object with the new languages translations.

The new language object in the data files must include all properties on the en object.

The url of navigation links should remain in english.

2. Populate all the pages and posts

From the root project directory, run npm run generate.

This script will:

  • create a new folder with the new language code
  • create a copy of each page located in src/pages
  • create a copy of each post located in src/post
  • create a copy of the tag page in src/robots-meta
  • update the copied files permalinks to prepend the new language code
  • add translated: false to the page's front matter

3. Translate pages

Translate the copied version of the homepage and any additional pages you are translating.

Remove the translated: false property from the front matter of pages you have translated. This will remove the "not yet translated" banner from the page.

4. Add language autodetection for homepage

Update netlify.toml to include a redirect on the homepage to auto detect the user's language based on browser preference

Raise a pull request 🎉

Translating pages for existing language

Each language has a folder corresponding with its ISO language code.

Files in this folder that are currently in English can be translated directly.

Once the page is translated, (including the front matter title and meta description), please remove the translated: false property. This will remove the "not yet translated" banner from the page.

Raise a pull request 🎉

Guidelines

A few questions you may have when translating:

  • "Open Web Advocacy" should be treated as a proper noun and remain in English.
  • Hashtags and social media platform names should be treated as proper nouns and remain in English.
  • If the translated language has a formal and informal option, err on the side of direct and informal. For example in Spanish, this would be using the term "tú" instead of "usted". When not sure, check out what similiar organisations like Wikipedia, Greenpeace and Mozilla do. Or feel free to reach out to us on Discord.