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

Translation API guide #6646

Closed
mlewand opened this issue Apr 22, 2020 · 1 comment
Closed

Translation API guide #6646

mlewand opened this issue Apr 22, 2020 · 1 comment
Assignees
Labels
type:docs This issue reports a task related to documentation (e.g. an idea for a guide).

Comments

@mlewand
Copy link
Contributor

mlewand commented Apr 22, 2020

📝 Provide a description of requested docs changes

In ckeditor/ckeditor5-utils#334 we introduced plural versions for translations.

The PR made attempt to attempt to explain the concept in API docs, but this won't cut it.

What we need here is a complete guide on how to add/work with translations, including a section how plural forms are handled.

Some points that I'd like to see covered:

It should contain cross link to translation contribution section.

@mlewand mlewand added the type:docs This issue reports a task related to documentation (e.g. an idea for a guide). label Apr 22, 2020
@mlewand mlewand added this to the iteration 31 milestone Apr 22, 2020
@mlewand
Copy link
Contributor Author

mlewand commented Apr 22, 2020

Couple more notes:

https://github.com/ckeditor/ckeditor5-utils/blob/14d29a66792419fb4d59eb8869d3b438d2b15aec/src/translation-service.js#L34-L50 - this fragment should be covered by the "Plural forms" section and replaced with a link to the guide. The first code listing is incomplete (doesn't have the getPluralForm arg).

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
type:docs This issue reports a task related to documentation (e.g. an idea for a guide).
Projects
None yet
Development

No branches or pull requests

3 participants