>
> I think it would be good to have code and doc married :-)

I agree Carlos! I've always felt strongly that a project's documentation
should be under version control with the source code. This strong marriage
ensures that, oh say the wiki server vanishes, we will still know how to
compile the project's source code. The wiki should only be used to document
processes between multiple projects. Unfortunately, I've been in the
minority on this view for years.


On Tue, Mar 4, 2014 at 2:18 PM, Carlos Santana <csantan...@gmail.com> wrote:

> I also think they should go in cordova-docs repo
>
> And Also I would transfer the Wiki Page Instructions into Repo as README.md
> on the root with those scripts.
>
> I think it would be good to have code and doc married :-)
>
> Also long term maintenance is easier for folks to contribute to the
> instructions in github via pull request
> So if someone update the script and instructions need to be update they can
> do it all in one pull request
>
>
>
>
> On Tue, Mar 4, 2014 at 12:27 PM, Michael Brooks <mich...@michaelbrooks.ca
> >wrote:
>
> > I think the translation scripts can go under cordova-docs as well.
> Perhaps
> > `lib/translation/`. If you have an entry-point executable, then place it
> > under `bin/translation`. That keeps everything organized and following
> the
> > same pattern as the generator script.
> >
> > For the plugin documentation, ideally we'll follow the same pattern as
> > before: `cordova-plugin-name/doc/LANG/`. Perhaps we can make English the
> > root (no "en" directory) to make viewing easier for non-translated
> plugins
> > (e.g. third-party plugins). *shrugs*
> >
> >
> > On Tue, Mar 4, 2014 at 9:05 AM, Lisa Seacat DeLuca <ldel...@us.ibm.com
> > >wrote:
> >
> > > Thats an idea (re: put inside cordova-docs).  Reason I didn't suggest
> it
> > > was the plugin docs are in their own repos now.  But that doesn't mean
> > the
> > > scripts can't be in cordova-docs.  We could have a new directory for
> > > translation scripts, not to be confused with "translations are under
> this
> > > dir".  Sure, we can add to the agenda.  I'll be on in listen only
> mode. I
> > > have a conflict for the 2nd half of the hangout.  We should also talk
> > about
> > > how we're going to handle pointing to the plugin documentation on the
> > call
> > > as well.  Right now it redirects to the github repos which is going to
> be
> > > try with version switching and translations.
> > >
> > > Lisa Seacat DeLuca
> > > Mobile Engineer | t: +415.787.4589 | *ldel...@apache.org*<
> > ldel...@apache.org>| |
> > > *ldel...@us.ibm.com* <ldel...@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>
> > >
> > >
> > >
> > >
> > >
> > > From:        Brian LeRoux <b...@brian.io>
> > > To:        "dev@cordova.apache.org" <dev@cordova.apache.org>
> > > Date:        03/04/2014 11:31 AM
> > > Subject:        Re: translation scripts on github
> > > Sent by:        brian.ler...@gmail.com
> > > ------------------------------
> > >
> > >
> > >
> > > These could live in a branch on cordova-labs repo but it seems to me
> this
> > > would belong in cordova-docs, no?
> > >
> > > (Should we add this to this afternoon's agenda for the hangout?)
> > >
> > >
> > > On Tue, Mar 4, 2014 at 7:38 AM, Lisa Seacat DeLuca <ldel...@us.ibm.com
> > > >wrote:
> > >
> > > > I think it'd be a good idea to put the crowdin/cordova translation
> > > scripts
> > > > somewhere on github so they are there in case someone else needs to
> run
> > > > them besides me.  I uploaded them to one of my github repos here:
> > > > https://github.com/ldeluca/cordova-translation  Any suggestions for
> a
> > > > good place to put them inside of the cordova github repos?  Maybe
> coho?
> > > >
> > > > Instructions on how to run the translation scripts are also on our
> wiki
> > > > page here: http://wiki.apache.org/cordova/CordovaTranslations.
> > > >
> > > > Lisa Seacat DeLuca
> > > > Mobile Engineer | t: +415.787.4589 | *ldel...@apache.org*<
> > > ldel...@apache.org>| |
> > > > *ldel...@us.ibm.com* <ldel...@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>
> > > >
> > > >
> > >
> > >
> >
>
>
>
> --
> Carlos Santana
> <csantan...@gmail.com>
>

Reply via email to