cordova-issues mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From "ASF GitHub Bot (JIRA)" <>
Subject [jira] [Commented] (CB-10332) Improve Android Guide
Date Wed, 03 Feb 2016 23:00:41 GMT


ASF GitHub Bot commented on CB-10332:

Github user rakatyal commented on a diff in the pull request:
    --- Diff: www/docs/en/dev/guide/platforms/android/ ---
    @@ -31,12 +31,12 @@ platform and back.  For another sample, see also the comments in
     Android plugins are based on Cordova-Android, which consists of an
    -Android WebView with hooks attached to it.  Plugins are represented as
    -class mappings in the `config.xml` file.  A plugin consists of at
    +Android WebView with hooks attached to it. Plugins are represented as
    +class mappings in the `config.xml` file. A plugin consists of at
     least one Java class that extends the `CordovaPlugin` class,
    -overriding one of its `execute` methods. As best practice, the plugin
    -should also handle `[pause](../../../cordova/events/events.pause.html)` and `[resume](../../../cordova/events/events.resume.html)`
events, along with any message
    -passing between plugins.  Plugins with long-running requests,
    +overriding one of its `execute` methods. As a best practice, the plugin
    +should also handle [`pause`](../../../cordova/events/events.pause.html) and [`resume`](../../../cordova/events/events.resume.html)
events, along with any message
    --- End diff --
    Link these to events reference?

> Improve Android Guide
> ---------------------
>                 Key: CB-10332
>                 URL:
>             Project: Apache Cordova
>          Issue Type: Task
>          Components: Docs
>            Reporter: Raghav
>            Assignee: Richard B Knoll
>              Labels: Docs-6.x
> We did a document scrub and found the following issues. Please feel free to correct other
things as well.
> - Android Platform Guide
> -- Install Cordova Shell tools is out of date
> -- Environment variable instructions for Windows are out of date
> -- Emulator section can just point to
> -- Lots of duplicated content for create/build/deploy from CLI page
> -- Page keeps switching between CLI and platform-centric workflow
> - Android Shell Tool Guide
> -- Second paragraph is out of date
> -- Create/build/run/logging/clean should be clear that this is the platform-centric workflow.
Also duplicated in Android Platform guide
> -- Platform-centric workflow should probably just get its own explicit page
> -- Signing an app doesn't actually say how to sign an app. Gives arguments for some mystery
> --- Does this belong in our docs? We might just mention it and point to Google's app
signing instructions
> - Android WebViews
> -- Needs investigation if this is still supported.
> --- Step 1 is wrong (should be getting cordova-android by cloning or from npm)
> --- Step 3 needs to have instructions for adding jars to gradle
> --- Step 5 is out of date. CordovaActivity does not implement CordovaInterface... Think
they should be extending/modifying CordovaActivity. Needs investigation
> --- Step 6 does not appear to be camera plugin specific
> --- Step 7 example is useless, it needs to be fleshed out
> - Android plugins
> -- Should be moved to plugin developer docs
> -- Need a reference for the classes that plugins have access to
> --- CordovaWebView, CallbackContext, CordovaPlugin, etc.
> --- Most already have javadoc
> -- Android Integration should be renamed and link to the Android classes it's talking
> -- Debugging Android plugins is out of date (mentions Eclipse and jars) and should probably
be fleshed out a bit
> - Android Configuration
> -- Should be a reference
> - Upgrading Android
> -- Ends at 4.0.0 (current is 4.1.1, soon to be 5.0.0)
> -- Needs to be reorganized in some way
> --- The instructions seem to be pretty much the same for versions 1.6.0 +
> -- Goes back to the phonegap days! Should probably only include Cordova versions (1.5.0
> -- Upgrade to 1.8.0 from 1.7.0 repeated twice
> -- Upgrade to 1.8.0 from 1.8.0 is a typo
> General guidelines:
> - While giving examples, keep them short. Do not repeat for all plugins/platforms.
> - Remove all references to cordova plugin registry.
> - Remove Tizen references. The platform is deprecated (
> - Keep information up to date for the platforms, CLI and plugins

This message was sent by Atlassian JIRA

To unsubscribe, e-mail:
For additional commands, e-mail:

View raw message