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 22:49:39 GMT


ASF GitHub Bot commented on CB-10332:

Github user riknoll commented on a diff in the pull request:
    --- Diff: www/docs/en/dev/guide/platforms/android/ ---
    @@ -32,276 +32,152 @@ development. For a comparison of the two development paths, see
     ## Requirements and Support
    +### Java Development Kit (JDK)
    +Install [Java Development Kit (JDK) 7](
    +or later.
    +When installing on Windows you also need to set `JAVA_HOME` Environment Variable
    +according to JDK installation path (for example, `C:\Program Files\Java\jdk1.7.0_75`).
    +### Android SDK
     Cordova for Android requires the Android SDK which could be installed
     on OS X, Linux or Windows operation system. See the Android SDK's
     [System Requirements](
    -Cordova supports Android 4.0.x (starting with Android API level 14)
    -and higher.  As a general rule, Android versions become unsupported by Cordova as
    +Cordova's latest Android package supports up to Android [API-Level](
    +The supported Android API-Levels for the past few cordova-android releases can
    +be found in this table:
    +cordova-android Version | Supported Android API-Levels
    +5.X.X                   | 14 - 23
    +4.1.X                   | 14 - 22
    +4.0.X                   | 10 - 22
    +3.7.X                   | 10 - 21
    +Please note that the versions listed here are for Cordova's Android package,
    +[cordova-android](, and not for the
    +Cordova CLI. To determine what version of Cordova's Android package is installed
    +in your Cordova project, run the command `cordova platform ls` in the directory
    +that holds your project.
    +As a general rule, Android versions become unsupported by Cordova as
     they dip below 5% on Google's
     [distribution dashboard](
    -Android versions earlier than API level 10, and the 3.x versions (Honeycomb,
    -API levels 11-13) fall significantly below that 5% threshold.
    -## Install Cordova Shell Tools
    -If you want to use Cordova's Android-centered shell tools in
    -conjunction with the SDK, download Cordova from
    -[]( Otherwise ignore this
    -section if you plan to use the cross-platform CLI tool described in
    -[The Command-Line Interface](../../cli/index.html).
    -The Cordova download contains separate archives for each platform. Be
    -sure to expand the appropriate archive, `android` in this case, within
    -an empty directory.  The relevant executible utilities are available
    -in the top-level `bin` directory. (Consult the __README__ file if
    -necessary for more detailed directions.)
    +#### Installing the Android SDK
    -These shell tools allow you to create, build, and run Android apps.
    -For information on the additional command-line interface that enables
    -plugin features across all platforms, see Using Plugman to Manage
    -Plugins. See Application Plugins for details on how to develop
    -## Install the Java Development Kit (JDK)
    -Install [Java Development Kit (JDK) 7](
    -or later. 
    -When installing on Windows you also need to set `JAVA_HOME` Environment Variable
    -according to JDK installation path (for example, C:\Program Files\Java\jdk1.7.0_75).
    -## Install the Android SDK
    -Install the [Android Stand-alone SDK Tools](
or [Android Studio]( Procceed
with `Android Studio` if you plan 
    +Install the [Android Stand-alone SDK Tools](
or [Android Studio](
    +Proceed with Android Studio if you plan on
     developing new Cordova for Android plugins or using native tools to
    --- End diff --
    For some reason this article says "Cordova for Android" all over the place and so I kept
that up. This sentence was referring to plugins. Android Studio can be used with apps, but
 I think the better use case is with plugins.

> 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