cordova-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From mura...@apache.org
Subject cordova-registry-web git commit: correctly merge CB-9194
Date Wed, 17 Jun 2015 19:39:25 GMT
Repository: cordova-registry-web
Updated Branches:
  refs/heads/master d9349eea7 -> c73a032dc


correctly merge CB-9194

close #13


Project: http://git-wip-us.apache.org/repos/asf/cordova-registry-web/repo
Commit: http://git-wip-us.apache.org/repos/asf/cordova-registry-web/commit/c73a032d
Tree: http://git-wip-us.apache.org/repos/asf/cordova-registry-web/tree/c73a032d
Diff: http://git-wip-us.apache.org/repos/asf/cordova-registry-web/diff/c73a032d

Branch: refs/heads/master
Commit: c73a032dc050bb6cf79dc434437e5f93e195f350
Parents: d9349ee
Author: Murat Sutunc <sutunc@gmail.com>
Authored: Tue Jun 16 16:31:21 2015 -0700
Committer: Murat Sutunc <sutunc@gmail.com>
Committed: Wed Jun 17 12:38:26 2015 -0700

----------------------------------------------------------------------
 npm-search/developers.html | 74 +++++++++++++++++++++++++++++++++++++++++
 npm-search/faq.html        | 19 +++++------
 npm-search/index.html      |  2 ++
 3 files changed, 84 insertions(+), 11 deletions(-)
----------------------------------------------------------------------


http://git-wip-us.apache.org/repos/asf/cordova-registry-web/blob/c73a032d/npm-search/developers.html
----------------------------------------------------------------------
diff --git a/npm-search/developers.html b/npm-search/developers.html
new file mode 100644
index 0000000..59f6e1c
--- /dev/null
+++ b/npm-search/developers.html
@@ -0,0 +1,74 @@
+<!DOCTYPE html>
+<html>
+  <head>
+    <meta http-equiv='Content-type' content='text/html; charset=utf-8'>
+    <title>Cordova Search Website</title>
+    <link rel="stylesheet" href="build/styles.css" />
+  </head>
+
+  <body>
+    <div id="header">
+      <div class="wrap">
+          <a class="logo" href="//cordova.apache.org/"></a>
+          <div class="menu">
+              <a href="index.html">Home</a>
+              <a href="developers.html">Developers</a>
+              <a href="faq.html">FAQ</a>
+          </div>
+          <form class="menu-dropdown">
+              <select onchange="location = this.options[this.selectedIndex].value;">
+                  <option value="index.html">Home</option>
+                  <option value="developers.html">Developers</option>
+                  <option value="faq.html">FAQ</option>
+              </select>
+          </form>
+      </div>
+      <div class="shadow"></div>
+    </div>
+    <div class="header-placeholder"></div>
+    <div class="wrap">
+      <h2 class="icon icon-about">npm Plugin Search for Plugin Developers</h2>
+      <h4>How do I add a new plugin to Plugin Search?</h4>
+      <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>
+      <h4>How can I tag supported platforms for my plugin?</h4>
+      <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>
+      <h4>My plugin is in plugins.cordova.io but I want to publish to npm. How do I
do that?</h4>
+      <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>
+      <h4>Are there any additional documents to assist me with plugins?</h4>
+      <p>Yes there are. Please take a look at <a href="http://cordova.apache.org/docs/en/edge/guide_hybrid_plugins_index.md.html#Plugin%20Development%20Guide"
target="_blank">Plugin Development Guide</a> for a more detailed guide.</p>
+      <h4>I don't like X. How can I help improve the website?</h4>
+      <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>
+  </body>
+</html>

http://git-wip-us.apache.org/repos/asf/cordova-registry-web/blob/c73a032d/npm-search/faq.html
----------------------------------------------------------------------
diff --git a/npm-search/faq.html b/npm-search/faq.html
index 08b87fd..bb55b52 100644
--- a/npm-search/faq.html
+++ b/npm-search/faq.html
@@ -12,11 +12,16 @@
           <a class="logo" href="//cordova.apache.org/"></a>
           <div class="menu">
               <a href="index.html">Home</a>
+<<<<<<< HEAD
+=======
+              <a href="developers.html">Developers</a>
+>>>>>>> CB-9194 Created faq page and added header
               <a href="faq.html">FAQ</a>
           </div>
           <form class="menu-dropdown">
               <select onchange="location = this.options[this.selectedIndex].value;">
                   <option value="index.html">Home</option>
+                  <option value="developers.html">Developers</option>
                   <option value="faq.html">FAQ</option>
               </select>
           </form>
@@ -34,18 +39,8 @@
       <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>
       <h4>How do I know which platforms are supported for a plugin?</h4>
       <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>
-      <h4>How can I find official core plugins?</h4>
+      <h4>How can I identify official core plugins?</h4>
       <p>Core plugins have a blue strip on the left side of their card.</p>
-      <h4>How do I add a new plugin to Plugin Search?</h4>
-      <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>
-      <h4>How can I tag supported platforms for my plugin?</h4>
-      <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>
       <h4>Can I still download plugins if I'm using Cordova CLI 4.3.0 or lower?</h4>
       <p>Yes! You can use Cordova Plugins from the <a href="http://plugins.cordova.io/"
target="_blank">old plugin registry</a>.</p>
       <h4>What’s happening to the old plugin registry?</h4>
@@ -54,6 +49,8 @@
       <li>  Read-only after July 15th</li>
       <li>  End of support after October 15th</li>
       </ul>
+      <h4>Are there any additional documents to assist me with plugins?</h4>
+      <p>Yes there are. Please take a look at <a href="http://cordova.apache.org/docs/en/edge/guide_cli_index.md.html#The%20Command-Line%20Interface_add_plugin_features"
target="_blank">Add Plugin Features</a> for a more detailed guide.</p>
       <h4>I don't like X. How can I help improve the website?</h4>
       <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-registry-web/blob/c73a032d/npm-search/index.html
----------------------------------------------------------------------
diff --git a/npm-search/index.html b/npm-search/index.html
index 0f0cd50..7469171 100644
--- a/npm-search/index.html
+++ b/npm-search/index.html
@@ -12,11 +12,13 @@
           <a class="logo" href="//cordova.apache.org/"></a>
           <div class="menu">
               <a href="index.html">Home</a>
+              <a href="developers.html">Developers</a>
               <a href="faq.html">FAQ</a>
           </div>
           <form class="menu-dropdown">
               <select onchange="location = this.options[this.selectedIndex].value;">
                   <option value="index.html">Home</option>
+                  <option value="developers.html">Developers</option>
                   <option value="faq.html">FAQ</option>
               </select>
           </form>


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


Mime
View raw message