Mailing-List: contact dev-help@cordova.apache.org; run by ezmlm
Precedence: bulk
Reply-To: dev@cordova.apache.org
Received-SPF: pass (nike.apache.org: domain of ldeluca@us.ibm.com designates
 32.97.110.150 as permitted sender)
To: dev@cordova.apache.org
MIME-Version: 1.0
Subject: [Input request] Rethinking Plugin docs
From: Lisa Seacat DeLuca <ldeluca@us.ibm.com>
Message-ID: 
 <OFA6F0E859.DFCD843A-ON87257C89.00588959-85257C89.00592E6B@us.ibm.com>
Date: Mon, 24 Feb 2014 11:13:56 -0500
Content-Type: multipart/related; boundary="=_related 00592E3B85257C89_="

--=_related 00592E3B85257C89_=
Content-Type: multipart/alternative;
 boundary="=_alternative 00592E3B85257C89_="


--=_alternative 00592E3B85257C89_=
Content-Type: text/plain; charset="US-ASCII"

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@us.ibm.com | lisaseacat.com | | 


--=_alternative 00592E3B85257C89_=
Content-Type: text/html; charset="US-ASCII"

<font size=2 face="sans-serif">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</font>
<br>
<br><a href=http://cordova.apache.org/docs/en/3.4.0/cordova_plugins_pluginapis.md.html#Plugin%20APIs><font size=2 color=blue face="sans-serif">http://cordova.apache.org/docs/en/3.4.0/cordova_plugins_pluginapis.md.html#Plugin%20APIs</font></a>
<br>
<br><font size=2 face="sans-serif">If we want to have translations for
each of the plugins then we're going to need to rethink this a little.
&nbsp;Here are two options:</font>
<br>
<br><font size=2 face="sans-serif">1. similar to the cordova-docs dir,
we could have a language directory as the parent.<br>
ex. doc/en/index.md<br>
and while we're at it we probably need the version as well<br>
ex. doc/en/3.4.0/index.md</font>
<br>
<br><font size=2 face="sans-serif">If we do this then at least we can have
the documentation for each language. &nbsp;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. &nbsp;</font>
<br>
<br><font size=2 face="sans-serif">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? &nbsp;If it were seamless and part of the other documentation it
would make my life *coughTranslationcough* so much easier. &nbsp;Plus it
won't be as confusing on end users having to choose their language more
than one time.</font>
<br>
<br><font size=2 face="sans-serif">It'd be nice to get some input from
everyone before I start writing a complicated automated script for the
plugin translations.</font>
<br>
<br>
<br><font size=2 face="sans-serif">Lisa<br>
</font>
<br><font size=3>Lisa Seacat DeLuca<br>
Mobile Engineer | t: +415.787.4589 | </font><a href=mailto:ldeluca@apache.org><font size=3 color=blue><u>ldeluca@apache.org</u></font></a><font size=3>
| | </font><a href=mailto:ldeluca@us.ibm.com><font size=3 color=blue><u>ldeluca@us.ibm.com</u></font></a><font size=3>
| </font><a href=http://www.lisaseacat.com/><font size=3 color=blue><u>lisaseacat.com</u></font></a><font size=3>
| </font><a href=www.twitter.com/LisaSeacat><img src=cid:_4_0BD2E0740C48F48400592E3B85257C89 width=19 height=19 alt="follow @LisaSeacat on twitter" style="border:0px solid;"></a><font size=3>|
</font><a href=http://www.linkedin.com/in/lisaseacat><img src=cid:_4_0BD2E4E40C48F48400592E3B85257C89 width=19 height=20 alt="follow Lisa Seacat DeLuca on linkedin" style="border:0px solid;"></a><font size=2 face="sans-serif"><br>
</font>
<br>
--=_alternative 00592E3B85257C89_=--

--=_related 00592E3B85257C89_=--