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

translator credits #23

Open
genekogan opened this issue Dec 6, 2017 · 7 comments
Open

translator credits #23

genekogan opened this issue Dec 6, 2017 · 7 comments

Comments

@genekogan
Copy link
Member

@TiborUdvari @weakish @irealva @tornoteli @rickiepark

hi ml4a translators! right now, your names do not appear anywhere except github contributors. in general, none of the pages, including the book, guides, or demos have names right now. i'm trying to figure out a good way to list contributors. do you have any comments about how you might like to be credited? one option would be to put it at the top of the actual chapters (example: "translated by __" or "translated by __ and __") or we can possibly make a new page which lists the translations and the authors next to them. do you have any preferences?

@rickiepark
Copy link
Contributor

Great idea! I think your option is good enough. :)

@irealva
Copy link
Contributor

irealva commented Dec 6, 2017

Your option sounds good too. The benefit of that is that if anyone wants to propose a change to the translation they'd know who to contact directly. So maybe it's a link to our github account? I am planning to make a work email public on github.

@TiborUdvari
Copy link
Contributor

@rickiepark, @irealva I'm not sure I understand whether you are referring to
a. having them on each individual translated page
b. having a general page listing contributions

I think a. would be more feasible because it is simpler to maintain in the short term.

I think the ideal solution would be having contributor names in the frontmatter (maybe with a link to a website?) and using that to add the name automatically to the layout and generating a page with it. From my knowledge, this would not be trivial with jekyll, but I didn't look into it yet.

I would personally appreciate having a link to especially everybody making the guides, book, demos etc. to bounce over and check out their other work easily.

@genekogan
Copy link
Member Author

@TiborUdvari i think good idea on making it into the data files if we repeat the names in multiple places. it probably makes more sense to put it into the _data rather than frontmatter which is more about the page configuration i think. i am thinking for now it makes sense to have each chapter have a note at the top about who translated, and a link to wherever translator wants (github or personal website perhaps). how about that?

@tornoteli
Copy link
Contributor

Hi!
I like both ways. And for me a list of all translators name/link in preface/data file is good enough. A note at the top would be great if it's not disturbing, cause letting people focus on the content is the first concern. : )

@genekogan
Copy link
Member Author

@TiborUdvari @weakish @irealva @tornoteli @rickiepark
hi all -- ok i've made a basic thing that gives credit which involves simply putting your name and a hyperlink (to whatever you like) that goes in the header. i've made examples for the chinese and spanish versions of neural networks.

https://ml4a.github.io/ml4a/cn/neural_networks/
https://ml4a.github.io/ml4a/es/neural_networks/

it just comes from the metadata translator and translator_link at the top -- see https://raw.githubusercontent.com/ml4a/ml4a.github.io/master/_chapters_es/neural_networks.md for example.

Tong and Irene, feel free to change the way i made it for yours (however you want it to be listed).

does this work for everyone? if so, please go into your chapters and add that info. in a bit, i will also add links to the translations from the main chapter list, and cross-links inside each chapter.

@rickiepark
Copy link
Contributor

Great, thanks @genekogan :)

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

No branches or pull requests

5 participants