cordova-dev mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From Lisa Seacat DeLuca <ldel...@us.ibm.com>
Subject Re: [Input request] Rethinking Plugin docs
Date Fri, 28 Feb 2014 19:54:28 GMT
Translation Update:

1. I have updated the automated scripts for crowdin to pull in the 
documentation for cordova-docs and the 17 plugin repository .md files. 
There are currently 72 files available for translation in our tooling. It 
is available as always, here: https://crowdin.net/project/cordova.  For 
information on the nitty-gritty checkout the wiki page: 
https://wiki.apache.org/cordova/CordovaTranslations
2. We kinda discussed the way the documentation is currently referencing 
the english version of the documentation within github.  We'll need to 
come up with a better way of building the plugin documentation into the 
current html pages. I opened a JIRA issue:
https://issues.apache.org/jira/browse/CB-6137
3. Another issue that was brought to my attention by Carlos (thanks 
Carlos) is there is currently no clear way for users to know that 
translations exist.  So I have opened a JIRA issue: 
https://issues.apache.org/jira/browse/CB-6136.  It would be nice if to the 
left of the drop down there was a message such as "Switch languages or 
documentation version here:"

Please share with your social network a tweet to get people to help with 
translations.

ex.

The @apachecordova documentation is now broken out for each plugin.  We 
need YOUR help translating! @crowdin https://crowdin.net/project/cordova 

Thanks,


Lisa

Lisa Seacat DeLuca
Mobile Engineer | t: +415.787.4589 | ldeluca@apache.org | | 
ldeluca@us.ibm.com | lisaseacat.com | | 





From:   Shazron <shazron@gmail.com>
To:     "dev@cordova.apache.org" <dev@cordova.apache.org>
Date:   02/24/2014 12:47 PM
Subject:        Re: [Input request] Rethinking Plugin docs



I agree with Andrew's points in #1. We have to update the 3.4.0 docs
nonetheless, since the URLs do not point to a specific tagged version.


On Mon, Feb 24, 2014 at 9:32 AM, Andrew Grieve <agrieve@chromium.org> 
wrote:

> My thoughts here:
>
> 1.
> - We may also want to include README.md files in the translations.
> - I like not having a subdir for en/ so as to differentiate it as the 
one
> the others are based off of
> - We don't need the version in the directory since we can use git tags 
to
> find old versions
>
> maybe:
> doc/index.md
> doc/fr/index.md
> doc/fr/README.md
> doc/es/index.md
> doc/es/README.md
>
> 2.
> The plan is to render these on plugins.cordova.io, so we can certainly 
add
> logic there to maintain language pref.
>
>
>
>
> On Mon, Feb 24, 2014 at 11:13 AM, Lisa Seacat DeLuca <ldeluca@us.ibm.com
> >wrote:
>
> > I noticed for the 3.4 release that the documentation for each of the
> > plugins redirects to the github repository for each plugin and a 
document
> > under doc/index.md
> >
> >
> >
> 
http://cordova.apache.org/docs/en/3.4.0/cordova_plugins_pluginapis.md.html#Plugin%20APIs

> >
> > If we want to have translations for each of the plugins then we're 
going
> > to need to rethink this a little.  Here are two options:
> >
> > 1. similar to the cordova-docs dir, we could have a language directory 
as
> > the parent.
> > ex. doc/en/index.md
> > and while we're at it we probably need the version as well
> > ex. doc/en/3.4.0/index.md
> >
> > If we do this then at least we can have the documentation for each
> > language.  But that doesn't solve the problem of the user being always
> > redirected to the english version of the documentation and not their
> > specific language.
> >
> > 2. Is it hard to do a build of the index.md for each plugin similar to
> > how we build the cordova-doc md files into html files?  If it were
> seamless
> > and part of the other documentation it would make my life
> > *coughTranslationcough* so much easier.  Plus it won't be as confusing 
on
> > end users having to choose their language more than one time.
> >
> > It'd be nice to get some input from everyone before I start writing a
> > complicated automated script for the plugin translations.
> >
> >
> > Lisa
> >
> > Lisa Seacat DeLuca
> > Mobile Engineer | t: +415.787.4589 | *ldeluca@apache.org*<
> ldeluca@apache.org>| |
> > *ldeluca@us.ibm.com* <ldeluca@us.ibm.com> | *lisaseacat.com*<
> http://www.lisaseacat.com/>| [image:
> > follow @LisaSeacat on twitter] <http://www.twitter.com/LisaSeacat>|
> [image:
> > follow Lisa Seacat DeLuca on linkedin]<
> http://www.linkedin.com/in/lisaseacat>
> >
> >
>


Mime
  • Unnamed multipart/related (inline, None, 0 bytes)
View raw message