http://git-wip-us.apache.org/repos/asf/incubator-usergrid/blob/ec2b3e4f/website/publish/docs/contributecode/index.html ---------------------------------------------------------------------- diff --git a/website/publish/docs/contributecode/index.html b/website/publish/docs/contributecode/index.html deleted file mode 100644 index 2703b5a..0000000 --- a/website/publish/docs/contributecode/index.html +++ /dev/null @@ -1,302 +0,0 @@ -<!DOCTYPE html> -<html lang="en"> - -<head> - <meta charset="utf-8"> - <title>Apache Usergrid (incubating) â Contribute Code</title> - <meta http-equiv="x-ua-compatible" content="ie=edge" /> - <meta name="viewport" content="width=device-width, initial-scale=1, minimum-scale=1, maximum-scale=1" /> - <meta name="keywords" content="Apache Usergrid, Usergrid, BaaS, Backend-as-a-Service"> - <meta name="description" content="An open-source Backend-as-a-Service stack for web & mobile applications, based on RESTful APIs." /> - <meta property="og:title" content="Apache Usergrid" /> - <meta property="og:description" content="An open-source Backend-as-a-Service stack for web & mobile applications, based on RESTful APIs." /> - <!-- Loading Typekit --> - <script type="text/javascript" src="//use.typekit.net/ddl7izx.js"></script> - <script type="text/javascript">try{Typekit.load();}catch(e){}</script> - <!-- Loading Bootstrap --> - <link href="/bootstrap/bootstrap.min.css" rel="stylesheet" type='text/css'> - <link href="/css/bootflat.css" rel="stylesheet" type='text/css'> - <link href="/css/usergrid-site.css" rel="stylesheet" type='text/css'> - <link href="https://fonts.googleapis.com/css?family=Open+Sans:200,400,500,300,600,800,700,400italic,600italic,700italic,800italic,300italic"; rel="stylesheet" type="text/css"> - <link href="/css/font-awesome.min.css" rel="stylesheet" type='text/css'> - - - - <!-- HTML5 shim, for IE6-8 support of HTML5 elements. All other JS at the end of file. --> - <!--[if lt IE 9]> - <script src="js/html5shiv.js"></script> - <script src="js/respond.min.js"></script> - <![endif]--> -</head> -<body> - - <header class="navbar navbar-inverse navbar-fixed-top bf-docs-nav secondary" role="banner"> - <div class="container"> - <div class="navbar-header"> - <button class="navbar-toggle" type="button" data-toggle="collapse" data-target=".bf-navbar-collapse"> - <span class="sr-only">Toggle navigation</span> - <span class="icon-bar"></span> - <span class="icon-bar"></span> - <span class="icon-bar"></span> - </button> - <a href="/" class="navbar-brand"> - <img id="home-logo" src="/img/apache_usergrid_logo_white_small.png" /> - </a> - </div> - <nav class="collapse navbar-collapse bf-navbar-collapse" role="navigation"> - <ul class="nav navbar-nav navbar-right"> - <li class=""><a href="/community/"><span class="icns icon-group"></span></a></li> - <li class="active"><a href="/docs/"><span class="icns icon-book"></span></a></li> - <li><a href="http://github.com/usergrid/usergrid"; target="_blank"><span class="icns icon-github-sign"></span></a></li> - <!--<li><a href="https://trello.com/b/exQmJIOn/usergrid"; target="_blank"><span class="icns icon-trello"></span></a></li>--> - <li><a href="https://issues.apache.org/jira/browse/USERGRID"; target="_blank"><span class="icns icon-bug"></span></a></li> - <li><a href="http://stackoverflow.com/search?q=usergrid"; target="_blank"><span class="icns icon-stackexchange"></span></a></li> - <li><a href="http://webchat.freenode.net/?channels=%23usergrid&uio=d4"; target="_blank"><span class="icns icon-comments"></span></a></li> - <!--<li><a href="https://groups.google.com/forum/#!forum/usergrid"; target="_blank"><span class="icns icon-envelope"></span></a></li>--> - <li><a href="https://twitter.com/usergrid"; target="_blank"><span class="icns icon-twitter"></span></a></li> - </ul> - </nav> - </div> - </header> - - -<div class="container bf-docs-container"> - <div class="row"> - <div class="col-md-3"> - <div class="bf-sidebar hidden-print" role="complementary"> - <ul class="nav nav-list"> - <li><a href="/docs/getting-up-and-running-locally/">Getting Up & Running Locally</a></li> - <li><a href="https://github.com/usergrid/usergrid/tree/master/ugc#usergrid-command-line-ugc";><code>ugc</code> â the Command-line Client</a></li> - - <li class="nav-header"><span>Concepts</span></li> - <li> - <a href="/docs/organizations-admins/">Organizations & Admins</a> - <ul> - <li> - <a href="/docs/applications/">Applications</a> - <ul> - <li><a href="/docs/roles-and-permissions/">Roles & Permissions</a></li> - <!--<li><a href="#">Queues</a></li>--> - <li><a href="/docs/events-and-counters/">Events & Counters</a></li> - <li><a href="/docs/relationships/">Relationships (Joins)</a></li> - <li> - <a href="/docs/collections">Collections</a> - <ul> - <li><a href="/docs/query-language/">Query Language</a></li> - <li><a href="/docs/users-devices/">Users & Devices</a></li> - <li><a href="/docs/groups/">Groups</a></li> - <li><a href="/docs/activities/">Activities</a></li> - <li><a href="/docs/assets/">Assets</a></li> - </ul> - </li> - </ul> - </li> - </ul> - </li> - - - <li class="nav-header"><span>Usage</span></li> - <!-- <li>REST API â Coming Soon</li> --> - <li><a class="icns-apple" href="https://github.com/usergrid/usergrid/tree/master/sdks/ios";>iOS SDK</a></li> - <li><a class="icns-android" href="https://github.com/usergrid/usergrid/tree/master/sdks/android";>Android SDK</a></li> - <li><a class="icns-html5" href="">HTML5 / JavaScript SDK</a></li> - <li><a class="icns-windows" href="https://github.com/usergrid/usergrid/tree/master/sdks/dotnet";>Windows 8 / Windows Phone / .net SDK</a></li> - <li><a href="https://github.com/usergrid/usergrid/tree/master/sdks/nodejs";>Node.js module</a></li> - <li><a href="https://github.com/usergrid/usergrid/tree/master/sdks/ruby";>Ruby gem</a></li> - <li><a href="https://github.com/usergrid/usergrid/tree/master/sdks/ruby-on-rails";>Ruby on Rails gem</a></li> - <li><a href="https://github.com/usergrid/usergrid/tree/master/sdks/php";>PHP library</a></li> - <li><a href="https://github.com/usergrid/usergrid/tree/master/sdks/java";>Java library</a></li> - - <!--<li class="nav-header"><span>Internals</span></li> - <li>Design & Goals â Coming Soon</li> - <li>Java Architecture â Coming Soon</li> - <li>Cassandra Schema â Coming Soon</li>--> - - <li class="nav-header"><span>Operations</span></li> - <!--<li>Deploying â Coming Soon</li>--> - <!-- <li>Monitoring â Coming Soon</li> --> - <li><a href="/docs/upgrading/">Upgrading</a></li> - <!-- <li>Security â Coming Soon</li> --> - - <li class="nav-header"><span>We need your help!</span></li> - <li><a href="/docs/contribute-code">How to contribute code</a></li> - <li><a href="/docs/contribute-docs">How to contribute docs</a></li> - </ul> - </div> - </div> - - <div class="col-md-9 main-article" role="main"> - <div class="page-article"> - <div class="page-header"> - <h1>Contribute Code</h1> - <small><a target="_blank" href="https://github.com/usergrid/website/blob/master/content/docs/contributecode.md";>contribute to this article on github</a></small> - </div> - <div class="toc"> - <ul> -<li><a href="#how-to-contribute-code">How to Contribute Code</a></li> -<li><a href="#for-small-fixes">For small fixes</a></li> -<li><a href="#for-big-changes">For big changes</a></li> -</ul> -</div> -<h2 id="how-to-contribute-code">How to Contribute Code</h2> -<p>Usergrid is an open source project developed by folks like you. Anybody can contribute, but we do have some rules in place and we do like to review and discuss changes in public on our mailing lists and on our Github account.</p> -<p>We use Github as our code review and collaboration system and we use the Apache Git repo as our official repository of record, thatâs the code that we release when we make an official release.</p> -<p>We have two slightly different procedures for small fixes and for more significant changes.</p> -<h2 id="for-small-fixes">For small fixes</h2> -<p>We welcome small âdrive-byâ contributions from impatient developers! If you just have a small fix that you want to contribute then these are the steps you should follow to get your changes into Usergrid.</p> -<ul> -<li> -<strong>Fork our Github repo</strong>. usergrid/usergrid.</li> -<li> -<strong>Make your changes</strong> in your fork.</li> -<li> -<strong>Submit a pull request</strong> against usergrid/usergrid. In the description be sure to note âI am contributing code under the terms of the Apache Software License.â</li> -<li> -<strong>Wait a bit</strong> for your Pull Request to be reviewed and merged.</li> -<li> -<strong>Done!</strong> your changes will now be committed to the official Apache Git repo.</li> -</ul><h2 id="for-big-changes">For big changes</h2> -<p>We love more significant contributions of code as well. Larger contributions do require more review and a couple of additional steps. If you have a larger contribution then these are the steps you should follow:</p> -<ul> -<li> -<strong>Sign up.</strong> This is a pain, to be sure, but it only has to happen once. -<ul> -<li> -<strong>Get a Github account</strong> if you do not already have one.</li> -<li> -<strong>Send in your signed ICLA form</strong>. Apache cannot accept contributions without this.</li> -<li> -<strong>Sign up for a JIRA account</strong>. We track our work (and bugs) using JIRA and ideally, we would like every Pull Request that is submitted on Github to reference a JIRA issue.</li> -<li> -<strong>Sign up for the dev mailing list</strong>. All decisions about the Usergrid project are recorded on mailing lists and the dev mailing list is the place for discussions about development.</li> -</ul> -</li> -<li> -<strong>Discuss your changes</strong> on the dev mailing list. This step is optional, but can greatly increase your chances for getting your changes into Usergrid. You might get some good feedback and design tips.</li> -<li> -<strong>Fork usergrid/usergrid</strong>. Make your copy of Usergrid. This is where you will work.</li> -<li> -<strong>Make your changes</strong> in your fork and donât forget to create tests for your changes.</li> -<li> -<strong>Submit a Pull Request</strong> to usergrid/usergrid and in the description reference the URL of your JIRA issue.</li> -<li> -<strong>Add a comment to the JIRA issue</strong> referencing the Pull Request, and the URL of that request.</li> -<li> -<strong>Announce your Pull Request</strong>. If your request seems to be getting ignored, you might want to prompby sending an email to the dev list and as for a review.</li> -<li> -<strong>Wait a bit</strong> for your Pull Request to be reviewed and merged.</li> -<li> -<strong>Done!</strong> your changes will now be committed to the official Apache Git repo.</li> -</ul> - </div> - </div> - </div> - <div class="row"> - <div class="col-md-3"></div> - <div class="col-md-9"> - <div class="github-callout"> - <strong>Questions?</strong> Please do <a href="/community">ask on the mailing-lists</a>!<br/> - <strong>Found an error?</strong> Weâd greatly appreciate a pull request about <a target="_blank" href="https://github.com/usergrid/website/blob/master/content/docs/contributecode.md";>this article on github</a>.</div> - </div> - </div> -</div> - - -<footer class="bf-footer" role="contentinfo"> - <div class="container"> - <div class="row"> - <div class="col-md-2"> - <ul class="nav nav-list"> - <li class="nav-header"><a href="/">Home</a></li> - <li class="nav-header"><a href="/community/">Community</a></li> - <li><a href="/community/#events">Events</a></li> - <li><a href="/community/#mailing-lists">Mailing Lists</a></li> - <li><a href="/community/#deployments">Deployments</a></li> - <li><a href="/community/#committers">Commiters</a></li> - <!-- <li class="nav-header"><a href="#">Docs</a></li> --> - </ul> - </div> - <div class="col-md-2"> - <ul class="nav nav-list"> - <li class="nav-header"><a href="https://github.com/usergrid/usergrid/"; target="_blank">Code</a></li> - <li><a href="https://github.com/usergrid/usergrid/blob/master/stack"; target="_blank">Server Stack</a></li> - <li><a href="https://github.com/usergrid/usergrid/blob/master/portal"; target="_blank">Admin Portal</a></li> - <li><a href="https://github.com/usergrid/usergrid/blob/master/ugc"; target="_blank">ugc command line</a></li> - <li><a href="https://github.com/usergrid/usergrid/blob/master/sdks/ios"; target="_blank">iOS SDK</a></li> - <li><a href="https://github.com/usergrid/usergrid/blob/master/sdks/android"; target="_blank">Android SDK</a></li> - <li><a href="https://github.com/usergrid/usergrid/blob/master/sdks/html5-javascript"; target="_blank">HTML5/JS SDK</a></li> - <li><a href="https://github.com/usergrid/usergrid/blob/master/sdks/nodejs"; target="_blank">node.js module</a></li> - <li><a href="https://github.com/usergrid/usergrid/blob/master/sdks/ruby-on-rails"; target="_blank">Ruby on Rails gem</a></li> - <li><a href="https://github.com/usergrid/usergrid/blob/master/sdks/ruby"; target="_blank">Ruby gem</a></li> - <li><a href="https://github.com/usergrid/usergrid/blob/master/sdks/php"; target="_blank">PHP SDK</a></li> - <li><a href="https://github.com/usergrid/usergrid/blob/master/sdks/java"; target="_blank">Java SDK</a></li> - <li><a href="https://github.com/usergrid/usergrid/blob/master/sdks/dotnet"; target="_blank">.NET / Windows SDK</a></li> - </ul> - </div> - <div class="col-md-2"> - <ul class="nav nav-list"> - <li class="nav-header">Resources</li> - <li><a href="http://github.com/usergrid/usergrid"; target="_blank">GitHub Code</a></li> - <li><a href="https://issues.apache.org/jira/browse/USERGRID"; target="_blank">JIRA Bug Tracker</a></li> - <li><a href="http://stackoverflow.com/search?q=usergrid"; target="_blank">StackOverflow</a></li> - <li><a href="http://webchat.freenode.net/?channels=%23usergrid&uio=d4";>IRC</a></li> - <li><a href="https://twitter.com/usergrid"; target="_blank">Twitter</a></li> - <li><a href="http://incubator.apache.org/projects/usergrid.html"; target="_blank">Podling Listing</a></li> - <li><a href="https://github.com/usergrid/usergrid/blob/master/stack#requirements"; target="_blank">Getting Started</a></li> - <li><a href="https://cwiki.apache.org/confluence/display/usergrid/GitHub+Based+Contribution+Workflow"; target="_blank">Contribution Guidelines</a></li> - </ul> - </div> - <div class="col-md-2"> - <ul class="nav nav-list"> - <li class="nav-header">Apache</li> - <li><a href="http://www.apache.org/licenses/"; target="_blank">License</a></li> - <li><a href="http://www.apache.org/foundation/sponsorship.html"; target="_blank">Sponsorship</a></li> - <li><a href="http://www.apache.org/foundation/thanks.html"; target="_blank">Thanks</a></li> - <li><a href="http://www.apache.org/security/";>Security</a></li> - <li><a href="http://www.apache.org/"; target="_blank">Apache Foundation</a></li> - </ul> - </div> - <div class="col-md-4"> - <a class="twitter-timeline" href="https://twitter.com/search?q=%23usergrid"; data-widget-id="401499136807038976" data-related="usergrid" height="400px" style="overflow:hidden">Tweets about "usergrid"</a> - <script>!function(d,s,id){var js,fjs=d.getElementsByTagName(s)[0],p=/^http:/.test(d.location)?'http':'https';if(!d.getElementById(id)){js=d.createElement(s);js.id=id;js.src=p+"://platform.twitter.com/widgets.js";fjs.parentNode.insertBefore(js,fjs);}}(document,"script","twitter-wjs");</script> - </div> - <!-- - <div class="col-md-4"> - <div class="input-group form-search"> - <input type="text" class="form-control search-query"> - <span class="input-group-btn"> - <button type="submit" class="btn btn-primary" data-type="last">Search</button> - </span> - </div> - </div> --> - </div> - <div class="row"> - <div id="copyright"> - <img src="/img/egg-logo.png" /><br/><br/> - <p>Apache Usergrid is an effort undergoing incubation at The Apache Software Foundation (ASF), sponsored by the Apache Incubator PMC. Incubation is required of all newly accepted projects until a further review indicates that the infrastructure, communications, and decision making process have stabilized in a manner consistent with other successful ASF projects. While incubation status is not necessarily a reflection of the completeness or stability of the code, it does indicate that the project has yet to be fully endorsed by the ASF.</p> - <p>Copyright © 2013 The Apache Software Foundation, Licensed under the Apache License, Version 2.0.<br> - Apache and the Apache feather logos are trademarks of The Apache Software Foundation.</p> - <p class="credits">Site designed & assembled with love by <a href="https://github.com/ryuneeee";>@ryuneeee</a> + <a href="https://github.com/realbeast";>@realbeast</a> + <a href="https://twitter.com/timanglade";>@timanglade</a>.</p> - </div> - </div> - </div> -</footer> - -<script type="text/javascript" src="/js/head.js"></script> -<script type="text/javascript"> - head.js("/js/jquery-1.10.1.min.js", "/js/bootstrap.min.js", "/js/usergrid-site.js"); -</script> -<script> - (function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){ - (i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o), - m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m) - })(window,document,'script','//www.google-analytics.com/analytics.js','ga'); - - ga('create', 'UA-45815079-1', 'apache.org'); - ga('send', 'pageview'); - -</script> - - -</body> -</html>
http://git-wip-us.apache.org/repos/asf/incubator-usergrid/blob/ec2b3e4f/website/publish/docs/contributing/index.html ---------------------------------------------------------------------- diff --git a/website/publish/docs/contributing/index.html b/website/publish/docs/contributing/index.html deleted file mode 100644 index fdf5669..0000000 --- a/website/publish/docs/contributing/index.html +++ /dev/null @@ -1,239 +0,0 @@ -<!DOCTYPE html> -<html lang="en"> - -<head> - <meta charset="utf-8"> - <title>Apache Usergrid (incubating) â Contributing</title> - <meta http-equiv="x-ua-compatible" content="ie=edge" /> - <meta name="viewport" content="width=device-width, initial-scale=1, minimum-scale=1, maximum-scale=1" /> - <meta name="keywords" content="Apache Usergrid, Usergrid, BaaS, Backend-as-a-Service"> - <meta name="description" content="An open-source Backend-as-a-Service stack for web & mobile applications, based on RESTful APIs." /> - <meta property="og:title" content="Apache Usergrid" /> - <meta property="og:description" content="An open-source Backend-as-a-Service stack for web & mobile applications, based on RESTful APIs." /> - <!-- Loading Typekit --> - <script type="text/javascript" src="//use.typekit.net/ddl7izx.js"></script> - <script type="text/javascript">try{Typekit.load();}catch(e){}</script> - <!-- Loading Bootstrap --> - <link href="/bootstrap/bootstrap.min.css" rel="stylesheet" type='text/css'> - <link href="/css/bootflat.css" rel="stylesheet" type='text/css'> - <link href="/css/usergrid-site.css" rel="stylesheet" type='text/css'> - <link href="https://fonts.googleapis.com/css?family=Open+Sans:200,400,500,300,600,800,700,400italic,600italic,700italic,800italic,300italic"; rel="stylesheet" type="text/css"> - <link href="/css/font-awesome.min.css" rel="stylesheet" type='text/css'> - - - - <!-- HTML5 shim, for IE6-8 support of HTML5 elements. All other JS at the end of file. --> - <!--[if lt IE 9]> - <script src="js/html5shiv.js"></script> - <script src="js/respond.min.js"></script> - <![endif]--> -</head> -<body> - - <header class="navbar navbar-inverse navbar-fixed-top bf-docs-nav secondary" role="banner"> - <div class="container"> - <div class="navbar-header"> - <button class="navbar-toggle" type="button" data-toggle="collapse" data-target=".bf-navbar-collapse"> - <span class="sr-only">Toggle navigation</span> - <span class="icon-bar"></span> - <span class="icon-bar"></span> - <span class="icon-bar"></span> - </button> - <a href="/" class="navbar-brand"> - <img id="home-logo" src="/img/apache_usergrid_logo_white_small.png" /> - </a> - </div> - <nav class="collapse navbar-collapse bf-navbar-collapse" role="navigation"> - <ul class="nav navbar-nav navbar-right"> - <li class=""><a href="/community/"><span class="icns icon-group"></span></a></li> - <li class="active"><a href="/docs/"><span class="icns icon-book"></span></a></li> - <li><a href="http://github.com/usergrid/usergrid"; target="_blank"><span class="icns icon-github-sign"></span></a></li> - <!--<li><a href="https://trello.com/b/exQmJIOn/usergrid"; target="_blank"><span class="icns icon-trello"></span></a></li>--> - <li><a href="https://issues.apache.org/jira/browse/USERGRID"; target="_blank"><span class="icns icon-bug"></span></a></li> - <li><a href="http://stackoverflow.com/search?q=usergrid"; target="_blank"><span class="icns icon-stackexchange"></span></a></li> - <li><a href="http://webchat.freenode.net/?channels=%23usergrid&uio=d4"; target="_blank"><span class="icns icon-comments"></span></a></li> - <!--<li><a href="https://groups.google.com/forum/#!forum/usergrid"; target="_blank"><span class="icns icon-envelope"></span></a></li>--> - <li><a href="https://twitter.com/usergrid"; target="_blank"><span class="icns icon-twitter"></span></a></li> - </ul> - </nav> - </div> - </header> - - -<div class="container bf-docs-container"> - <div class="row"> - <div class="col-md-3"> - <div class="bf-sidebar hidden-print" role="complementary"> - <ul class="nav nav-list"> - <li><a href="/docs/getting-up-and-running-locally/">Getting Up & Running Locally</a></li> - <li><a href="https://github.com/usergrid/usergrid/tree/master/ugc#usergrid-command-line-ugc";><code>ugc</code> â the Command-line Client</a></li> - - <li class="nav-header"><span>Concepts</span></li> - <li> - <a href="/docs/organizations-admins/">Organizations & Admins</a> - <ul> - <li> - <a href="/docs/applications/">Applications</a> - <ul> - <li><a href="/docs/roles-and-permissions/">Roles & Permissions</a></li> - <!--<li><a href="#">Queues</a></li>--> - <li><a href="/docs/events-and-counters/">Events & Counters</a></li> - <li><a href="/docs/relationships/">Relationships (Joins)</a></li> - <li> - <a href="/docs/collections">Collections</a> - <ul> - <li><a href="/docs/query-language/">Query Language</a></li> - <li><a href="/docs/users-devices/">Users & Devices</a></li> - <li><a href="/docs/groups/">Groups</a></li> - <li><a href="/docs/activities/">Activities</a></li> - <li><a href="/docs/assets/">Assets</a></li> - </ul> - </li> - </ul> - </li> - </ul> - </li> - - - <li class="nav-header"><span>Usage</span></li> - <li>REST API â Coming Soon</li> - <li><a class="icns-apple" href="https://github.com/usergrid/usergrid/tree/master/sdks/ios";>iOS SDK</a></li> - <li><a class="icns-android" href="https://github.com/usergrid/usergrid/tree/master/sdks/android";>Android SDK</a></li> - <li><a class="icns-html5" href="">HTML5 / JavaScript SDK</a></li> - <li><a class="icns-windows" href="https://github.com/usergrid/usergrid/tree/master/sdks/dotnet";>Windows 8 / Windows Phone / .net SDK</a></li> - <li><a href="https://github.com/usergrid/usergrid/tree/master/sdks/nodejs";>Node.js module</a></li> - <li><a href="https://github.com/usergrid/usergrid/tree/master/sdks/ruby";>Ruby gem</a></li> - <li><a href="https://github.com/usergrid/usergrid/tree/master/sdks/ruby-on-rails";>Ruby on Rails gem</a></li> - <li><a href="https://github.com/usergrid/usergrid/tree/master/sdks/php";>PHP library</a></li> - <li><a href="https://github.com/usergrid/usergrid/tree/master/sdks/java";>Java library</a></li> - - <li class="nav-header"><span>Internals</span></li> - <li>Design & Goals â Coming Soon</li> - <li>Java Architecture â Coming Soon</li> - <li>Cassandra Schema â Coming Soon</li> - <li><a href="/docs/contributing/">Contributing</a></li> - - <li class="nav-header"><span>Operations</span></li> - <li>Deploying â Coming Soon</li> - <li>Monitoring â Coming Soon</li> - <li><a href="/docs/upgrading/">Upgrading</a></li> - <li>Security â Coming Soon</li> - </ul> - </div> - </div> - - <div class="col-md-9 main-article" role="main"> - <div class="page-article"> - <div class="page-header"> - <h1>Contributing</h1> - <small><a target="_blank" href="https://github.com/usergrid/website/blob/master/content/docs/contributing.md";>contribute to this article on github</a></small> - </div> - <div class="toc"> - -</div> -<p>We welcome all contributions! If you want to submit code, please submit a pull request to <a href="https://github.com/usergrid/usergrid/";>usergrid/usergrid</a>, using a <a href="http://git-scm.com/book/en/Git-Branching-Branching-Workflows";>topic branch</a>.</p> -<p>Weâd prefer if your commit messages referenced the issue at hand (if applicable). We donât have particular guidelines for commit messages but we appreciate branch names that observe the following format: <code>issue#-singleworddescription</code> (i.e. <code>325-twitter</code>) or just a single word if no issue exists on the topic. Thanks!</p> - </div> - </div> - </div> - <div class="row"> - <div class="col-md-3"></div> - <div class="col-md-9"> - <div class="github-callout"> - <strong>Questions?</strong> Please do <a href="/community">ask on the mailing-lists</a>!<br/> - <strong>Found an error?</strong> Weâd greatly appreciate a pull request about <a target="_blank" href="https://github.com/usergrid/website/blob/master/content/docs/contributing.md";>this article on github</a>.</div> - </div> - </div> -</div> - - -<footer class="bf-footer" role="contentinfo"> - <div class="container"> - <div class="row"> - <div class="col-md-2"> - <ul class="nav nav-list"> - <li class="nav-header"><a href="/">Home</a></li> - <li class="nav-header"><a href="/community/">Community</a></li> - <li><a href="/community/#events">Events</a></li> - <li><a href="/community/#mailing-lists">Mailing Lists</a></li> - <li><a href="/community/#deployments">Deployments</a></li> - <li><a href="/community/#committers">Commiters</a></li> - <!-- <li class="nav-header"><a href="#">Docs</a></li> --> - </ul> - </div> - <div class="col-md-2"> - <ul class="nav nav-list"> - <li class="nav-header"><a href="https://github.com/usergrid/usergrid/"; target="_blank">Code</a></li> - <li><a href="https://github.com/usergrid/usergrid/blob/master/stack"; target="_blank">Server Stack</a></li> - <li><a href="https://github.com/usergrid/usergrid/blob/master/portal"; target="_blank">Admin Portal</a></li> - <li><a href="https://github.com/usergrid/usergrid/blob/master/ugc"; target="_blank">ugc command line</a></li> - <li><a href="https://github.com/usergrid/usergrid/blob/master/sdks/ios"; target="_blank">iOS SDK</a></li> - <li><a href="https://github.com/usergrid/usergrid/blob/master/sdks/android"; target="_blank">Android SDK</a></li> - <li><a href="https://github.com/usergrid/usergrid/blob/master/sdks/html5-javascript"; target="_blank">HTML5/JS SDK</a></li> - <li><a href="https://github.com/usergrid/usergrid/blob/master/sdks/nodejs"; target="_blank">node.js module</a></li> - <li><a href="https://github.com/usergrid/usergrid/blob/master/sdks/ruby-on-rails"; target="_blank">Ruby on Rails gem</a></li> - <li><a href="https://github.com/usergrid/usergrid/blob/master/sdks/ruby"; target="_blank">Ruby gem</a></li> - <li><a href="https://github.com/usergrid/usergrid/blob/master/sdks/php"; target="_blank">PHP SDK</a></li> - <li><a href="https://github.com/usergrid/usergrid/blob/master/sdks/java"; target="_blank">Java SDK</a></li> - <li><a href="https://github.com/usergrid/usergrid/blob/master/sdks/dotnet"; target="_blank">.NET / Windows SDK</a></li> - </ul> - </div> - <div class="col-md-2"> - <ul class="nav nav-list"> - <li class="nav-header">Resources</li> - <li><a href="http://github.com/usergrid/usergrid"; target="_blank">GitHub Code</a></li> - <li><a href="https://issues.apache.org/jira/browse/USERGRID"; target="_blank">JIRA Bug Tracker</a></li> - <li><a href="http://stackoverflow.com/search?q=usergrid"; target="_blank">StackOverflow</a></li> - <li><a href="http://webchat.freenode.net/?channels=%23usergrid&uio=d4";>IRC</a></li> - <li><a href="https://twitter.com/usergrid"; target="_blank">Twitter</a></li> - <li><a href="http://incubator.apache.org/projects/usergrid.html"; target="_blank">Podling Listing</a></li> - <li><a href="https://github.com/usergrid/usergrid/blob/master/LICENSE"; target="_blank">License</a></li> - <li><a href="https://github.com/usergrid/usergrid/blob/master/stack#requirements"; target="_blank">Getting Started</a></li> - <li><a href="https://github.com/usergrid/usergrid/blob/master/stack#contributing"; target="_blank">Contribution Guidelines</a></li> - </ul> - </div> - <div class="col-md-2"></div> - <div class="col-md-4"> - <a class="twitter-timeline" href="https://twitter.com/search?q=%23usergrid"; data-widget-id="401499136807038976" data-related="usergrid" height="400px" style="overflow:hidden">Tweets about "usergrid"</a> - <script>!function(d,s,id){var js,fjs=d.getElementsByTagName(s)[0],p=/^http:/.test(d.location)?'http':'https';if(!d.getElementById(id)){js=d.createElement(s);js.id=id;js.src=p+"://platform.twitter.com/widgets.js";fjs.parentNode.insertBefore(js,fjs);}}(document,"script","twitter-wjs");</script> - </div> - <!-- - <div class="col-md-4"> - <div class="input-group form-search"> - <input type="text" class="form-control search-query"> - <span class="input-group-btn"> - <button type="submit" class="btn btn-primary" data-type="last">Search</button> - </span> - </div> - </div> --> - </div> - <div class="row"> - <div id="copyright"> - <img src="/img/egg-logo.png" /><br/><br/> - <p>Apache Usergrid is an effort undergoing incubation at The Apache Software Foundation (ASF), sponsored by the Apache Incubator PMC. Incubation is required of all newly accepted projects until a further review indicates that the infrastructure, communications, and decision making process have stabilized in a manner consistent with other successful ASF projects. While incubation status is not necessarily a reflection of the completeness or stability of the code, it does indicate that the project has yet to be fully endorsed by the ASF.</p> - <p>Copyright © 2013 The Apache Software Foundation, Licensed under the Apache License, Version 2.0.<br> - Apache and the Apache feather logos are trademarks of The Apache Software Foundation.</p> - <p class="credits">Site designed & assembled with love by <a href="https://github.com/ryuneeee";>@ryuneeee</a> + <a href="https://github.com/realbeast";>@realbeast</a> + <a href="https://twitter.com/timanglade";>@timanglade</a>.</p> - </div> - </div> - </div> -</footer> - -<script type="text/javascript" src="/js/head.js"></script> -<script type="text/javascript"> - head.js("/js/jquery-1.10.1.min.js", "/js/bootstrap.min.js", "/js/usergrid-site.js"); -</script> -<script> - (function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){ - (i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o), - m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m) - })(window,document,'script','//www.google-analytics.com/analytics.js','ga'); - - ga('create', 'UA-45815079-1', 'apache.org'); - ga('send', 'pageview'); - -</script> - - -</body> -</html> \ No newline at end of file http://git-wip-us.apache.org/repos/asf/incubator-usergrid/blob/ec2b3e4f/website/publish/docs/creating-collections/index.html ---------------------------------------------------------------------- diff --git a/website/publish/docs/creating-collections/index.html b/website/publish/docs/creating-collections/index.html deleted file mode 100644 index 5adc080..0000000 --- a/website/publish/docs/creating-collections/index.html +++ /dev/null @@ -1,612 +0,0 @@ -<!DOCTYPE html> -<html lang="en"> - -<head> - <meta charset="utf-8"> - <title>Apache Usergrid (incubating) â Creating Collections</title> - <meta http-equiv="x-ua-compatible" content="ie=edge" /> - <meta name="viewport" content="width=device-width, initial-scale=1, minimum-scale=1, maximum-scale=1" /> - <meta name="keywords" content="Apache Usergrid, Usergrid, BaaS, Backend-as-a-Service"> - <meta name="description" content="An open-source Backend-as-a-Service stack for web & mobile applications, based on RESTful APIs." /> - <meta property="og:title" content="Apache Usergrid" /> - <meta property="og:description" content="An open-source Backend-as-a-Service stack for web & mobile applications, based on RESTful APIs." /> - <!-- Loading Typekit --> - <script type="text/javascript" src="//use.typekit.net/ddl7izx.js"></script> - <script type="text/javascript">try{Typekit.load();}catch(e){}</script> - <!-- Loading Bootstrap --> - <link href="/bootstrap/bootstrap.min.css" rel="stylesheet" type='text/css'> - <link href="/css/bootflat.css" rel="stylesheet" type='text/css'> - <link href="/css/usergrid-site.css" rel="stylesheet" type='text/css'> - <link href="https://fonts.googleapis.com/css?family=Open+Sans:200,400,500,300,600,800,700,400italic,600italic,700italic,800italic,300italic"; rel="stylesheet" type="text/css"> - <link href="/css/font-awesome.min.css" rel="stylesheet" type='text/css'> - - - - <!-- HTML5 shim, for IE6-8 support of HTML5 elements. All other JS at the end of file. --> - <!--[if lt IE 9]> - <script src="js/html5shiv.js"></script> - <script src="js/respond.min.js"></script> - <![endif]--> -</head> -<body> - - <header class="navbar navbar-inverse navbar-fixed-top bf-docs-nav secondary" role="banner"> - <div class="container"> - <div class="navbar-header"> - <button class="navbar-toggle" type="button" data-toggle="collapse" data-target=".bf-navbar-collapse"> - <span class="sr-only">Toggle navigation</span> - <span class="icon-bar"></span> - <span class="icon-bar"></span> - <span class="icon-bar"></span> - </button> - </div> - <a href="/" class="navbar-brand"> - <img id="home-logo" src="/img/apache_usergrid_logo_white_small.png" /> - </a> - <nav class="collapse navbar-collapse bf-navbar-collapse" role="navigation"> - <ul class="nav navbar-nav navbar-right"> - <li class=""><a href="/community/"><span class="icns icon-group"></span></a></li> - <li><a href="http://usergrid.readthedocs.org/"; target="_blank"><span class="icns icon-book"></span></a></li> - <li><a href="http://github.com/apache/incubator-usergrid"; target="_blank"><span class="icns icon-github-sign"></span></a></li> - <!--<li><a href="https://trello.com/b/exQmJIOn/usergrid"; target="_blank"><span class="icns icon-trello"></span></a></li>--> - <li><a href="https://issues.apache.org/jira/secure/RapidBoard.jspa?rapidView=23&view=planning&selectedIssue=USERGRID-362&epics=visible"; target="_blank"><span class="icns icon-bug"></span></a></li> - <li><a href="http://stackoverflow.com/search?q=usergrid"; target="_blank"><span class="icns icon-stackexchange"></span></a></li> - <li><a href="/community/#live"><span class="icns icon-comments"></span></a></li> - <!--<li><a href="https://groups.google.com/forum/#!forum/usergrid"; target="_blank"><span class="icns icon-envelope"></span></a></li>--> - <li><a href="https://twitter.com/usergrid"; target="_blank"><span class="icns icon-twitter"></span></a></li> - <li><a href="https://cwiki.apache.org/confluence/display/usergrid/"; target="_blank"><span class="icns icon-wiki"></span></a></li> - <li><a href="/releases/"><span class="icns icon-releases"></span></a></li> - </ul> - </nav> - </div> - </header> - - - -<div class="container bf-docs-container"> - <div class="row"> - <div class="col-md-3"> - <div class="bf-sidebar hidden-print" role="complementary"> - <ul class="nav nav-list"> - <li><a href="/docs/getting-up-and-running-locally/">Getting Up & Running Locally</a></li> - <li><a href="/docs/deploy-local/">Deploying to local Tomcat & Cassandra</a></li> - <li><a href="https://github.com/apache/incubator-usergrid/tree/master/ugc#usergrid-command-line-ugc";><code>ugc</code> â the Command-line Client</a></li> - - <li class="nav-header"><span>Concepts</span></li> - <li> - <a href="/docs/organizations-admins/">Organizations & Admins</a> - <ul> - <li> - <a href="/docs/applications/">Applications</a> - <ul> - <li><a href="/docs/roles-and-permissions/">Roles & Permissions</a></li> - <!--<li><a href="#">Queues</a></li>--> - <li><a href="/docs/events-and-counters/">Events & Counters</a></li> - <li><a href="/docs/relationships/">Relationships (Joins)</a></li> - <li> - <a href="/docs/collections">Collections</a> - <ul> - <li><a href="/docs/query-language/">Query Language</a></li> - <li><a href="/docs/users-devices/">Users & Devices</a></li> - <li><a href="/docs/groups/">Groups</a></li> - <li><a href="/docs/activities/">Activities</a></li> - <li><a href="/docs/assets/">Assets</a></li> - </ul> - </li> - </ul> - </li> - </ul> - </li> - - - <li class="nav-header"><span>Usage</span></li> - <!-- <li>REST API â Coming Soon</li> --> - <li><a class="icns-apple" href="https://github.com/apache/incubator-usergrid/tree/master/sdks/ios";>iOS SDK</a></li> - <li><a class="icns-android" href="https://github.com/apache/incubator-usergrid/tree/master/sdks/android";>Android SDK</a></li> - <li><a class="icns-html5" href="">HTML5 / JavaScript SDK</a></li> - <li><a class="icns-windows" href="https://github.com/apache/incubator-usergrid/tree/master/sdks/dotnet";>Windows 8 / Windows Phone / .net SDK</a></li> - <li><a href="https://github.com/apache/incubator-usergrid/tree/master/sdks/nodejs";>Node.js module</a></li> - <li><a href="https://github.com/apache/incubator-usergrid/tree/master/sdks/ruby";>Ruby gem</a></li> - <li><a href="https://github.com/apache/incubator-usergrid/tree/master/sdks/ruby-on-rails";>Ruby on Rails gem</a></li> - <li><a href="https://github.com/apache/incubator-usergrid/tree/master/sdks/php";>PHP library</a></li> - <li><a href="https://github.com/apache/incubator-usergrid/tree/master/sdks/java";>Java library</a></li> - - <!--<li class="nav-header"><span>Internals</span></li> - <li>Design & Goals â Coming Soon</li> - <li>Java Architecture â Coming Soon</li> - <li>Cassandra Schema â Coming Soon</li>--> - - <li class="nav-header"><span>Operations</span></li> - <!--<li>Deploying â Coming Soon</li>--> - <!-- <li>Monitoring â Coming Soon</li> --> - <li><a href="/docs/upgrading/">Upgrading</a></li> - <!-- <li>Security â Coming Soon</li> --> - - <li class="nav-header"><span>Presentations & Videos</span></li> - <li><a href="/docs/presentations/">Presentations</a></li> - <li><a href="/docs/videos/">Videos</a></li> - - <li class="nav-header"><span>We need your help!</span></li> - <li><a href="/docs/contribute-code/">How to Contribute Code & Docs</a></li> - <!-- - <li><a href="/docs/contribute-docs">How to contribute docs</a></li> - --> - </ul> - </div> - </div> - - <div class="col-md-9 main-article" role="main"> - <div class="page-article"> - <div class="page-header"> - <h1>Creating Collections</h1> - <!-- TODO: reenable this when we sync SVN to GitHub - <small><a target="_blank" href="https://github.com/usergrid/website/blob/master/content/docs/creating-collections.md";>contribute to this article on github</a></small> - --> - </div> - <div class="toc"> - <ul> -<li> -<a href="#creating-collections">Creating Collections</a><ul> -<li> -<a href="#creating-a-collection">Creating a collection</a><ul> -<li><a href="#example-requestresponse">Example Request/Response</a></li> -<li><a href="#request-syntax">Request Syntax</a></li> -<li><a href="#parameters">Parameters</a></li> -<li><a href="#example-requestresponse-1">Example Request/Response</a></li> -<li><a href="#sdk-method">SDK Method</a></li> -<li><a href="#properties">Properties</a></li> -<li><a href="#example-requestresponse-2">Example Request/Response</a></li> -<li><a href="#sdk-method-1">SDK Method</a></li> -<li><a href="#parameters-1">Parameters</a></li> -<li><a href="#example-requestresponse-3">Example Request/Response</a></li> -<li><a href="#sdk-method-2">SDK Method</a></li> -<li><a href="#properties-1">Properties</a></li> -<li><a href="#example-requestresponse-4">Example Request/Response</a></li> -<li><a href="#sdk-method-3">SDK Method</a></li> -<li><a href="#parameters-2">Parameters</a></li> -</ul> -</li> -</ul> -</li> -</ul> -</div> -<h1 id="creating-collections">Creating Collections</h1> -<p>This article describes how to create collections in Apache Usergrid. In App Services, all entities are automatically associated with a corresponding collection based on the <code>type</code> property of the entity. You may create empty collections if you wish, but creating an entity of a new type will automatically create a corresponding collection for you. For example, creating a new custom âitemâ entity, creates an âitemsâ collection.</p> -<p><strong>Note:</strong> Although not shown in the API examples below, you need to provide a valid access token with each API call. See <a href="/authenticating-users-and-application-clients">Authenticating users and application clients</a> for details.</p> -<h2 id="creating-a-collection">Creating a collection</h2> -<ul> -<li><a href="#portal_create_collection">Admin Portal</a></li> -<li><a href="#curl_create_collection">cURL</a></li> -<li><a href="#ios_create_collection">iOS</a></li> -<li><a href="#android_create_collection">Android</a></li> -<li><a href="#javascript_create_collection">JavaScript</a></li> -<li><a href="#ruby_create_collection">Ruby</a></li> -<li><a href="#nodejs_create_collection">Node.js</a></li> -</ul> -<p>The easiest way to create a new, empty collection is by using the <em>Data Explorer</em> tool in the Apache Usergrid Admin Portal by doing the following:</p> -<ol style="list-style-type: decimal"> -<li> -<a href="https://www.apigee.com/usergrid";>Login</a> to the Apache Usergrid Admin Portal.</li> -<li>In the left menu, click <em>Data Explorer</em>.</li> -<li>In the middle column, click the <em>Add Collection</em> button.</li> -<li>In the form, enter the name for the collection you want to create. If the provided value is not a plural word, Apache Usergrid will pluralize it.</li> -<li>Click <em>Create</em>. The new collection will appear in the list.</li> -</ol> -<h3 id="example-requestresponse">Example Request/Response</h3> -<h4 id="request">Request:</h4> -<pre><code>curl -X POST "https://api.usergrid.com/your-org/your-app/item";</code></pre> -<h4 id="response">Response:</h4> -<pre><code>{ - "action" : "post", - "application" : "f34f4222-a166-11e2-a7f7-02e81adcf3d0", - "params" : { }, - "path" : "/items", - "uri" : "http://api.usergrid.com/your-org/your-app/items";, - "entities" : [ ], - "timestamp" : 1378857079220, - "duration" : 31, - "organization" : "your-org", - "applicationName" : "your-app" -}</code></pre> -<h3 id="request-syntax">Request Syntax</h3> -<pre><code>curl -X POST https://api.usergrid.com/<org>/<app>/<collection_name></code></pre> -<h3 id="parameters">Parameters</h3> -<table> -<col width="50%"> -<col width="50%"> -<thead> -<tr class="header"> -<th align="left">Parameter</th> -<th align="left">Description</th> -</tr> -</thead> -<tbody> -<tr class="odd"> -<td align="left"><p>org</p></td> -<td align="left"><p>Organization UUID or organization name</p></td> -</tr> -<tr class="even"> -<td align="left"><p>app</p></td> -<td align="left"><p>Application UUID or application name</p></td> -</tr> -<tr class="odd"> -<td align="left"><p>collection_name</p></td> -<td align="left"> -<p>Name of the collection to create. If the provided value is not a plural word, Apache Usergrid will pluralize it.</p> -<p>For example, providing âitemâ will create a collection named âitemsâ but providing âitemsâ will not create âitemsesâ.</p> -</td> -</tr> -</tbody> -</table> -<p>This example uses the <a href="/app-services-sdks#ios">Apache Usergrid iOS SDK</a>.</p> -<h3 id="example-requestresponse-1">Example Request/Response</h3> -<h4 id="request-1">Request:</h4> -<pre><code>-(NSString*)createCollection { - -NSString *url = @"https://api.usergrid.com/your-org/your-app/items";; -NSString *op = @"POST"; -NSString *opData = nil; - - //we recommend you call ApigeeClient from your AppDelegate. - //for more information see the iOS SDK install guide: http://apigee.com/docs/app-services/content/installing-apigee-sdk-ios - //create an instance of AppDelegate - AppDelegate *appDelegate = (AppDelegate *)[[UIApplication sharedApplication] delegate]; - - //call createEntity to initiate the API call - ApigeeClientResponse *response = [appDelegate.dataClient apiRequest: url operation: op data: opData]; - -@try { - //success -} -@catch (NSException * e) { - //fail -} - -} - </code></pre> -<h4 id="response-1">Response:</h4> -<pre><code>{ - "action" : "post", - "application" : "f34f4222-a166-11e2-a7f7-02e81adcf3d0", - "params" : { }, - "path" : "/items", - "uri" : "http://api.usergrid.com/your-org/your-app/items";, - "entities" : [ ], - "timestamp" : 1378857079220, - "duration" : 31, - "organization" : "your-org", - "applicationName" : "your-app" -}</code></pre> -<h3 id="sdk-method">SDK Method</h3> -<pre><code>(ApigeeClientResponse *)apiRequest: (NSString *)url operation:(NSString *)op data:(NSString *)opData</code></pre> -<h3 id="properties">Properties</h3> -<table> -<col width="50%"> -<col width="50%"> -<thead> -<tr class="header"> -<th align="left">Parameter</th> -<th align="left">Description</th> -</tr> -</thead> -<tbody> -<tr class="odd"> -<td align="left"><p>url</p></td> -<td align="left"><p>A fully-formed url in the following format: https://api.usergrid.com/<org>/< app>/<collection></collection></org></p></td> -</tr> -<tr class="even"> -<td align="left"><p>op</p></td> -<td align="left"><p>The HTTP method - in this case, âPOSTâ</p></td> -</tr> -<tr class="odd"> -<td align="left"><p>opData</p></td> -<td align="left"><p>No data is being sent, so the value is <code>nil</code></p></td> -</tr> -</tbody> -</table> -<p>Currently, creating an empty collection is not supported by the <a href="/app-services-sdks#android">App Services SDK for Android</a>.</p> -<p>This example uses the <a href="/app-services-sdks#javascript">Apache Usergrid JavaScript (HTML5) SDK</a>.</p> -<h3 id="example-requestresponse-2">Example Request/Response</h3> -<h4 id="request-2">Request:</h4> -<pre><code>//create the basic client object -var dataClient = new Usergrid.Client({ -orgName:'your-org', -appName:'your-app' -}); - -//options for the request -var options = { -endpoint:"items", -method:"POST" -} - -dataClient.request(options,function (error,response) { - -if (error) { - // Error -} else { - // Success -} - -}); - </code></pre> -<h4 id="response-2">Response:</h4> -<pre><code>Object {action: "post", application: "f34f4222-a166-11e2-a7f7-02e81adcf3d0", params: Object, path: "/items", uri: "http://api.usergrid.com/your-org/your-app/items"â¦} -action: "post" -application: "f34f4222-a166-11e2-a7f7-02e81adcf3d0" -applicationName: "your-app" -duration: 29 -entities: Array[0] -organization: "your-org" -params: Object -path: "/items" -timestamp: 1378872945962 -uri: "http://api.usergrid.com/your-org/your-app/items"; -__proto__: Object - </code></pre> -<h3 id="sdk-method-1">SDK Method</h3> -<pre><code>request(options, callback)</code></pre> -<h3 id="parameters-1">Parameters</h3> -<table> -<col width="50%"> -<col width="50%"> -<thead> -<tr class="header"> -<th align="left">Parameter</th> -<th align="left">Description</th> -</tr> -</thead> -<tbody> -<tr class="odd"> -<td align="left"><p>options</p></td> -<td align="left"> -<p>A JSON-formatted object containing the following properties:</p> -<ul> -<li>endpoint: the name of the collection to be created</li> -<li>method: the HTTP method for the request, in this case <em>POST</em> -</li> -</ul> -</td> -</tr> -<tr class="even"> -<td align="left"><p>callback</p></td> -<td align="left"><p>Callback function to handle the API response</p></td> -</tr> -</tbody> -</table> -<p>This example uses the <a href="/app-services-sdks#ruby">Apache Usergrid RubyGem</a>.</p> -<h3 id="example-requestresponse-3">Example Request/Response</h3> -<h4 id="request-3">Request:</h4> -<pre><code>#Create a client object -usergrid_api = 'https://api.usergrid.com' -organization = 'your-org' -application = 'your-app' - -client = Usergrid::Application.new "#{usergrid_api}/#{organization}/#{application}" - -begin - # Call create_entity to initiate the API call - # By specifying 'nil' for the request body, we get an empty collection - client.create_entity('item', nil) -rescue - #fail -end - </code></pre> -<h4 id="response-3">Response:</h4> -<pre><code>{ - "action" : "post", - "application" : "f34f4222-a166-11e2-a7f7-02e81adcf3d0", - "params" : { }, - "path" : "/items", - "uri" : "http://api.usergrid.com/your-org/your-app/items";, - "entities" : [ ], - "timestamp" : 1378857079220, - "duration" : 31, - "organization" : "your-org", - "applicationName" : "your-app" -}</code></pre> -<h3 id="sdk-method-2">SDK Method</h3> -<pre><code>create_entity(type, properties)</code></pre> -<h3 id="properties-1">Properties</h3> -<table> -<thead> -<tr class="header"> -<th align="left">Parameter</th> -<th align="left">Description</th> -</tr> -</thead> -<tbody> -<tr class="odd"> -<td align="left">type</td> -<td align="left">Custom entity type that will correspond to the collection</td> -</tr> -<tr class="even"> -<td align="left">properties</td> -<td align="left">Object that contains the entity properties â in this case ânilâ</td> -</tr> -</tbody> -</table> -<p>This example uses the <a href="/app-services-sdks#nodejs">Apache Usergrid Node.js module</a>.</p> -<h3 id="example-requestresponse-4">Example Request/Response</h3> -<h4 id="request-4">Request:</h4> -<pre><code>//create the basic client object -var dataClient = new Usergrid.client({ -orgName:'your-org', -appName:'your-app' -}); - -//options for the request -var options = { -endpoint:"items", -method:"POST" -} - -dataClient.request(options,function (error,response) { - - if (error) { - // Error - } else { - // Success - } - -}); - </code></pre> -<h4 id="response-4">Response:</h4> -<pre><code>{ action: 'post', - application: 'f34f4222-a166-11e2-a7f7-02e81adcf3d0', - params: {}, - path: '/items', - uri: 'http://api.usergrid.com/your-org/your-app/items', - entities: [], - timestamp: 1378873689426, - duration: 29, - organization: 'your-org', - applicationName: 'your-app' } - </code></pre> -<h3 id="sdk-method-3">SDK Method</h3> -<pre><code>entity.request(options,callback)</code></pre> -<h3 id="parameters-2">Parameters</h3> -<table> -<col width="50%"> -<col width="50%"> -<thead> -<tr class="header"> -<th align="left">Parameter</th> -<th align="left">Description</th> -</tr> -</thead> -<tbody> -<tr class="odd"> -<td align="left"><p>options</p></td> -<td align="left"> -<p>A JSON-formatted object containing the following properties:</p> -<ul> -<li>endpoint: the name of the collection to be created</li> -<li>method: the HTTP method for the request, in this case <em>POST</em> -</li> -</ul> -</td> -</tr> -<tr class="even"> -<td align="left"><p>callback</p></td> -<td align="left"><p>Callback function to handle the API response</p></td> -</tr> -</tbody> -</table> -<p> </p> - </div> - </div> - </div> - <div class="row"> - <div class="col-md-3"></div> - <div class="col-md-9"> - <div class="github-callout"> - <strong>Questions?</strong> Please do <a href="/community">ask on the mailing-lists</a>!<br/> - <!-- - <strong>Found an error?</strong> Weâd greatly appreciate a pull request about <a target="_blank" href="https://github.com/usergrid/website/blob/master/content/docs/creating-collections.md";>this article on github</a>.</div> - --> - </div> - </div> - </div> -</div> - - -<footer class="bf-footer" role="contentinfo"> - <div class="container"> - <div class="row"> - <div class="col-md-2"> - <ul class="nav nav-list"> - <li class="nav-header"><a href="/">Home</a></li> - <li class="nav-header"><a href="/community/">Community</a></li> - <li><a href="/community/#events">Events</a></li> - <li><a href="/community/#mailing-lists">Mailing Lists</a></li> - <li><a href="/community/#deployments">Deployments</a></li> - <li><a href="/community/#committers">Commiters</a></li> - </ul> - </div> - <div class="col-md-2"> - <ul class="nav nav-list"> - <li class="nav-header"><a href="https://github.com/apache/incubator-usergrid/"; target="_blank">Code</a></li> - <li><a href="https://github.com/apache/incubator-usergrid/blob/master/stack"; target="_blank">Server Stack</a></li> - <li><a href="https://github.com/apache/incubator-usergrid/blob/master/portal"; target="_blank">Admin Portal</a></li> - <li><a href="https://github.com/apache/incubator-usergrid/blob/master/ugc"; target="_blank">ugc command line</a></li> - <li><a href="https://github.com/apache/incubator-usergrid/blob/master/sdks/ios"; target="_blank">iOS SDK</a></li> - <li><a href="https://github.com/apache/incubator-usergrid/blob/master/sdks/android"; target="_blank">Android SDK</a></li> - <li><a href="https://github.com/apache/incubator-usergrid/blob/master/sdks/html5-javascript"; target="_blank">HTML5/JS SDK</a></li> - <li><a href="https://github.com/apache/incubator-usergrid/blob/master/sdks/nodejs"; target="_blank">node.js module</a></li> - <li><a href="https://github.com/apache/incubator-usergrid/blob/master/sdks/ruby-on-rails"; target="_blank">Ruby on Rails gem</a></li> - <li><a href="https://github.com/apache/incubator-usergrid/blob/master/sdks/ruby"; target="_blank">Ruby gem</a></li> - <li><a href="https://github.com/apache/incubator-usergrid/blob/master/sdks/php"; target="_blank">PHP SDK</a></li> - <li><a href="https://github.com/apache/incubator-usergrid/blob/master/sdks/java"; target="_blank">Java SDK</a></li> - <li><a href="https://github.com/apache/incubator-usergrid/blob/master/sdks/dotnet"; target="_blank">.NET / Windows SDK</a></li> - </ul> - </div> - <div class="col-md-2"> - <ul class="nav nav-list"> - <li class="nav-header">Resources</li> - <li><a href="http://github.com/apache/incubator-usergrid"; target="_blank">GitHub Code</a></li> - <li><a href="http://usergrid.readthedocs.org/"; target="_blank">Docs</a></li> - <li><a href="https://issues.apache.org/jira/secure/RapidBoard.jspa?rapidView=23&view=planning&selectedIssue=USERGRID-362&epics=visible"; target="_blank">JIRA Bug Tracker</a></li> - <li><a href="http://stackoverflow.com/search?q=usergrid"; target="_blank">StackOverflow</a></li> - <li><a href="/community/#live">Live Chat</a></li> - <li><a href="https://twitter.com/usergrid"; target="_blank">Twitter</a></li> - <li><a href="http://incubator.apache.org/projects/usergrid.html"; target="_blank">Podling Listing</a></li> - <li><a href="https://github.com/apache/incubator-usergrid/blob/master/stack#requirements"; target="_blank">Getting Started</a></li> - <li><a href="https://cwiki.apache.org/confluence/display/usergrid/GitHub+Based+Contribution+Workflow"; target="_blank">Contribution Guidelines</a></li> - </ul> - </div> - <div class="col-md-2"> - <ul class="nav nav-list"> - <li class="nav-header">Apache</li> - <li><a href="http://www.apache.org/licenses/"; target="_blank">License</a></li> - <li><a href="http://www.apache.org/foundation/sponsorship.html"; target="_blank">Sponsorship</a></li> - <li><a href="http://www.apache.org/foundation/thanks.html"; target="_blank">Thanks</a></li> - <li><a href="http://www.apache.org/security/";>Security</a></li> - <li><a href="http://www.apache.org/"; target="_blank">Apache Foundation</a></li> - </ul> - </div> - <div class="col-md-4"> - <a class="twitter-timeline" href="https://twitter.com/search?q=%23usergrid"; data-widget-id="401499136807038976" data-related="usergrid" height="400px" style="overflow:hidden">Tweets about "usergrid"</a> - <script>!function(d,s,id){var js,fjs=d.getElementsByTagName(s)[0],p=/^http:/.test(d.location)?'http':'https';if(!d.getElementById(id)){js=d.createElement(s);js.id=id;js.src=p+"://platform.twitter.com/widgets.js";fjs.parentNode.insertBefore(js,fjs);}}(document,"script","twitter-wjs");</script> - </div> - <!-- - <div class="col-md-4"> - <div class="input-group form-search"> - <input type="text" class="form-control search-query"> - <span class="input-group-btn"> - <button type="submit" class="btn btn-primary" data-type="last">Search</button> - </span> - </div> - </div> --> - </div> - <div class="row"> - <div id="copyright"> - <img src="/img/egg-logo.png" /><br/><br/> - <p>Apache Usergrid is an effort undergoing incubation at The Apache Software Foundation (ASF), sponsored by the Apache Incubator PMC. Incubation is required of all newly accepted projects until a further review indicates that the infrastructure, communications, and decision making process have stabilized in a manner consistent with other successful ASF projects. While incubation status is not necessarily a reflection of the completeness or stability of the code, it does indicate that the project has yet to be fully endorsed by the ASF.</p> - <p>Copyright © 2013 The Apache Software Foundation, Licensed under the Apache License, Version 2.0.<br> - Apache and the Apache feather logos are trademarks of The Apache Software Foundation.</p> - <p class="credits">Site designed & assembled with love by <a href="https://github.com/ryuneeee";>@ryuneeee</a> + <a href="https://github.com/realbeast";>@realbeast</a> + <a href="https://twitter.com/timanglade";>@timanglade</a>.</p> - </div> - </div> - </div> -</footer> - -<script type="text/javascript" src="/js/head.js"></script> -<script type="text/javascript"> - head.js("/js/jquery-1.10.1.min.js", "/js/bootstrap.min.js", "/js/usergrid-site.js"); -</script> -<script> - (function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){ - (i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o), - m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m) - })(window,document,'script','//www.google-analytics.com/analytics.js','ga'); - - ga('create', 'UA-45815079-1', 'apache.org'); - ga('send', 'pageview'); - -</script> - - - -</body> -</html>
