cordova-dev mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From Carlos Santana <csantan...@gmail.com>
Subject Re: Deleting Plugin Docs
Date Fri, 20 Dec 2013 16:52:20 GMT
All docs for Cordova CLI, Plugman CLI, and Platforms hosted/rendered on
docs.cordova.io
and
All docs for Plugins hosted/rendered on plugins.cordova.io

If this is true, I would like to see consistencies on look and feel of both
websites, and ability to link back and forth between sites via links.




On Fri, Dec 20, 2013 at 11:42 AM, Andrew Grieve <agrieve@chromium.org>wrote:

> The eventual goal (in my eyes) is to have plugin docs:
> 1. Appear with the plugins on plugins.cordova.io.
> 2. Be accessible to devs after they have installed the plugin (e.g. by
> looking at plugins/foo/doc, or maybe by having "cordova serve" show them)
>
>
>
>
> On Fri, Dec 20, 2013 at 11:38 AM, Carlos Santana <csantana23@gmail.com
> >wrote:
>
> > I'm a bit lost
> >
> > Is the eventual goal to build the docs as a single website (
> > docs.cordova.io)
> > with multiple repos cordova-docs repo and plugin repos?
> >
> >
> >
> > On Fri, Dec 20, 2013 at 11:00 AM, Wargo, John <john.wargo@sap.com>
> wrote:
> >
> > > Andrew,
> > >
> > > Will you be processing the plugin docs so they generate the pages like
> > > they used to?  Being able to click and link around within a particular
> > > plugin's doc is super helpful.
> > >
> > > John M. Wargo
> > > Twitter: @johnwargo
> > >
> > >
> > > -----Original Message-----
> > > From: agrieve@google.com [mailto:agrieve@google.com] On Behalf Of
> Andrew
> > > Grieve
> > > Sent: Wednesday, December 18, 2013 10:40 PM
> > > To: dev
> > > Subject: Fwd: Deleting Plugin Docs
> > >
> > > This is now done! Woo! No more having plugins code separate from their
> > docs
> > > (I hear we might even get tests to live within plugin repos in the next
> > > while too!).
> > >
> > > I tried to be diligent, but it's possible I made mistakes along the
> way.
> > > You can see the result on the edge version of the docs:
> > > http://cordova.apache.org/docs/en/edge/
> > >
> > > There's a new "Plugins API" page, and all of the plugin docs are moved
> > into
> > > the respective repos within a doc/index.md file.
> > >
> > > Some of doc/index.md files are fairly large, and to help with that I
> > > attempted to remove some of the repetition that I found: Quick Examples
> > vs.
> > > Full Examples, Overviews vs Descriptions (in cases where they were
> saying
> > > the same thing).
> > >
> > > Also - for the file API, I just wrote to refer to the FileSystem spec
> for
> > > the API and copied over only the Cordova platform quirks. This will be
> a
> > > bad offline experience, so I'm not 100% convinced that was the right
> > thing
> > > to do, but wow is that file big if you were to copy over all of the
> > > documentation!
> > >
> > > https://github.com/apache/cordova-plugin-file/blob/dev/doc/index.md
> > >
> >
> >
> >
> > --
> > Carlos Santana
> > <csantana23@gmail.com>
> >
>



-- 
Carlos Santana
<csantana23@gmail.com>

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