diff --git a/docs/translations.md b/docs/translations.md index 48841d08a1c..de94545d2d8 100644 --- a/docs/translations.md +++ b/docs/translations.md @@ -11,8 +11,8 @@ If there's not, then today is your day to lead this effort! Here's how to start: 1. [Fork this repository](https://github.com/github/opensource.guide/fork) 1. Create a new branch for your translation work e.g. `es`. 1. Copy `_data/locales/en.yml` to your target language file e.g. `_data/locales/es.yml` and translate all the strings. -1. Copy `index.html` to your target language index file e.g. `es.html` and update the `lang:`. -1. Create a new directory in `_articles/` for your language e.g. `_articles/es/`, copy each guide from `_articles/` into that folder and translate each guide. +1. Create a new directory in `_articles/` for your language e.g. `_articles/es/`, copy each guide from `_articles/` into that folder and translate the content in each guide, except for the field names in the front matter between the `---`s at the top of each file, e.g., `title:` should be unchanged. +1. Copy `index.html` to your target language index file e.g. `[_articles/es/index.html](https://github.com/github/opensource.guide/blob/master/_articles/es/index.html)` and update the `lang:` and add the `permalink:` field. 1. Run `script/test` and make sure there are no failures with your translation files. Note that you may need to rename anchor links or leave some headers in English to fix broken links. 1. Send a pull request.