[
https://issues.apache.org/jira/browse/CB-5658?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel
]
Andrew Grieve updated CB-5658:
------------------------------
Description:
This involves:
1. Delete the docs/ directory from all plugins
- They contain stale copies of what's in cordova-docs
2. Move plugin information found in cordova-docs into a single doc/index.md
file within the respective plugin repos
- Link to this file within each plugin's README.md file
3. Delete the "API Reference" section of cordova-docs
4. Add a guide called "Cordova Plugins", which contains:
- a link to plugins.cordova.io,
- a list of the org.apache.cordova plugins, which link to their index.md
files on github
- e.g.
https://github.com/apache/cordova-plugin-media-capture/blob/master/README.md
- These can be changed to point at their plugins.cordova.io page when that
shows READMEs.
- A link to the 3.3 docs, which still have plugin API reference
- Mostly, this is for finding non-english versions.
Motivation:
- Plugins are on a separate release cycle from platforms & docs.
- The documentation is often mismatched due to this
- Pull requests for plugins don't update the plugin docs
- But I think they would if the docs were in the same repo
Caveats:
- This will mess up our current translations story for plugins.
- I think this can be fixed up though, by changing out http://crowdin.net
push / pull scripts
- E.g. have README.md translations go in:
cordova-plugin-foo/translations/fr/README.md
was:
This involves:
1. Delete the docs/ directory from all plugins
- They contain stale copies of what's in cordova-docs
2. Move plugin information found in cordova-docs into a single README.md file
within the respective plugin repos
3. Delete the "API Reference" section of cordova-docs
4. Add a guide called "Cordova Plugins", which contains:
- a link to plugins.cordova.io,
- a list of the org.apache.cordova plugins, which link to their README.md
files on github
- e.g.
https://github.com/apache/cordova-plugin-media-capture/blob/master/README.md
- These can be changed to point at their plugins.cordova.io page when that
shows READMEs.
- A link to the 3.3 docs, which still have plugin API reference
- Mostly, this is for finding non-english versions.
Motivation:
- Plugins are on a separate release cycle from platforms & docs.
- The documentation is often mismatched due to this
- Pull requests for plugins don't update the plugin docs
- But I think they would if the docs were in the same repo
Caveats:
- This will mess up our current translations story for plugins.
- I think this can be fixed up though, by changing out http://crowdin.net
push / pull scripts
- E.g. have README.md translations go in:
cordova-plugin-foo/translations/fr/README.md
> Move plugin docs to plugin repos
> --------------------------------
>
> Key: CB-5658
> URL: https://issues.apache.org/jira/browse/CB-5658
> Project: Apache Cordova
> Issue Type: Bug
> Components: Docs, Plugin Battery Status, Plugin Camera, Plugin
> Console, Plugin Contacts, Plugin Device, Plugin Device Motion, Plugin Device
> Orientation, Plugin Dialogs, Plugin File, Plugin File Transfer, Plugin
> Geolocation, Plugin Globalization, Plugin InAppBrowser, Plugin Media, Plugin
> Media Capture, Plugin Network Information, Plugin SplashScreen, Plugin
> Vibration
> Reporter: Andrew Grieve
> Assignee: Andrew Grieve
>
> This involves:
> 1. Delete the docs/ directory from all plugins
> - They contain stale copies of what's in cordova-docs
> 2. Move plugin information found in cordova-docs into a single doc/index.md
> file within the respective plugin repos
> - Link to this file within each plugin's README.md file
> 3. Delete the "API Reference" section of cordova-docs
> 4. Add a guide called "Cordova Plugins", which contains:
> - a link to plugins.cordova.io,
> - a list of the org.apache.cordova plugins, which link to their index.md
> files on github
> - e.g.
> https://github.com/apache/cordova-plugin-media-capture/blob/master/README.md
> - These can be changed to point at their plugins.cordova.io page when
> that shows READMEs.
> - A link to the 3.3 docs, which still have plugin API reference
> - Mostly, this is for finding non-english versions.
> Motivation:
> - Plugins are on a separate release cycle from platforms & docs.
> - The documentation is often mismatched due to this
> - Pull requests for plugins don't update the plugin docs
> - But I think they would if the docs were in the same repo
> Caveats:
> - This will mess up our current translations story for plugins.
> - I think this can be fixed up though, by changing out http://crowdin.net
> push / pull scripts
> - E.g. have README.md translations go in:
> cordova-plugin-foo/translations/fr/README.md
--
This message was sent by Atlassian JIRA
(v6.1.4#6159)
