[jira] [Commented] (CB-13023) Clarify documentation around deprecated/removed platforms
[
https://issues.apache.org/jira/browse/CB-13023?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=16118770#comment-16118770
]
Filip Maj commented on CB-13023:
Also worth noting that previous versions of the docs (which are published)
would still contain the relevant content about deprecated platforms.
> Clarify documentation around deprecated/removed platforms
> -
>
> Key: CB-13023
> URL: https://issues.apache.org/jira/browse/CB-13023
> Project: Apache Cordova
> Issue Type: Sub-task
> Components: cordova-amazon-fireos (DEPRECATED), cordova-blackberry
> (DEPRECATED), cordova-docs, cordova-ubuntu, cordova-webos, cordova-website,
> cordova-wp8 (DEPRECATED)
>Reporter: Filip Maj
>Assignee: Filip Maj
> Labels: backlog
>
> Our docs show platform-getting-started and plugin-development guides for a
> variety of platforms. A few of those are already officially deprecated by
> Cordova (such as blackberry10 and WP8). Some I think are unofficially
> deprecated (ubuntu).
> I think we should:
> a) remove or at least make clear in our docs the platforms that are
> deprecated/removed
> b) reflect any needed changes on the website
> (http://cordova.apache.org/#supported_platforms_section)
> h1. List of Docs That Need Updating
> * [Platform Support
> Guide|https://cordova.apache.org/docs/en/latest/guide/support/index.html]:
> has a matrix of platform/plugin.
> * https://cordova.apache.org/docs/en/latest/config_ref/images.html has BB10
> and WP8 sections
> * https://cordova.apache.org/docs/en/latest/cordova/storage/storage.html
> supported platforms list BB10 in some sections
> * https://cordova.apache.org/docs/en/latest/guide/appdev/whitelist/index.html
> has BB10 section
> * https://cordova.apache.org/docs/en/latest/guide/hybrid/plugins/index.html
> has BB10 and WP8 sections
> * https://cordova.apache.org/docs/en/latest/guide/hybrid/webviews/index.html
> has a WP8 section link
> * https://cordova.apache.org/docs/en/latest/guide/next/index.html has some
> BlackBerry content
> * https://cordova.apache.org/docs/en/latest/config_ref/index.html has tons of
> BlackBerry content:
> ** remove blackberry icon from {{BackgroundColor(string)}}
> ** remove {{ChildBrowser(string)}} (blackberry only)
> ** remove {{HideKeyboardFormAccessoryBar(boolean)}} (blackberry only)
> ** remove {{PopupBlocker(string)}} (blackberry only)
> ** remove {{WebSecurity(string)}} (blackberry only)
> * https://cordova.apache.org/docs/en/latest/cordova/events/events.html needs
> to remove BB and WP8 columns
> *
> https://cordova.apache.org/docs/en/latest/reference/cordova-cli/index.html#supported-platforms
> *
> https://cordova.apache.org/docs/en/latest/plugin_ref/spec.html#engines-and-engine
> supported platforms
> * https://cordova.apache.org/docs/en/latest/plugin_ref/spec.html#platform
> allowed values
> *
> https://cordova.apache.org/docs/en/latest/reference/cordova-plugin-battery-status/index.html
> *
> https://cordova.apache.org/docs/en/latest/reference/cordova-plugin-camera/index.html
> *
> https://cordova.apache.org/docs/en/latest/reference/cordova-plugin-device/index.html
> *
> https://cordova.apache.org/docs/en/latest/reference/cordova-plugin-file/index.html
> *
> https://cordova.apache.org/docs/en/latest/reference/cordova-plugin-geolocation/index.html
> *
> https://cordova.apache.org/docs/en/latest/reference/cordova-plugin-globalization/index.html
> *
> https://cordova.apache.org/docs/en/latest/reference/cordova-plugin-inappbrowser/index.html
> *
> https://cordova.apache.org/docs/en/latest/reference/cordova-plugin-media-capture/index.html
> *
> https://cordova.apache.org/docs/en/latest/reference/cordova-plugin-network-information/index.html
> *
> https://cordova.apache.org/docs/en/latest/reference/cordova-plugin-vibration/index.html
> *
> h1. List of Docs That Need Removing
> *
> https://cordova.apache.org/docs/en/latest/guide/platforms/blackberry10/home.html
> * https://cordova.apache.org/docs/en/latest/guide/platforms/osx/index.html
> * https://cordova.apache.org/docs/en/latest/guide/platforms/ubuntu/index.html
> * https://cordova.apache.org/docs/en/latest/guide/platforms/wp8/home.html
> *
> https://cordova.apache.org/docs/en/latest/guide/platforms/blackberry10/plugin.html
> * https://cordova.apache.org/docs/en/latest/guide/platforms/wp8/plugin.html
--
This message was sent by Atlassian JIRA
(v6.4.14#64029)
-
To unsubscribe, e-mail: issues-unsubscr...@cordova.apache.org
For additional commands, e-mail: issues-h...@cordova.apache.org
[jira] [Commented] (CB-13023) Clarify documentation around deprecated/removed platforms
[
https://issues.apache.org/jira/browse/CB-13023?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=16116228#comment-16116228
]
Jan Piotrowski commented on CB-13023:
-
I think it would make sense to remove the documentation sections for the
deprecated platforms and move them to the main documentation of the deprecated
platform themselves. So "Images => WP8" becomes "WP8 => Images". Then all the
stuff for a deprecated platform is collected in one place and doesn't clutter
the other docs. This one document then can also be quite clear about the
deprecation. Makes sense?
Or will the main documentation for the deprecated platform also be removed from
the official docs? Could make sense as well, and as a fallback the now
unsupported platform still can have it's own documentation in the Github README
for example. This might even be the cleanest solution. Then you only need a
"Formerly supported platforms" list in one document that links to the
repositories.
> Clarify documentation around deprecated/removed platforms
> -
>
> Key: CB-13023
> URL: https://issues.apache.org/jira/browse/CB-13023
> Project: Apache Cordova
> Issue Type: Sub-task
> Components: cordova-amazon-fireos (DEPRECATED), cordova-blackberry
> (DEPRECATED), cordova-docs, cordova-ubuntu, cordova-webos, cordova-website,
> cordova-wp8 (DEPRECATED)
>Reporter: Filip Maj
>Assignee: Filip Maj
> Labels: backlog
>
> Our docs show platform-getting-started and plugin-development guides for a
> variety of platforms. A few of those are already officially deprecated by
> Cordova (such as blackberry10 and WP8). Some I think are unofficially
> deprecated (ubuntu).
> I think we should:
> a) remove or at least make clear in our docs the platforms that are
> deprecated/removed
> b) reflect any needed changes on the website
> (http://cordova.apache.org/#supported_platforms_section)
> h1. List of Docs That Need Updating
> * [Platform Support
> Guide|https://cordova.apache.org/docs/en/latest/guide/support/index.html]:
> has a matrix of platform/plugin.
> * https://cordova.apache.org/docs/en/latest/config_ref/images.html has BB10
> and WP8 sections
> * https://cordova.apache.org/docs/en/latest/cordova/storage/storage.html
> supported platforms list BB10 in some sections
> * https://cordova.apache.org/docs/en/latest/guide/appdev/whitelist/index.html
> has BB10 section
> * https://cordova.apache.org/docs/en/latest/guide/hybrid/plugins/index.html
> has BB10 and WP8 sections
> * https://cordova.apache.org/docs/en/latest/guide/hybrid/webviews/index.html
> has a WP8 section link
> * https://cordova.apache.org/docs/en/latest/guide/next/index.html has some
> BlackBerry content
> * https://cordova.apache.org/docs/en/latest/config_ref/index.html has tons of
> BlackBerry content:
> ** remove blackberry icon from {{BackgroundColor(string)}}
> ** remove {{ChildBrowser(string)}} (blackberry only)
> ** remove {{HideKeyboardFormAccessoryBar(boolean)}} (blackberry only)
> ** remove {{PopupBlocker(string)}} (blackberry only)
> ** remove {{WebSecurity(string)}} (blackberry only)
> * https://cordova.apache.org/docs/en/latest/cordova/events/events.html needs
> to remove BB and WP8 columns
> *
> https://cordova.apache.org/docs/en/latest/reference/cordova-cli/index.html#supported-platforms
> *
> https://cordova.apache.org/docs/en/latest/plugin_ref/spec.html#engines-and-engine
> supported platforms
> * https://cordova.apache.org/docs/en/latest/plugin_ref/spec.html#platform
> allowed values
> *
> https://cordova.apache.org/docs/en/latest/reference/cordova-plugin-battery-status/index.html
> *
> https://cordova.apache.org/docs/en/latest/reference/cordova-plugin-camera/index.html
> *
> https://cordova.apache.org/docs/en/latest/reference/cordova-plugin-device/index.html
> *
> https://cordova.apache.org/docs/en/latest/reference/cordova-plugin-file/index.html
> *
> https://cordova.apache.org/docs/en/latest/reference/cordova-plugin-geolocation/index.html
> *
> https://cordova.apache.org/docs/en/latest/reference/cordova-plugin-globalization/index.html
> *
> https://cordova.apache.org/docs/en/latest/reference/cordova-plugin-inappbrowser/index.html
> *
> https://cordova.apache.org/docs/en/latest/reference/cordova-plugin-media-capture/index.html
> *
> https://cordova.apache.org/docs/en/latest/reference/cordova-plugin-network-information/index.html
> *
> https://cordova.apache.org/docs/en/latest/reference/cordova-plugin-vibration/index.html
> *
> h1. List of Docs That Need Removing
> *
> https://cordova.apache.org/docs/en/latest/guide/platforms/blackberry10/home.html
> * https://cordova.apache.org/docs/en/latest/guide/platforms/osx/index.html
> * https://cordova.apache.org/docs/en/latest/guide/platforms/ubuntu/index.html
> * htt
