Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add instructions for changing translated strings #6528

Merged
merged 5 commits into from
May 16, 2018
Merged

Add instructions for changing translated strings #6528

merged 5 commits into from
May 16, 2018

Conversation

aidalgol
Copy link
Contributor

Add instructions to the developer documentation for proper housekeeping of the
translations when editing strings.

Signed-off-by: Aidan Gauland aidalgol+ghpr@fastmail.net

Add instructions to the developer documentation for proper housekeeping of the
translations when editing strings.
@dbkr
Copy link
Member

dbkr commented Apr 20, 2018

We have npm run 1i8n and npm run prune-i18n to do this for us now, so the correct advice would be to use these scripts.

As per code review feedback, we should use the npm run scripts i18n and
i18n-prune instead of editing the i18n JSON files directly.
Replace an inline, parenthetical note about possible failures of the `npm run`
scripts with additional items in the Requirements section.
Copy link
Contributor Author

@aidalgol aidalgol left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The reason for this change is that now two sections in the document reference the npm i18n script.

@dbkr
Copy link
Member

dbkr commented Apr 25, 2018

Ah, it doesn't have a hyphen so actually it's npm run prunei18n (but not i18n-prune).

Also, do you think it makes more sense to add the bit about editing after 'adding new strings'? Most of the time people will be adding strings I suspect, rather than editing existing ones.

The `npm run` command `i18n-prune` is actually `prunei18n`.
Move "Editing existing strings" to after "Adding new strings".
@aidalgol
Copy link
Contributor Author

Also, do you think it makes more sense to add the bit about editing after 'adding new strings'? Most of the time people will be adding strings I suspect, rather than editing existing ones.

I don't have a strong preference on the ordering. I have so far found myself editing more strings than adding new strings,

@dbkr dbkr merged commit 6bfc90b into element-hq:develop May 16, 2018
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants