You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@cordova.apache.org by James Jong <wj...@gmail.com> on 2013/10/15 20:17:26 UTC

officially supported plugins from the Cordova community

As we're breaking out and developing more and more plugins, one question I have been getting is "what is the set of plugins officially supported by the Cordova community?"  It's unclear to me what defines this set.  Here's how I've been categorizing them.

Supported
1) Publicly documented APIs on cordova.apache.org/docs (Accelerometer, Compass, etc…).  These plugins fall under the org.apache.cordova namespace.

Unsupported
2) plugins not under org.apache.cordova namespace
3) org.apache.cordova plugins under cordova-labs (like the new iOS keyboard, status bar plugins)

Gray areas
4) Undocumented plugins that were formerly part of the core.  For example, the console plugin.  This is a org,apache.cordova plugin, but not documented as part of public APIs.  Also, not all platforms support it.  Should we support it?  If we support it, should we document the API in our Cordova docs?

Thoughts?  Should we have a list of supported plugins in our documentation to point Cordova users to?

-James Jong


Re: officially supported plugins from the Cordova community

Posted by James Jong <wj...@gmail.com>.
Instead of a static list, would it be better to point to our plugin registry and filter for org.apache.cordova?  Also, does it make sense to reserve this namespace for Cordova use only?

-James Jong

On Oct 15, 2013, at 6:49 PM, "Smith, Peter" <pe...@fast.au.fujitsu.com> wrote:

> +1 for some kind of list
> 
> Whenever the documented API refers to plugins which are not found in
> what I thought was the official set plugins at
> https://github.com/search?q=%40apache+cordova-plugin my brain hurts.
> e.g. https://issues.apache.org/jira/browse/CB-5090
> 
> Peter.
> 
> 
> -----Original Message-----
> From: James Jong [mailto:wjamesjong@gmail.com] 
> Sent: Wednesday, 16 October 2013 5:17 AM
> To: dev@cordova.apache.org
> Subject: officially supported plugins from the Cordova community
> 
> As we're breaking out and developing more and more plugins, one question
> I have been getting is "what is the set of plugins officially supported
> by the Cordova community?"  It's unclear to me what defines this set.
> Here's how I've been categorizing them.
> 
> Supported
> 1) Publicly documented APIs on cordova.apache.org/docs (Accelerometer,
> Compass, etc...).  These plugins fall under the org.apache.cordova
> namespace.
> 
> Unsupported
> 2) plugins not under org.apache.cordova namespace
> 3) org.apache.cordova plugins under cordova-labs (like the new iOS
> keyboard, status bar plugins)
> 
> Gray areas
> 4) Undocumented plugins that were formerly part of the core.  For
> example, the console plugin.  This is a org,apache.cordova plugin, but
> not documented as part of public APIs.  Also, not all platforms support
> it.  Should we support it?  If we support it, should we document the API
> in our Cordova docs?
> 
> Thoughts?  Should we have a list of supported plugins in our
> documentation to point Cordova users to?
> 
> -James Jong
> 
> 


RE: officially supported plugins from the Cordova community

Posted by "Smith, Peter" <pe...@fast.au.fujitsu.com>.
+1 for some kind of list

Whenever the documented API refers to plugins which are not found in
what I thought was the official set plugins at
https://github.com/search?q=%40apache+cordova-plugin my brain hurts.
e.g. https://issues.apache.org/jira/browse/CB-5090

Peter.


-----Original Message-----
From: James Jong [mailto:wjamesjong@gmail.com] 
Sent: Wednesday, 16 October 2013 5:17 AM
To: dev@cordova.apache.org
Subject: officially supported plugins from the Cordova community

As we're breaking out and developing more and more plugins, one question
I have been getting is "what is the set of plugins officially supported
by the Cordova community?"  It's unclear to me what defines this set.
Here's how I've been categorizing them.

Supported
1) Publicly documented APIs on cordova.apache.org/docs (Accelerometer,
Compass, etc...).  These plugins fall under the org.apache.cordova
namespace.

Unsupported
2) plugins not under org.apache.cordova namespace
3) org.apache.cordova plugins under cordova-labs (like the new iOS
keyboard, status bar plugins)

Gray areas
4) Undocumented plugins that were formerly part of the core.  For
example, the console plugin.  This is a org,apache.cordova plugin, but
not documented as part of public APIs.  Also, not all platforms support
it.  Should we support it?  If we support it, should we document the API
in our Cordova docs?

Thoughts?  Should we have a list of supported plugins in our
documentation to point Cordova users to?

-James Jong



Re: officially supported plugins from the Cordova community

Posted by Brian LeRoux <b...@brian.io>.
oversight

opened a bug: http://issues.cordova.io/5089


On Tue, Oct 15, 2013 at 4:24 PM, Marcel Kinard <cm...@gmail.com> wrote:

> Here's the question I'm wondering about:
>
> The console plugin is not documented in cordova-docs. Is that an
> oversight, or is it a plugin that is treated differently?
>
> My take is that it is an oversight. If not, then what is the reasoning?

Re: officially supported plugins from the Cordova community

Posted by Marcel Kinard <cm...@gmail.com>.
Here's the question I'm wondering about:

The console plugin is not documented in cordova-docs. Is that an oversight, or is it a plugin that is treated differently?

My take is that it is an oversight. If not, then what is the reasoning?

Re: officially supported plugins from the Cordova community

Posted by Brian LeRoux <b...@brian.io>.
The tacit plan is to observe the plugin installation/download counts to
inform our decisions about what remains official and not. I suspect we
maintain more stuff than our community currently uses or needs.

Also, agree w/ Andrew that we should start migrating docs to the plugins
themselves.


On Tue, Oct 15, 2013 at 2:23 PM, Andrew Grieve <ag...@chromium.org> wrote:

> I think it depends on what your definition of "officially supported" is. If
> it's that we'll try and fix bugs that arise in them, I think they are all
> officially supported.
>
> In a 3.0 world, I think we'll move more towards having docs bundled with
> plugins instead of hosted on docs.cordova.io, so I don't think the docs
> are
> indicative of what we will "officially support"
>
>
> On Tue, Oct 15, 2013 at 2:17 PM, James Jong <wj...@gmail.com> wrote:
>
> > As we're breaking out and developing more and more plugins, one question
> I
> > have been getting is "what is the set of plugins officially supported by
> > the Cordova community?"  It's unclear to me what defines this set.
>  Here's
> > how I've been categorizing them.
> >
> > Supported
> > 1) Publicly documented APIs on cordova.apache.org/docs (Accelerometer,
> > Compass, etc…).  These plugins fall under the org.apache.cordova
> namespace.
> >
> > Unsupported
> > 2) plugins not under org.apache.cordova namespace
> > 3) org.apache.cordova plugins under cordova-labs (like the new iOS
> > keyboard, status bar plugins)
> >
> > Gray areas
> > 4) Undocumented plugins that were formerly part of the core.  For
> example,
> > the console plugin.  This is a org,apache.cordova plugin, but not
> > documented as part of public APIs.  Also, not all platforms support it.
> >  Should we support it?  If we support it, should we document the API in
> our
> > Cordova docs?
> >
> > Thoughts?  Should we have a list of supported plugins in our
> documentation
> > to point Cordova users to?
> >
> > -James Jong
> >
> >
>

Re: officially supported plugins from the Cordova community

Posted by Andrew Grieve <ag...@chromium.org>.
I think it depends on what your definition of "officially supported" is. If
it's that we'll try and fix bugs that arise in them, I think they are all
officially supported.

In a 3.0 world, I think we'll move more towards having docs bundled with
plugins instead of hosted on docs.cordova.io, so I don't think the docs are
indicative of what we will "officially support"


On Tue, Oct 15, 2013 at 2:17 PM, James Jong <wj...@gmail.com> wrote:

> As we're breaking out and developing more and more plugins, one question I
> have been getting is "what is the set of plugins officially supported by
> the Cordova community?"  It's unclear to me what defines this set.  Here's
> how I've been categorizing them.
>
> Supported
> 1) Publicly documented APIs on cordova.apache.org/docs (Accelerometer,
> Compass, etc…).  These plugins fall under the org.apache.cordova namespace.
>
> Unsupported
> 2) plugins not under org.apache.cordova namespace
> 3) org.apache.cordova plugins under cordova-labs (like the new iOS
> keyboard, status bar plugins)
>
> Gray areas
> 4) Undocumented plugins that were formerly part of the core.  For example,
> the console plugin.  This is a org,apache.cordova plugin, but not
> documented as part of public APIs.  Also, not all platforms support it.
>  Should we support it?  If we support it, should we document the API in our
> Cordova docs?
>
> Thoughts?  Should we have a list of supported plugins in our documentation
> to point Cordova users to?
>
> -James Jong
>
>