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

Allow plugin developers to get their plugins translated by the piwik community #7883

Closed
sgiehl opened this Issue May 11, 2015 · 11 comments

Comments

Projects
None yet
3 participants
@sgiehl
Member

sgiehl commented May 11, 2015

We already have some more or less successful plugins listed on plugins.piwik.org
Most of them are only available with english translations or maybe some more languages.

As we have a community helping us to translate Piwik to many languages on transifex, we should give plugin developers the possibility to get their plugins translated.

There is not that much to do to make that possible:

  • Check that console command to update translations work for users not having full access to transifex project
  • Write a How-To / Update development guide

Proposed How-To:

  • Developer needs to get in touch with translations@piwik.org to let us know he would like to get translations
  • After a short check someone (likely me) will add the translation file hosted on github to our transifex project (and also the already available translations)
  • The developer should then be able to update the plugin translation files using the piwik console console translations:update -P plugin

Most Piwik & PiwikPRO plugins are already available for translation on Transifex.
NOTE: We must not add plugins on transifex that are not open source!

@piwik/core-team Thoughts or suggestions anyone?

@sgiehl sgiehl added the RFC label May 11, 2015

@sgiehl sgiehl self-assigned this May 11, 2015

@tsteur

This comment has been minimized.

Show comment
Hide comment
@tsteur

tsteur May 11, 2015

Member

👍

Member

tsteur commented May 11, 2015

👍

@sgiehl

This comment has been minimized.

Show comment
Hide comment
@sgiehl

sgiehl May 11, 2015

Member

Non-Maintainer users are not able to fully use the api methods for the project.
That means we can't simply add new resources for the plugins if the developers should be able to update on their own.
We could create a new project for each plugin and add the developer as a maintainer. If so we would need to adjust the console commands a bit, but that shouldn't be a problem.

I've justed tested that with my own plugin ReferrersManager.
See https://www.transifex.com/organization/piwik/dashboard/piwik-plugin-referrersmanager
I think it should be good enough that way.

The only other solution I see right now, would be not to allow the developer to update on his own, but to create pull requests for their plugins to update the translations...

Member

sgiehl commented May 11, 2015

Non-Maintainer users are not able to fully use the api methods for the project.
That means we can't simply add new resources for the plugins if the developers should be able to update on their own.
We could create a new project for each plugin and add the developer as a maintainer. If so we would need to adjust the console commands a bit, but that shouldn't be a problem.

I've justed tested that with my own plugin ReferrersManager.
See https://www.transifex.com/organization/piwik/dashboard/piwik-plugin-referrersmanager
I think it should be good enough that way.

The only other solution I see right now, would be not to allow the developer to update on his own, but to create pull requests for their plugins to update the translations...

@mattab

This comment has been minimized.

Show comment
Hide comment
@mattab

mattab May 13, 2015

Member

Overall it's a super idea to provide easy way for Third party plugin developers to get their plugins translated and reusing our transifex tool.

We could create a new project for each plugin and add the developer as a maintainer.

If we do this, how will the plugin developer import the translations in the plugin repo? would it be automatic or would developer need to manually import translations.

Member

mattab commented May 13, 2015

Overall it's a super idea to provide easy way for Third party plugin developers to get their plugins translated and reusing our transifex tool.

We could create a new project for each plugin and add the developer as a maintainer.

If we do this, how will the plugin developer import the translations in the plugin repo? would it be automatic or would developer need to manually import translations.

@mattab mattab added this to the 2.14.0 milestone May 13, 2015

@sgiehl

This comment has been minimized.

Show comment
Hide comment
@sgiehl

sgiehl May 13, 2015

Member

I'd do the initial set up, which contains an auto update path for english translations on git.
If there are already translations for other languages they need to be imported. But that's easy to do.

Nevertheless, I'm still searching for another solution. I've created a project for my plugin and none of the translators already started to translate it. I guess that's because they would need to switch to the project... Maybe I can find a solution where we could handle that with only on project

Member

sgiehl commented May 13, 2015

I'd do the initial set up, which contains an auto update path for english translations on git.
If there are already translations for other languages they need to be imported. But that's easy to do.

Nevertheless, I'm still searching for another solution. I've created a project for my plugin and none of the translators already started to translate it. I guess that's because they would need to switch to the project... Maybe I can find a solution where we could handle that with only on project

sgiehl added a commit that referenced this issue May 13, 2015

@sgiehl

This comment has been minimized.

Show comment
Hide comment
@sgiehl

sgiehl May 13, 2015

Member

Ok. I found a solution how to handle all in one project.
Moved my plugin translations to a resource in piwik project.
Problem was the api to fetch available languages for the project. That is not available for non-maintainers. But there is no need to call it when updating plugin translations.

So we will have a new resource for each third party plugin within our piwik transifex project.
I'll name those resources 'Third-Party Plugin pluginname'.

I'll propose an update for the developer documentation. @mattab or @tsteur maybe you can have a look there then. Afterwards we might publish a small blog post and announce that on twitter/facebook.

Anymore thoughts or comments?
Or anyone having a plugin available for testing that?

Member

sgiehl commented May 13, 2015

Ok. I found a solution how to handle all in one project.
Moved my plugin translations to a resource in piwik project.
Problem was the api to fetch available languages for the project. That is not available for non-maintainers. But there is no need to call it when updating plugin translations.

So we will have a new resource for each third party plugin within our piwik transifex project.
I'll name those resources 'Third-Party Plugin pluginname'.

I'll propose an update for the developer documentation. @mattab or @tsteur maybe you can have a look there then. Afterwards we might publish a small blog post and announce that on twitter/facebook.

Anymore thoughts or comments?
Or anyone having a plugin available for testing that?

@sgiehl

This comment has been minimized.

Show comment
Hide comment
@sgiehl

sgiehl May 19, 2015

Member

Note: Need to be announced on piwik blog, facebook and twitter and can be closed afterwards

Member

sgiehl commented May 19, 2015

Note: Need to be announced on piwik blog, facebook and twitter and can be closed afterwards

@sgiehl sgiehl removed the RFC label May 19, 2015

@mattab mattab modified the milestones: 2.14.1, 2.14.0 Jun 16, 2015

@mattab

This comment has been minimized.

Show comment
Hide comment
@mattab

mattab Jun 16, 2015

Member

@sgiehl Sounds good! Get in touch and we can post on the blog and social media.

Member

mattab commented Jun 16, 2015

@sgiehl Sounds good! Get in touch and we can post on the blog and social media.

@sgiehl

This comment has been minimized.

Show comment
Hide comment
@sgiehl

sgiehl Jun 17, 2015

Member

@mattab feel free to post it. Guess we can use some parts of the developer docs

Member

sgiehl commented Jun 17, 2015

@mattab feel free to post it. Guess we can use some parts of the developer docs

@mattab

This comment has been minimized.

Show comment
Hide comment
@mattab

mattab Jun 18, 2015

Member

Hi @sgiehl is the draft content ready, or do we need to write something?

Member

mattab commented Jun 18, 2015

Hi @sgiehl is the draft content ready, or do we need to write something?

@sgiehl

This comment has been minimized.

Show comment
Hide comment
@sgiehl

sgiehl Jun 18, 2015

Member

Haven't had time to write something the last days... So we need to write it

Member

sgiehl commented Jun 18, 2015

Haven't had time to write something the last days... So we need to write it

@mattab mattab modified the milestones: 2.15.0, 2.14.1 Jul 10, 2015

@mattab

This comment has been minimized.

Show comment
Hide comment
@mattab

mattab Sep 8, 2015

Member

We published the blog post: How to get your Piwik plugin translated in many languages?

Therefore this issue is closed: translators of open source plugins can now easily get their plugins translated by the Piwik translator community. Really a great move @sgiehl 👍

Member

mattab commented Sep 8, 2015

We published the blog post: How to get your Piwik plugin translated in many languages?

Therefore this issue is closed: translators of open source plugins can now easily get their plugins translated by the Piwik translator community. Really a great move @sgiehl 👍

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment