Ideally, we don’t want that to be the case. Using the README.md file for documentation is really inaccessible from both a translation and usability perspective. The README.md should explain how to do basic things for a repo, and should provide a link to the documentation site. I think the ideal goal is to have the docs site generate JSDoc pages for plugins and display them in style with translations and all; once that is possible, I think we should remove docs from README.md and encourage people to read docs on the site.
Kindly, Dmitry > On Apr 22, 2016, at 6:24 PM, Jesse <purplecabb...@gmail.com> wrote: > > But people also read it at github.com and npmjs.org, at least the English > versions > >> On Apr 22, 2016, at 5:56 PM, Dmitry Blotsky <dblot...@microsoft.com> wrote: >> >> I think the plan is to have the docs, as well as their translations, live on >> docs.cordova.io. The docs source is in each plugin's source code, but the >> formatted and translated output that people should be reading is on the docs >> website. >> >> Kindly, >> Dmitry >> >> -----Original Message----- >> From: Jesse [mailto:purplecabb...@gmail.com] >> Sent: Friday, April 22, 2016 5:45 PM >> To: dev@cordova.apache.org >> Subject: Re: Plugin documentation translations >> >> Thanks Dmitry and Julio, >> So assuming we want devs who go to the github repo to be able to read the >> 'edge' documentation, we just need the README.md there? >> The index.md(s) I looked at all seemed to be from an ancient commit, so >> maybe for now we just get rid of those. >> >> >> @purplecabbage >> risingj.com >> >> On Fri, Apr 22, 2016 at 5:24 PM, Dmitry Blotsky <dblot...@microsoft.com> >> wrote: >> >>> From what I understand, the process was to upload the files to >>> Crowdin, and then download the translations generated by Crowdin and >>> commit them back to the repo. >>> >>> Now the plugin READMEs are pulled in to the website build, and get >>> translated along with it. So, those individual language-specific files >>> in plugin repos shouldn't be necessary anymore. We'll probably revisit >>> this process and clean up once we get to automating the Crowdin steps. >>> >>> Kindly, >>> Dmitry >>> >>> -----Original Message----- >>> From: julio cesar sanchez [mailto:jcesarmob...@gmail.com] >>> Sent: Friday, April 22, 2016 4:12 PM >>> To: dev@cordova.apache.org >>> Subject: Re: Plugin documentation translations >>> >>> As far as I know, the translations are created in crowdin ( >>> >>> https://na01.safelinks.protection.outlook.com/?url=https%3a%2f%2fcrowd >>> in.com%2fproject%2fcordova&data=01%7c01%7cdblotsky%40microsoft.com%7cf >>> 57f3f3186c74e697faa08d36b0387f1%7c72f988bf86f141af91ab2d7cd011db47%7c1 >>> &sdata=vD2jpn%2f5F2ccF%2fL1u963dAd22HJoRz75KSnYe7NhhSU%3d >>> ) >>> It creates the index.md, I have no idea about the README.md. >>> >>> According to the mails on the list, Victor Sosa was the one taking >>> care of it but he didn't have enough time and Andrey Kurdumov took >>> over, so maybe he can shed some light. >>> >>> >>> >>> >>> 2016-04-23 0:30 GMT+02:00 Jesse <purplecabb...@gmail.com>: >>> >>>> First off, I apologize for not being up to date in how we handle >>>> translation of plugin docs. >>>> Second, I want to thank whoever has been. >>>> >>>> So, looking thru the docs folder of the device-orientation plugin, I >>>> see some very similar files ... each language folder appears to >>>> contain an index.md and a README.md which are 'almost' identical. >>>> The important part here is the 'almost'. >>>> All of which finally brings me to my questions. >>>> >>>> How are these files created and updated? Why are they different? >>>> Where are they shown? >>>> >>>> Thanks in advance! >>>> Cheers, >>>> Jesse >>>> >>>> >>>> @purplecabbage >>>> risingj.com >> >> --------------------------------------------------------------------- >> To unsubscribe, e-mail: dev-unsubscr...@cordova.apache.org >> For additional commands, e-mail: dev-h...@cordova.apache.org > > --------------------------------------------------------------------- > To unsubscribe, e-mail: dev-unsubscr...@cordova.apache.org > For additional commands, e-mail: dev-h...@cordova.apache.org > --------------------------------------------------------------------- To unsubscribe, e-mail: dev-unsubscr...@cordova.apache.org For additional commands, e-mail: dev-h...@cordova.apache.org
