Skip to content

Commit

Permalink
docs/translations: note testing step.
Browse files Browse the repository at this point in the history
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.
  • Loading branch information
MikeMcQuaid committed Feb 21, 2018
1 parent 4ef2c6b commit 9639e7b
Show file tree
Hide file tree
Showing 2 changed files with 8 additions and 1 deletion.
1 change: 1 addition & 0 deletions docs/translations.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,4 +13,5 @@ If there's not, then today is your day to lead this effort! Here's how to start:
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. 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.
8 changes: 7 additions & 1 deletion script/test
Original file line number Diff line number Diff line change
@@ -1,8 +1,14 @@
#!/bin/sh
#!/bin/bash

set -e

script/build --config _config.yml,test/_config.yml
bundle exec rake

set +e

script/html-proofer
HTML_PROOFER_EXIT="$?"
test/prose
PROSE_EXIT="$?"
[[ "$HTML_PROOFER_EXIT" == 0 && "$PROSE_EXIT" == 0 ]]

0 comments on commit 9639e7b

Please sign in to comment.