Skip to content

Commit 9639e7b

Browse files
committed
docs/translations: note testing step.
This has been missed by a few people so make sure they get it here rather than being surprised by broken CI. Also, ensure that both HTML Proofer and Prose checks are run every time even if HTML Proofer fails to produce better CI output.
1 parent 4ef2c6b commit 9639e7b

File tree

2 files changed

+8
-1
lines changed

2 files changed

+8
-1
lines changed

docs/translations.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -13,4 +13,5 @@ If there's not, then today is your day to lead this effort! Here's how to start:
1313
1. Copy `_data/locales/en.yml` to your target language file e.g. `_data/locales/es.yml` and translate all the strings.
1414
1. Copy `index.html` to your target language index file e.g. `es.html` and update the `lang:`.
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 each guide.
16+
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.
1617
1. Send a pull request.

script/test

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,14 @@
1-
#!/bin/sh
1+
#!/bin/bash
22

33
set -e
44

55
script/build --config _config.yml,test/_config.yml
66
bundle exec rake
7+
8+
set +e
9+
710
script/html-proofer
11+
HTML_PROOFER_EXIT="$?"
812
test/prose
13+
PROSE_EXIT="$?"
14+
[[ "$HTML_PROOFER_EXIT" == 0 && "$PROSE_EXIT" == 0 ]]

0 commit comments

Comments
 (0)