Mailing-List: contact dev-help@cordova.apache.org; run by ezmlm
Precedence: bulk
Reply-To: dev@cordova.apache.org
From: Parashuram N <panarasi@microsoft.com>
To: "dev@cordova.apache.org" <dev@cordova.apache.org>
Subject: Adding Examples for Plugins in the ReadMe
Thread-Topic: Adding Examples for Plugins in the ReadMe
Thread-Index: AdGJOroBVwI8ouTSQDm0AkfMB63lOQ==
Date: Mon, 28 Mar 2016 21:47:58 +0000
Message-ID: 
 <BL2PR03MB116A12FD35EABA252AF3919D6860@BL2PR03MB116.namprd03.prod.outlook.com>
Accept-Language: en-US
Content-Language: en-US
spamdiagnosticoutput: 1:23
spamdiagnosticmetadata: NSPM
Content-Type: multipart/alternative;
	boundary="_000_BL2PR03MB116A12FD35EABA252AF3919D6860BL2PR03MB116namprd_"
MIME-Version: 1.0
X-MS-Exchange-CrossTenant-originalarrivaltime: 28 Mar 2016 21:47:58.7707
 (UTC)
X-MS-Exchange-CrossTenant-fromentityheader: Hosted
X-MS-Exchange-CrossTenant-id: 72f988bf-86f1-41af-91ab-2d7cd011db47
X-MS-Exchange-Transport-CrossTenantHeadersStamped: BL2PR03MB113

--_000_BL2PR03MB116A12FD35EABA252AF3919D6860BL2PR03MB116namprd_
Content-Type: text/plain; charset="us-ascii"
Content-Transfer-Encoding: quoted-printable

Hey folks,

At the moment, the sample code in our plugins is limited to only show basic=
 usage of the API. While this is great for someone who has already written =
Cordova projects, I believe that we may need more examples for folks who ar=
e just getting started with Cordova.
To improve our documentation, Norm has sent out a pull request with additio=
nal examples that show the typical use cases for the plugins - https://gith=
ub.com/apache/cordova-plugin-geolocation/pull/74/files

This PR is the first in a set of work that we would like to do, to improve =
documentation for plugins. A few questions to the community about this dire=
ction


1.       Is it ok to include this as a part of the README ? That would incr=
ease the visibility of the examples much more. We could have a "REFERENCE" =
section that is for quick reference, and then this set of detailed examples=
 showing how the plugins work. Anyone have objections to that ? Note that t=
he README would be longer, but I think that should be ok. Also note that th=
e README is imported into the Cordova docs, so these examples will also sho=
w up there

2.       Some of the example have links to full projects that use the plugi=
n. We did not find a place on the Apache github organization to put it all =
up, so they currently reside in a Microsoft-github organization. Is that ok=
 ? Is there a place to put full fledged Cordova samples on the Apache repos=
 ?

--_000_BL2PR03MB116A12FD35EABA252AF3919D6860BL2PR03MB116namprd_--