These are chat archives for ethereum/homestead-guide

11th
Mar 2016
iinstances
@iinstances
Mar 11 2016 02:37
Hi, I was wondering where could one contribute with translations :-) spanish in my case.
Hey @iinstances
Thanks for the offer. I have no idea how Sphinx (the documentation tool we are using) works with translations. Maybe somebody else knows, or maybe you can investigate yourself and report back here on how it seems to work? http://www.sphinx-doc.org
If you could investigate that, get the homestead-guide files on your machine and screw around with them a bit to try to get some translation going, that would be very useful information to have. When we know more about how that works we can formulate a plan of attack. Best wishes!
iinstances
@iinstances
Mar 11 2016 15:36
Hi @bobsummerwill, that's fine for me. I will investigate about the best option to translate Homestead docs. Thanks for let me contribute :-)
Bob Summerwill
@bobsummerwill
Mar 11 2016 15:49
Thanks for the offer, @iinstances. I hope it's not too hard to use!
iinstances
@iinstances
Mar 11 2016 15:51
I think that best way to do it is documented at "http://docs.readthedocs.org/en/latest/localization.html", I'm reading it right now.
Bob Summerwill
@bobsummerwill
Mar 11 2016 15:51
The other thing for you to know is that it is our intention to maintain this documentation incrementally from this point, so while we are putting it together because of Homestead, it isn't ONLY for Homestead. It is the Ethereum documentation. So when it comes to things like translations, we are obviously going to need and want those, and we don't have to do it all in a hurry. We can do it right.
iinstances
@iinstances
Mar 11 2016 15:52
I understand, that's the usual way to work I think.
In that URL we can see two options, "Single project in another language" and "Project with multiple translations". I think the second seems the best. I'll investigate it.
The second situation is a bit more complicated.
The main project is the parent for all translations.
In the parent projects Translations page, you will say that some other project is a translation for your project.
iinstances
@iinstances
Mar 11 2016 15:58
As an example, having phpmyadmin as parent project and phpmyadmin-spanish as the translation project has the results of serving:
Bob Summerwill
@bobsummerwill
Mar 11 2016 15:58
Excellent! So we'll want to make it easy (or at least a defined process!) to add further languages as people like yourself turn up with the ability and willingness to contribute. Hopefully they do something rational with directory structure, so the files don't get too messy and mixed up.
iinstances
@iinstances
Mar 11 2016 15:58
Bob Summerwill
@bobsummerwill
Mar 11 2016 16:00
So with that phpmyadmin example, do they end up being entirely parallel projects?
So in our case we would make a whole new repo http://github.com/ethereum/homestead-guide-spanish? Start as a clone, and just work entirely manually to keep the structure and content roughly the same?
N times for N languages?
iinstances
@iinstances
Mar 11 2016 16:01
Completly agree @bobsummerwill.
Now is time to go for me.
hughlang
@hughlang
Mar 11 2016 16:01
Thanks @iinstances
iinstances
@iinstances
Mar 11 2016 16:02
Very interesting talking with you, I'll be back ;.)
Bob Summerwill
@bobsummerwill
Mar 11 2016 16:02
Right - which has the benefit of not intermixing the content, but means that if the "primary" content is moving a lot (like now) then it's a lot of work for the translations to keep pace.
Is that a normal kind of work flow for technical documentation?
Catch you again, @iinstances. Thanks again!
iinstances
@iinstances
Mar 11 2016 16:03
I think so.
:-)
Bob Summerwill
@bobsummerwill
Mar 11 2016 16:08
The alternative would be for the translations to be "English by default", with overlays which replace English sections if there is a translation available. I don't know if that is a better experience, though. Probably not, because people who speak English too can always just check the English version if they want the latest-and-greatest information.
When I was at EA, the approach we had which is the only true way to deliver multi-lingual content was for every single text string EVERYWHERE to have an ID, and for all languages including English to go through that database layer. That means you have an up-front-cost for every single piece of text which is ever created. That gives you perfect results, but has huge overhead for everyone. Only really works in-application too. Not really something which works for web content so well either, I guess.
So clones it is!
Bob Summerwill
@bobsummerwill
Mar 11 2016 16:14
Probably :-)
Hudson Jameson
@Souptacular
Mar 11 2016 21:53
I took off the advertising on RTD
Also, Bob I added flair to your name on Reddit so you can be recognized as official Ethereum.
Bob Summerwill
@bobsummerwill
Mar 11 2016 21:58
Ooh - shiny. Thanks for the bling, @Souptacular!
Did we just need to move to a paid tier or something to drop the ads?
Hudson Jameson
@Souptacular
Mar 11 2016 21:59
No there is a setting in the admin console
you can opt out without paying
@bobsummerwill and @zelig , want admin access to the RTD account? As long you as you have a readthedocs.org address I can add you.
Bob Summerwill
@bobsummerwill
Mar 11 2016 21:59
Sure - thanks!
Hudson Jameson
@Souptacular
Mar 11 2016 22:00
lmk your username and I'll add ya
Bob Summerwill
@bobsummerwill
Mar 11 2016 22:00
bobsummerwill
Do I need one which is more fun? Maybe flip to Bobtacular? :-)
From http://readthedocs.org/projects/ethereum-homestead/builds/, clicking on View Docs always dies with a %20 on the front of the string. Maybe I will be able to fix that?
Hudson Jameson
@Souptacular
Mar 11 2016 22:54
It says you do not exist as a user
Did you register on readthedocs.org of .com?
hughlang
@hughlang
Mar 11 2016 23:11
Bobtacular!
John Gerryts
@phonikg
Mar 11 2016 23:14
Bobtacular +1
Bob Summerwill
@bobsummerwill
Mar 11 2016 23:21
I just registered. For some reason I though it would just use my Github account. It doesn't, but I have an account now, and it is tied to my Github and my Bitbucket.