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

Already on GitHub? Sign in to your account

Multilingual site #376

Closed
Chris00 opened this Issue Dec 26, 2013 · 14 comments

Comments

Projects
None yet
5 participants
Member

Chris00 commented Dec 26, 2013

Since we have several demands for translations, I think it is urgent to take a decision on the following points:

  • What is the license for the content of the site?
  • Do we want a multilingual site or do we prefer translations to be hosted on external sites? (I personally think a multilingual site is better to ensure the information is not lost in the long term, though harder to maintain.)
  • Do we make the translated sites sites live parallel lives or do we add the available languages, say, at the end of the breadcrumb navigation? That can be done automatically thanks to the convention file.〈lang〉.html.
Contributor

dbuenzli commented Dec 26, 2013

Regarding point 1) you should also be aware that the site seem to hold content that was sucked from a variety of sources (e.g. I saw by chance some prose that I did write initially on cocan.org myself which AFAIK had no contribution license policy, this) so this should also maybe be solved at the same time.

Member

Chris00 commented Dec 26, 2013

A proof of concept of adding language links is in the branch multilingual.

Owner

avsm commented Dec 26, 2013

On 26 Dec 2013, at 05:18, Christophe Troestler notifications@github.com wrote:

Since we have several demands for translations, I think it is urgent to take a decision on the following points:

What is the license for the content of the site?
The easiest license may be CC0 (like OPAM-repository) to ensure that material from the site can be re-used in other teaching material.
Do we want a multilingual site or do we prefer translations to be hosted on external sites? (I personally think a multilingual site is better to ensure the information is not lost in the long term, though harder to maintain.)
I agree with you that hosting it on this site would be better in the long term.
Do we make the translated sites sites live parallel lives or do we add the available languages, say, at the end of the breadcrumb navigation? That can be done automatically thanks to the convention file.〈lang〉.html.

I prefer parallel lives, but it's hard to see how that could work with sparsely populated translations. How about listing the translations, and if one doesn't exist for a particular page, have a "Translate This Page" button that takes them to a page similar to the "Edit" link that currently exists?

-anil

Member

agarwal commented Dec 27, 2013

@dbuenzli With permission of Richard Jones, we took content from his former cocan.org and ocaml-tutorial.org websites.

Re: multilingual content. After initially liking the idea, then feeling it is not viable due to lack of resources, I'm now back to thinking we should support it. It really makes no sense for translated content to be on other sites. That's a fork and will lead to fragmentation. The most important thing to do is put a license up, and let people start working on the translations. We are already holding up multiple volunteers because we haven't done this. I'll do some reading up on this asap.

Member

Chris00 commented Dec 27, 2013

CC0 may be fine. However, I feel that people pouring hours of work into producing documentation/tutorials will not like their work to be "stolen" by an individual seeking profit without giving back. Maybe CC BY-SA 4.0 is better?

Owner

avsm commented Dec 27, 2013

Yes, attribution seems reasonable in this case. CC BY-SA 4.0 looks good to me.

-anil

On 27 Dec 2013, at 22:20, Christophe Troestler notifications@github.com wrote:

CC0 may be fine. However, I feel that people pouring hours of work into producing documentation/tutorials will not like their work to be "stolen" by an individual seeking profit without giving back. Maybe CC BY-SA 4.0 is better?


Reply to this email directly or view it on GitHub.

Member

Chris00 commented Dec 29, 2013

For the moment, I have enabled translations buttons at the right of the breadcrumb navigation (the presentation may change to a drop-down menu when there are too many translations). Breadcrumb navigation is also translation aware. The navbar is not however.

To keep translations up to date, I propose that a script checks the repository and, when a page x.html is modified, it looks for x.lang.html and sends an email to all commiters in the past 6 months (or the last one if the page was not modified for 6 months). It should also be possible to use this script (in ocaml.org) to check (from the command line) whether some translations are not up to date.

Contributor

ygrek commented Dec 30, 2013

Maybe setup a transifex project? It could help involve more people in translating..

Member

Chris00 commented Feb 1, 2014

There are other possibilities.

That being said, Transifex seems indeed popular so we may want to try it if it integrates well in our workflow.

Member

Chris00 commented Feb 1, 2014

Transifex API. Given that Transifex does not support markdown, we may need to convert it back and forth to another supported format.

Member

Chris00 commented Feb 8, 2014

All translations of the tutorials that I had access to have been imported.

Member

agarwal commented Feb 10, 2014

@Chris00 Thank you!! That was a huge task.

@Chris00 Chris00 self-assigned this Apr 3, 2014

Member

Chris00 commented Apr 3, 2014

Closing—I think there is nothing left to do on this issue (except maybe setting up a Transifex project but that does not seem that easy as they do not support markdown ATM).

@Chris00 Chris00 closed this Apr 3, 2014

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