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/08/27 23:02:12 UTC

[7/8] docs commit: Added unstyled content from cordova-registry-web for two of the plugins links

Added unstyled content from cordova-registry-web for two of the plugins links


Project: http://git-wip-us.apache.org/repos/asf/cordova-docs/repo
Commit: http://git-wip-us.apache.org/repos/asf/cordova-docs/commit/2f552232
Tree: http://git-wip-us.apache.org/repos/asf/cordova-docs/tree/2f552232
Diff: http://git-wip-us.apache.org/repos/asf/cordova-docs/diff/2f552232

Branch: refs/heads/cordova-website
Commit: 2f5522326897d6460f8b74df6ec77bc8df6ea829
Parents: eed94c8
Author: riknoll <ri...@microsoft.com>
Authored: Wed Aug 26 10:53:12 2015 -0700
Committer: Dmitry Blotsky <dm...@gmail.com>
Committed: Thu Aug 27 13:58:27 2015 -0700

----------------------------------------------------------------------
 www/plugins/authors.html  | 50 ++++++++++++++++++++++++++++++++++++++++++
 www/plugins/faq.html      | 31 ++++++++++++++++++++++++++
 www/static/plugins/app.js |  4 ++--
 3 files changed, 83 insertions(+), 2 deletions(-)
----------------------------------------------------------------------


http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/2f552232/www/plugins/authors.html
----------------------------------------------------------------------
diff --git a/www/plugins/authors.html b/www/plugins/authors.html
new file mode 100644
index 0000000..896b818
--- /dev/null
+++ b/www/plugins/authors.html
@@ -0,0 +1,50 @@
+---
+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="/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/2f552232/www/plugins/faq.html
----------------------------------------------------------------------
diff --git a/www/plugins/faq.html b/www/plugins/faq.html
new file mode 100644
index 0000000..d967467
--- /dev/null
+++ b/www/plugins/faq.html
@@ -0,0 +1,31 @@
+---
+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>How can I identify official core plugins?</h2>
+  <p>Core plugins have a blue strip on the left side of their card.</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="/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="/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/2f552232/www/static/plugins/app.js
----------------------------------------------------------------------
diff --git a/www/static/plugins/app.js b/www/static/plugins/app.js
index e51f446..1f61279 100755
--- a/www/static/plugins/app.js
+++ b/www/static/plugins/app.js
@@ -413,8 +413,8 @@ var App = React.createClass({
                         </div>
                             <div className="plugins_links">
                                     <ul className="nav nav-justified">
-                                    <li><a href="#"><span className="glyphicon glyphicon-plus"></span><i>&nbsp;</i>Contribute Plugins</a></li>
-                                    <li><a href="#"><span className="glyphicon glyphicon-question-sign"></span><i>&nbsp;</i>Plugin Help</a></li>
+                                    <li><a href="authors.html"><span className="glyphicon glyphicon-plus"></span><i>&nbsp;</i>Contribute Plugins</a></li>
+                                    <li><a href="faq.html"><span className="glyphicon glyphicon-question-sign"></span><i>&nbsp;</i>Plugin Help</a></li>
                                     <li><a href="#"><span className="glyphicon glyphicon-alert"></span><i>&nbsp;</i>Plugin Issue Tracker</a></li>
                                     </ul>
                             </div>


---------------------------------------------------------------------
To unsubscribe, e-mail: commits-unsubscribe@cordova.apache.org
For additional commands, e-mail: commits-help@cordova.apache.org