You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@cordova.apache.org by db...@apache.org on 2015/09/01 20:44:45 UTC
[1/4] docs commit: Converted plugin help pages to markdown and fixed
minor content errors
Repository: cordova-docs
Updated Branches:
refs/heads/cordova-website a8a96ae73 -> 358857eb3
Converted plugin help pages to markdown and fixed minor content errors
Project: http://git-wip-us.apache.org/repos/asf/cordova-docs/repo
Commit: http://git-wip-us.apache.org/repos/asf/cordova-docs/commit/4fdd56b6
Tree: http://git-wip-us.apache.org/repos/asf/cordova-docs/tree/4fdd56b6
Diff: http://git-wip-us.apache.org/repos/asf/cordova-docs/diff/4fdd56b6
Branch: refs/heads/cordova-website
Commit: 4fdd56b634cee5e6bfb5a9ebbfc3e72084506069
Parents: 53f3da3
Author: riknoll <ri...@microsoft.com>
Authored: Mon Aug 31 11:25:12 2015 -0700
Committer: Dmitry Blotsky <dm...@gmail.com>
Committed: Tue Sep 1 11:43:21 2015 -0700
----------------------------------------------------------------------
www/_layouts/plugins-help.html | 8 ++++++
www/plugins/authors.html | 50 -------------------------------------
www/plugins/authors.md | 47 ++++++++++++++++++++++++++++++++++
www/plugins/faq.html | 29 ---------------------
www/plugins/faq.md | 41 ++++++++++++++++++++++++++++++
5 files changed, 96 insertions(+), 79 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/4fdd56b6/www/_layouts/plugins-help.html
----------------------------------------------------------------------
diff --git a/www/_layouts/plugins-help.html b/www/_layouts/plugins-help.html
new file mode 100644
index 0000000..c5ff10d
--- /dev/null
+++ b/www/_layouts/plugins-help.html
@@ -0,0 +1,8 @@
+---
+layout: cordova
+plugins_tab: true
+---
+
+<div class="container">
+{{ content }}
+</div>
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/4fdd56b6/www/plugins/authors.html
----------------------------------------------------------------------
diff --git a/www/plugins/authors.html b/www/plugins/authors.html
deleted file mode 100644
index fe9eda8..0000000
--- a/www/plugins/authors.html
+++ /dev/null
@@ -1,50 +0,0 @@
----
-layout: cordova
-title: Apache Cordova Plugin Contributors
-plugins_tab: true
----
-
-<div class="container">
- <h1 class="icon icon-about">npm Plugin Search for Plugin Authors</h1>
- <h2>How do I add a new plugin to Plugin Search?</h2>
- <p>If you want your Cordova Plugin to show up in search, simply add <code>ecosystem:cordova</code> keyword to the <code>package.json</code> file of your plugin and publish it to npm registry.</p>
- <h2>How can I tag supported platforms for my plugin?</h2>
- <p>Similar to <code>ecosystem:cordova</code>, platform support too uses keywords. Just add the platform name prefixed with "<strong>cordova-</strong>" to plugins list of keywords. E.g.</p>
- <pre><code> "keywords": [
- "ecosystem:cordova",
- "cordova-android",
- "cordova-ios",
- "cordova-windows"
- ]</code></pre>
- <h2>My plugin is in plugins.cordova.io but I want to publish to npm. How do I do that?</h2>
- <ol>
- <li>
- <strong>Optional</strong> Decide if you want to change your plugin’s id. If you decide to change it,
- <ol>
- <li>Update the id in plugin.xml and update your readme with the new id.</li>
- <li>Send a pull request adding your new id and old id to Cordova Registry Mapper.</li>
- <li>We integrate that module into the Cordova CLI to warn users to use the new id when adding plugins to their projects.</li>
- </ol>
- </li>
- <li>Add a <code>package.json</code> to your plugins,
- <ul>
- <li>
- <strong>Note</strong>: To keep things simple, please make sure your <code>id</code> in <code>plugin.xml</code> is the same as your <code>package-name</code> in <code>package.json</code>.</li>
- <li>Use <code>plugman createpackagejson [PLUGIN DIRECTORY]</code> to create <code>package.json</code>.
- <ul>
- <li>This will create defaults based on existing values in your <code>plugin.xml</code>.</li>
- <li>It will also automatically add the keyword <code>ecosystem:cordova</code> to your newly generated package.json file.</li>
- <li>In addition, a cordova key will be added to your <code>package.json</code> which we plan to use in future updates of the tooling.</li>
- </ul>
- </li>
- <li>View the <code>package.json</code> of <a href="https://github.com/apache/cordova-plugin-device/blob/master/package.json" target="_blank">cordova-plugin-device</a> to see an example of what your <code>package.json</code> should look like after running <code>plugman createpackagejson [PLUGIN DIRECTORY]</code> command.</li>
- <li>Plugins still require a <code>plugin.xml</code> to be installed into <strong>Cordova</strong> projects.</li>
- </ul>
- </li>
- <li>Publish your plugin to npm using the <code>npm publish [PLUGIN DIRECTORY]</code>.</li>
- </ol>
- <h2>Are there any additional documents to assist me with plugins?</h2>
- <p>Yes there are. Please take a look at <a href="{{ site.baseurl }}/docs/en/edge/guide/hybrid/plugins/index.html" target="_blank">Plugin Development Guide</a> for a more detailed guide.</p>
- <h2>I don't like X. How can I help improve the website?</h2>
- <p>You can help improving this site by opening bugs on <a href="https://issues.apache.org/jira/issues/?jql=project%20%3D%20CB%20AND%20status%20%3D%20Open%20AND%20component%20%3D%20%22Registry%20Web%22" target="_blank">JIRA</a> or by sending PRs on <a href="https://github.com/apache/cordova-registry-web" target="_blank">GitHub</a>.</p>
-</div>
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/4fdd56b6/www/plugins/authors.md
----------------------------------------------------------------------
diff --git a/www/plugins/authors.md b/www/plugins/authors.md
new file mode 100644
index 0000000..ac5da38
--- /dev/null
+++ b/www/plugins/authors.md
@@ -0,0 +1,47 @@
+---
+layout: plugins-help
+title: Apache Cordova Plugin Contributors
+---
+
+# npm Plugin Search for Plugin Authors
+
+## How do I add a new plugin to Plugin Search?
+
+If you want your Cordova Plugin to show up in search, simply add the `ecosystem:cordova` keyword to the `package.json` file of your plugin and publish it to npm registry.
+
+## How can I tag supported platforms for my plugin?
+
+Similar to `ecosystem:cordova`, platform support too uses keywords. Just add the platform name prefixed with "**cordova-**" to the plugin's list of keywords. E.g.
+
+
+ "keywords": [
+ "ecosystem:cordova",
+ "cordova-android",
+ "cordova-ios",
+ "cordova-windows"
+ ]
+
+
+## My plugin is in plugins.cordova.io but I want to publish to npm. How do I do that?
+
+1. **Optional** Decide if you want to change your plugin’s id. If you decide to change it,
+ 1. Update the id in `plugin.xml` and update your readme with the new id.
+ 2. Send a pull request adding your new id and old id to Cordova Registry Mapper.
+ 3. We integrate that module into the Cordova CLI to warn users to use the new id when adding plugins to their projects.
+2. Add a `package.json` to your plugins,
+ * **Note**: To keep things simple, please make sure your `id` in `plugin.xml` is the same as your `package-name` in `package.json`.
+ * Use `plugman createpackagejson [PLUGIN DIRECTORY]` to create `package.json`.
+ * This will create defaults based on existing values in your `plugin.xml`.
+ * It will also automatically add the keyword `ecosystem:cordova` to your newly generated `package.json` file.
+ * In addition, a cordova key will be added to your `package.json` which we plan to use in future updates of the tooling.
+ * View the `package.json` of [cordova-plugin-device](https://github.com/apache/cordova-plugin-device/blob/master/package.json) to see an example of what your `package.json` should look like after running `plugman createpackagejson [PLUGIN DIRECTORY]` command.
+ * Plugins still require a `plugin.xml` to be installed into **Cordova** projects.
+3. Publish your plugin to npm using the `npm publish [PLUGIN DIRECTORY]`.
+
+## Are there any additional documents to assist me with plugins?
+
+Yes there are. Please take a look at the [Plugin Development Guide]({{ site.baseurl }}/docs/en/edge/guide/hybrid/plugins/index.html) for a more detailed guide.
+
+## I don't like X. How can I help improve the website?
+
+You can help improve this site by opening bugs on [JIRA](https://issues.apache.org/jira/issues/?jql=project%20%3D%20CB%20AND%20status%20%3D%20Open%20AND%20component%20%3D%20%22Registry%20Web%22) or by sending PRs on [GitHub](https://github.com/apache/cordova-docs/tree/cordova-website).
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/4fdd56b6/www/plugins/faq.html
----------------------------------------------------------------------
diff --git a/www/plugins/faq.html b/www/plugins/faq.html
deleted file mode 100644
index afd2521..0000000
--- a/www/plugins/faq.html
+++ /dev/null
@@ -1,29 +0,0 @@
----
-layout: cordova
-title: Apache Cordova Plugins FAQ
-plugins_tab: true
----
-
-<div class="container">
- <h1 class="icon icon-about">npm Plugin Search FAQ</h1>
- <h2>What is npm Plugin Search?</h2>
- <p>On April 21 2015, Cordova team announced plans to move core and 3rd party plugins to npm ecosystem. npm Plugin Search page offers an easy and user friendly way to browse plugins that have completed this transition.</p>
- <h2>What version of Cordova do I need to use npm?</h2>
- <p>To start using plugins from npm, Cordova CLI version 5.0.0 or higher is required.</p>
- <h2>How do I install plugins from npm?</h2>
- <p>Cordova team decided to change official plugin IDs from org.apache.cordova.* to cordova-plugin-* to better fit within the npm ecosystem. Developers can install a plugin using the command <code>cordova plugin add cordova-plugin-device</code>.</p>
- <h2>How do I know which platforms are supported for a plugin?</h2>
- <p>Plugin Search displays plugins in form of cards. Each card contains important information about the plugin. Supported platforms is represented in form of platform tags. </p>
- <h2>Can I still download plugins if I'm using Cordova CLI 4.3.0 or lower?</h2>
- <p>Yes! You can use Cordova Plugins from the <a href="http://plugins.cordova.io/" target="_blank">old plugin registry</a>.</p>
- <h2>What’s happening to the old plugin registry?</h2>
- <p>See Cordova <a href="{{ site.baseurl }}/announcements/2015/04/21/plugins-release-and-move-to-npm.html" target="_blank">blog</a> for more details. It’s being phased out:</p>
- <ul>
- <li> Read-only after July 15th</li>
- <li> End of support after October 15th</li>
- </ul>
- <h2>Are there any additional documents to assist me with plugins?</h2>
- <p>Yes there are. Please take a look at <a href="{{ site.baseurl }}/docs/en/edge/guide/cli/#link-add-plugin-features" target="_blank">Add Plugin Features</a> for a more detailed guide.</p>
- <h2>I don't like X. How can I help improve the website?</h2>
- <p>You can help improving this site by opening bugs on <a href="https://issues.apache.org/jira/issues/?jql=project%20%3D%20CB%20AND%20status%20%3D%20Open%20AND%20component%20%3D%20%22Registry%20Web%22" target="_blank">JIRA</a> or by sending PRs on <a href="https://github.com/apache/cordova-registry-web" target="_blank">GitHub</a>.</p>
-</div>
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/4fdd56b6/www/plugins/faq.md
----------------------------------------------------------------------
diff --git a/www/plugins/faq.md b/www/plugins/faq.md
new file mode 100644
index 0000000..343ee40
--- /dev/null
+++ b/www/plugins/faq.md
@@ -0,0 +1,41 @@
+---
+layout: plugins-help
+title: Apache Cordova Plugins FAQ
+---
+
+# npm Plugin Search FAQ
+
+## What is npm Plugin Search?
+
+On April 21 2015, Cordova team announced plans to move core and 3rd party plugins to the npm ecosystem. The [npm Plugin Search]({{ site.baseurl }}/plugins) page offers an easy and user friendly way to browse plugins that have completed this transition.
+
+## What version of Cordova do I need to use npm?
+
+To start using plugins from npm, Cordova CLI version 5.0.0 or higher is required.
+
+## How do I install plugins from npm?
+
+Cordova team decided to change official plugin IDs from org.apache.cordova.* to cordova-plugin-* to better fit within the npm ecosystem. Developers can install a plugin using the command `cordova plugin add [PLUGIN ID]`.
+
+## How do I know which platforms are supported for a plugin?
+
+Plugin Search displays plugins in the form of cards. Each card contains important information about the plugin. Supported platforms are represented in the form of platform icons across the bottom of the card.
+
+## Can I still download plugins if I'm using Cordova CLI 4.3.0 or lower?
+
+Yes! You can use Cordova Plugins from the [old plugin registry](http://plugins.cordova.io/).
+
+## What’s happening to the old plugin registry?
+
+See Cordova [blog]({{ site.baseurl }}/announcements/2015/04/21/plugins-release-and-move-to-npm.html) for more details. It’s being phased out:
+
+* Read-only after July 15th
+* End of support after October 15th
+
+## Are there any additional documents to assist me with plugins?
+
+Yes there are. Please take a look at [Add Plugin Features]({{ site.baseurl }}/docs/en/edge/guide/cli/#link-add-plugin-features) for a more detailed guide.
+
+## I don't like X. How can I help improve the website?
+
+You can help improve this site by opening bugs on [JIRA](https://issues.apache.org/jira/issues/?jql=project%20%3D%20CB%20AND%20status%20%3D%20Open%20AND%20component%20%3D%20%22Registry%20Web%22) or by sending PRs on [GitHub](https://github.com/apache/cordova-docs/tree/cordova-website).
---------------------------------------------------------------------
To unsubscribe, e-mail: commits-unsubscribe@cordova.apache.org
For additional commands, e-mail: commits-help@cordova.apache.org
[3/4] docs commit: Removed plugin issue tracker link
Posted by db...@apache.org.
Removed plugin issue tracker link
Project: http://git-wip-us.apache.org/repos/asf/cordova-docs/repo
Commit: http://git-wip-us.apache.org/repos/asf/cordova-docs/commit/46dda77a
Tree: http://git-wip-us.apache.org/repos/asf/cordova-docs/tree/46dda77a
Diff: http://git-wip-us.apache.org/repos/asf/cordova-docs/diff/46dda77a
Branch: refs/heads/cordova-website
Commit: 46dda77af37ed775250b8fdb4fbd16c6c297e211
Parents: a8a96ae
Author: riknoll <ri...@microsoft.com>
Authored: Fri Aug 28 17:21:41 2015 -0700
Committer: Dmitry Blotsky <dm...@gmail.com>
Committed: Tue Sep 1 11:43:21 2015 -0700
----------------------------------------------------------------------
www/static/plugins/app.js | 1 -
1 file changed, 1 deletion(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/46dda77a/www/static/plugins/app.js
----------------------------------------------------------------------
diff --git a/www/static/plugins/app.js b/www/static/plugins/app.js
index a27e5c4..592093f 100755
--- a/www/static/plugins/app.js
+++ b/www/static/plugins/app.js
@@ -415,7 +415,6 @@ var App = React.createClass({
<ul className="nav nav-justified">
<li><a href="{{ site.baseurl }}/plugins/authors.html"><span className="glyphicon glyphicon-plus"></span><i> </i>Contribute Plugins</a></li>
<li><a href="{{ site.baseurl }}/plugins/faq.html"><span className="glyphicon glyphicon-question-sign"></span><i> </i>Plugin Help</a></li>
- <li><a href="#"><span className="glyphicon glyphicon-alert"></span><i> </i>Plugin Issue Tracker</a></li>
</ul>
</div>
</div>
---------------------------------------------------------------------
To unsubscribe, e-mail: commits-unsubscribe@cordova.apache.org
For additional commands, e-mail: commits-help@cordova.apache.org
[4/4] docs commit: Added title text for the icons in plugin cards.
This closes #325.
Posted by db...@apache.org.
Added title text for the icons in plugin cards. This closes #325.
Project: http://git-wip-us.apache.org/repos/asf/cordova-docs/repo
Commit: http://git-wip-us.apache.org/repos/asf/cordova-docs/commit/358857eb
Tree: http://git-wip-us.apache.org/repos/asf/cordova-docs/tree/358857eb
Diff: http://git-wip-us.apache.org/repos/asf/cordova-docs/diff/358857eb
Branch: refs/heads/cordova-website
Commit: 358857eb37710c6a75139b7b137d33b4a2e5af18
Parents: 4fdd56b
Author: riknoll <ri...@microsoft.com>
Authored: Mon Aug 31 13:14:29 2015 -0700
Committer: Dmitry Blotsky <dm...@gmail.com>
Committed: Tue Sep 1 11:44:29 2015 -0700
----------------------------------------------------------------------
www/static/plugins/supportedplatforms.jsx | 20 +++++++++++---------
1 file changed, 11 insertions(+), 9 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/358857eb/www/static/plugins/supportedplatforms.jsx
----------------------------------------------------------------------
diff --git a/www/static/plugins/supportedplatforms.jsx b/www/static/plugins/supportedplatforms.jsx
index 9891815..cc9c6be 100755
--- a/www/static/plugins/supportedplatforms.jsx
+++ b/www/static/plugins/supportedplatforms.jsx
@@ -5,14 +5,14 @@ var SupportedPlatforms = React.createClass({
render: function() {
var keywords = this.props.keywords;
var sortedPlatforms = [
- {present:false, icon: "android"},
- {present:false, icon: "ios"},
- {present:false, icon: "windows"},
- {present:false, icon: "blackberry"},
- {present:false, icon: "ubuntu"},
- {present:false, icon: "firefox"},
- {present:false, icon: "webos"},
- {present:false, icon: "fireos"}
+ {present:false, icon: "android", alt:"Android"},
+ {present:false, icon: "ios", alt:"iOS"},
+ {present:false, icon: "windows", alt:"Windows"},
+ {present:false, icon: "blackberry", alt:"Blackberry"},
+ {present:false, icon: "ubuntu", alt:"Ubuntu"},
+ {present:false, icon: "firefox", alt:"FirefoxOS"},
+ {present:false, icon: "webos", alt:"webOS"},
+ {present:false, icon: "fireos", alt:"FireOS"}
];
var platformsSupported = [];
@@ -58,7 +58,9 @@ var SupportedPlatforms = React.createClass({
sortedPlatforms.forEach(function(platform) {
if(platform.present) {
- platformsSupported.push(<li><div className={platform.icon}></div></li>)
+ // Becuase these images are taken from a sprite sheet, we have
+ // to use title rather than alt-text
+ platformsSupported.push(<li><div className={platform.icon} title={platform.alt}></div></li>)
}
});
return (
---------------------------------------------------------------------
To unsubscribe, e-mail: commits-unsubscribe@cordova.apache.org
For additional commands, e-mail: commits-help@cordova.apache.org
[2/4] docs commit: Fixed some plugins CSS, links,
and added npmsearch credit
Posted by db...@apache.org.
Fixed some plugins CSS, links, and added npmsearch credit
Project: http://git-wip-us.apache.org/repos/asf/cordova-docs/repo
Commit: http://git-wip-us.apache.org/repos/asf/cordova-docs/commit/53f3da38
Tree: http://git-wip-us.apache.org/repos/asf/cordova-docs/tree/53f3da38
Diff: http://git-wip-us.apache.org/repos/asf/cordova-docs/diff/53f3da38
Branch: refs/heads/cordova-website
Commit: 53f3da38ea4a311f46e56e8b6fba5634993c4e8e
Parents: 46dda77
Author: riknoll <ri...@microsoft.com>
Authored: Fri Aug 28 17:53:56 2015 -0700
Committer: Dmitry Blotsky <dm...@gmail.com>
Committed: Tue Sep 1 11:43:21 2015 -0700
----------------------------------------------------------------------
www/static/css-src/_plugins.scss | 13 ++++++++++++-
www/static/plugins/app.js | 3 +++
www/static/plugins/pluginlist.jsx | 10 +++-------
3 files changed, 18 insertions(+), 8 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/53f3da38/www/static/css-src/_plugins.scss
----------------------------------------------------------------------
diff --git a/www/static/css-src/_plugins.scss b/www/static/css-src/_plugins.scss
index f2ef372..e3f11ad 100644
--- a/www/static/css-src/_plugins.scss
+++ b/www/static/css-src/_plugins.scss
@@ -101,7 +101,7 @@
*/
.plugins-results-container {
- margin-bottom:40px;
+ margin-bottom:20px;
padding:0;
}
@@ -116,6 +116,12 @@
background-color:$gray-5;
position: relative;
}
+
+.plugin-results-show-more {
+ text-align: center;
+ cursor:pointer;
+}
+
.version_and_author {
display: inline-block;
}
@@ -129,6 +135,11 @@
cursor:pointer;
}
+.plugin-search-credit {
+ margin-left: 0px;
+ margin-bottom: 5px;
+}
+
@media (min-width: 767px) {
.version_and_author {
float:right;
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/53f3da38/www/static/plugins/app.js
----------------------------------------------------------------------
diff --git a/www/static/plugins/app.js b/www/static/plugins/app.js
index 592093f..f29f7fc 100755
--- a/www/static/plugins/app.js
+++ b/www/static/plugins/app.js
@@ -441,6 +441,9 @@ var App = React.createClass({
</div>
</div>
<PluginList plugins={this.state.searchResults} />
+ <div className="row plugin-search-credit">
+ Search results powered by <a href="http://npmsearch.com/">npmsearch.com</a>
+ </div>
</div>
);
}
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/53f3da38/www/static/plugins/pluginlist.jsx
----------------------------------------------------------------------
diff --git a/www/static/plugins/pluginlist.jsx b/www/static/plugins/pluginlist.jsx
index 4d83a09..e8b8f94 100755
--- a/www/static/plugins/pluginlist.jsx
+++ b/www/static/plugins/pluginlist.jsx
@@ -39,19 +39,15 @@ var PluginList = React.createClass({
var showMore = null, visiblePlugins = [];
if (plugins.length - this.state.searchPage * PageExtensionLength > InitialPageLength) {
showMore =
- <div className="pluginCard" onClick={this.increaseSearchResults} style={{cursor: 'pointer'}}>
- <div style={{ display: 'table', width:100 + '%', minHeight: 5 + 'rem'}}>
- <div style={{ display: 'table-cell', verticalAlign: 'middle'}}>
- <div style={{textAlign: 'center'}}>Show More</div>
- </div>
- </div>
+ <div className="plugin-results-show-more" onClick={this.increaseSearchResults}>
+ Show More
</div>;
}
if (plugins.length === 0) {
return (
<div className="container plugins-results-container">
- No plugins found. Learn how to <a href="http://cordova.apache.org/docs/en/edge/guide_hybrid_plugins_index.md.html#Plugin%20Development%20Guide">create one</a>
+ No plugins found. Learn how to <a href="{{site.baseurl}}/docs/en/edge/guide/hybrid/plugins/index.html">create one</a>
</div>
);
} else {
---------------------------------------------------------------------
To unsubscribe, e-mail: commits-unsubscribe@cordova.apache.org
For additional commands, e-mail: commits-help@cordova.apache.org