You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@cordova.apache.org by Vahid H <co...@gmail.com> on 2014/04/28 22:11:29 UTC

Release tagging of code and docs

Hello,

Is there any sort of Git tagging done on version release of both the code
and the documentation? The latest tag I could find was "3.0.0". The plugin
documentation links are currently broken (on here
http://cordova.apache.org/docs/en/3.4.0/cordova_plugins_pluginapis.md.html#Plugin%20APIs),
but that has been mentioned in another email.

I am assuming this is supposed to be the correct link using File as an
example: https://github.com/apache/cordova-plugin-file

Looking through there, you will see a mention of "library-nosync" for iOS.
This directory is in the latest CDVFile.m on GitHub but is not in any
release yet. So what am I, as a user, supposed to do? I can't trust that
the documentation is accurate for even the latest library version. If
releases were tagged, I could go back to the 3.4.0 docs and where
"library-nosync" wouldn't be mentioned.

Thanks
Vahid

Re: Release tagging of code and docs

Posted by Ian Clelland <ic...@chromium.org>.
Hi, Vahid --

I'm actually in the middle of updating the plugin documentation links right
now, and hopefully this is going to be getting better.

The plugin documentation is now available right on the plugin registry --
http://plugins.cordova.io -- so, you could find the docs for the latest
released version of File at
http://plugins.cordova.io/#/package/org.apache.cordova.file
(which does contain a mention of library-nosync, as it was added to File
1.1.0 releaseed last week, although the documentation is extremely light on
that point)

One of the changes we made recently (well, in the last few months anyway)
was to move all of the plugin documentation to within the plugins
themselves. This ensures that the documentation is tagged at the same time
as the plugin code, when it is released, and should help us keep the docs
up to date.

The file plugin docs do need some work, certainly; but that's a different
issue, and I haven't just managed to sit down and rewrite them.

Ian


On Mon, Apr 28, 2014 at 4:11 PM, Vahid H <co...@gmail.com> wrote:

> Hello,
>
> Is there any sort of Git tagging done on version release of both the code
> and the documentation? The latest tag I could find was "3.0.0". The plugin
> documentation links are currently broken (on here
>
> http://cordova.apache.org/docs/en/3.4.0/cordova_plugins_pluginapis.md.html#Plugin%20APIs
> ),
> but that has been mentioned in another email.
>
> I am assuming this is supposed to be the correct link using File as an
> example: https://github.com/apache/cordova-plugin-file
>
> Looking through there, you will see a mention of "library-nosync" for iOS.
> This directory is in the latest CDVFile.m on GitHub but is not in any
> release yet. So what am I, as a user, supposed to do? I can't trust that
> the documentation is accurate for even the latest library version. If
> releases were tagged, I could go back to the 3.4.0 docs and where
> "library-nosync" wouldn't be mentioned.
>
> Thanks
> Vahid
>