Skip to content

Commit 4fc4a51

Browse files
authored
Updated point 4 and 5
toc fields are not present in index.html but rather in the articles, improved wording
1 parent a92f747 commit 4fc4a51

File tree

1 file changed

+2
-2
lines changed

1 file changed

+2
-2
lines changed

docs/translations.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -11,8 +11,8 @@ If there's not, then today is your day to lead this effort! Here's how to start:
1111
1. [Fork this repository](https://github.com/github/opensource.guide/fork)
1212
1. Create a new branch for your translation work e.g. `es`.
1313
1. Copy `_data/locales/en.yml` to your target language file e.g. `_data/locales/es.yml` and translate all the strings.
14-
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.
15-
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. Remove the `toc:` fields (they are only used for English).
14+
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. Remove the `toc:` fields (they are only used for English).
15+
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:` fields. Example: `lang: es` and `permalink: /es/`. All other fields' values must remain unchanged.
1616
1. Run `script/test` and make sure there are no failures with your translation files. Note that you may need to fix broken links.
1717
1. Send a pull request.
1818

0 commit comments

Comments
 (0)