Skip to content

Commit 61ec1b9

Browse files
committed
docs: Add guide to remove untranslated field after translation
1 parent e815cc1 commit 61ec1b9

File tree

1 file changed

+1
-0
lines changed

1 file changed

+1
-0
lines changed

docs/translations.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,7 @@ If there's not, then today is your day to lead this effort! Here's how to start:
1313
1. Create a new branch for your translation work e.g. `es`.
1414
1. Copy `_data/locales/en.yml` to your target language file e.g. `_data/locales/es.yml` and translate all the strings.
1515
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 remain unchanged.
16+
1. Remove the untranslated field.
1617
1. Copy `index.html` to your target language index file e.g. `[_articles/es/index.html](https://github.com/github/opensource.guide/blob/HEAD/_articles/es/index.html)` and update the `lang:` and add the `permalink:` fields. Example: `lang: es` and `permalink: /es/`. All other fields' values must remain unchanged.
1718
1. Run `script/test` and make sure there are no failures with your translation files. Note that you may need to fix broken links.
1819
1. Send a pull request. (You may send a pull request before all steps above are complete: e.g., you may want to ask for help with translations, or getting tests to pass. However, your pull request will not be merged until all steps above are complete.)

0 commit comments

Comments
 (0)