You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@usergrid.apache.org by ti...@apache.org on 2013/12/12 08:55:46 UTC
svn commit: r1550366 [1/4] - in /incubator/usergrid/site/publish/docs:
activities/ applications/ assets/ collections/ contributing/
events-and-counters/ getting-up-and-running-locally/ group/ groups/
overview/ query-language/ relationships/ roles-and-p...
Author: timanglade
Date: Thu Dec 12 07:55:45 2013
New Revision: 1550366
URL: http://svn.apache.org/r1550366
Log:
Add docs
Added:
incubator/usergrid/site/publish/docs/activities/
incubator/usergrid/site/publish/docs/activities/index.html
incubator/usergrid/site/publish/docs/collections/
incubator/usergrid/site/publish/docs/collections/index.html
incubator/usergrid/site/publish/docs/contributing/
incubator/usergrid/site/publish/docs/contributing/index.html
incubator/usergrid/site/publish/docs/getting-up-and-running-locally/
incubator/usergrid/site/publish/docs/getting-up-and-running-locally/index.html
incubator/usergrid/site/publish/docs/groups/
incubator/usergrid/site/publish/docs/groups/index.html
incubator/usergrid/site/publish/docs/query-language/
incubator/usergrid/site/publish/docs/query-language/index.html
incubator/usergrid/site/publish/docs/relationships/
incubator/usergrid/site/publish/docs/relationships/index.html
incubator/usergrid/site/publish/docs/roles-and-permissions/
incubator/usergrid/site/publish/docs/roles-and-permissions/index.html
incubator/usergrid/site/publish/docs/upgrading/
incubator/usergrid/site/publish/docs/upgrading/index.html
Modified:
incubator/usergrid/site/publish/docs/applications/index.html
incubator/usergrid/site/publish/docs/assets/index.html
incubator/usergrid/site/publish/docs/events-and-counters/index.html
incubator/usergrid/site/publish/docs/group/index.html
incubator/usergrid/site/publish/docs/overview/index.html
Added: incubator/usergrid/site/publish/docs/activities/index.html
URL: http://svn.apache.org/viewvc/incubator/usergrid/site/publish/docs/activities/index.html?rev=1550366&view=auto
==============================================================================
--- incubator/usergrid/site/publish/docs/activities/index.html (added)
+++ incubator/usergrid/site/publish/docs/activities/index.html Thu Dec 12 07:55:45 2013
@@ -0,0 +1,240 @@
+<!DOCTYPE html>
+<html lang="en">
+
+<head>
+ <meta charset="utf-8">
+ <title>Apache Usergrid (incubating) â Activities</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>Activities</h1>
+ <small><a target="_blank" href="https://github.com/usergrid/website/blob/master/content/docs/activities.md">contribute to this article on github</a></small>
+ </div>
+ <div class="toc">
+
+</div>
+<p>Activities are a special type of Collection. They can be used to model short updates such as tweets, newsfeed items, social shares, updates, etc.</p>
+<p>They are heavily inspired by Twitter and ActivityStreams, so they will tend to work the way you expect these to work.</p>
+<p>Activities are attached to the User or Group that produced them, and will be automatically propagated to the Users that follow the Group or User. e.g. if Tim âfollowsâ Ed, all Activities posted by Ed at /users/ed/activities will be automatically propagated so that a GET to /users/tim/feed will list all updates by Ed (and other users & groups Tim follows).</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/activities.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
Modified: incubator/usergrid/site/publish/docs/applications/index.html
URL: http://svn.apache.org/viewvc/incubator/usergrid/site/publish/docs/applications/index.html?rev=1550366&r1=1550365&r2=1550366&view=diff
==============================================================================
--- incubator/usergrid/site/publish/docs/applications/index.html (original)
+++ incubator/usergrid/site/publish/docs/applications/index.html Thu Dec 12 07:55:45 2013
@@ -45,8 +45,8 @@
</div>
<nav class="collapse navbar-collapse bf-navbar-collapse" role="navigation">
<ul class="nav navbar-nav navbar-right">
- <!--<li class="active"><a href="/docs/"><span class="icns icon-book"></span></a></li>-->
<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>
@@ -65,27 +65,28 @@
<div class="col-md-3">
<div class="bf-sidebar hidden-print" role="complementary">
<ul class="nav nav-list">
- <li><a href="#">Getting Up & Running Locally</a></li>
- <li><a href="#"><code>ugc</code> â the Command-line Client</a></li>
+ <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>
+ <a href="/docs/applications/">Applications</a>
<ul>
- <li><a href="#">Roles & Permissions</a></li>
- <li><a href="#">Queues</a></li>
- <li><a href="#">Events & Counters</a></li>
+ <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="#">Collections</a>
+ <a href="/docs/collections">Collections</a>
<ul>
- <li><a href="#">Query Language</a></li>
- <li><a href="#">Users & Devices</a></li>
- <li><a href="#">Groups</a></li>
- <li><a href="#">Activities</a></li>
- <li><a href="#">Assets</a></li>
+ <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>
@@ -95,27 +96,28 @@
<li class="nav-header"><span>Usage</span></li>
- <li><a href="/docs/rest-api">REST API</a></li>
- <li><a class="icns-apple" href="#">iOS SDK</a></li>
- <li><a class="icns-android" href="#">Android SDK</a></li>
- <li><a class="icns-html5" href="/docs/html5-javascript-sdk">HTML5 / JavaScript SDK</a></li>
- <li><a class="icns-windows" href="#">Windows 8 / Windows Phone / .net SDK</a></li>
- <li><a href="/docs/nodejs-module">Node.js module</a></li>
- <li><a href="/docs/ruby-gem">Ruby gem</a></li>
- <li><a href="#">Ruby on Rails gem</a></li>
- <li><a href="#">PHP library</a></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><a href="#">Design & Goals</a></li>
- <li><a href="#">Java Architecture</a></li>
- <li><a href="#">Cassandra Schema</a></li>
- <li><a href="#">Contributing</a></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><a href="#">Deploying</a></li>
- <li><a href="#">Monitoring</a></li>
- <li><a href="#">Upgrading</a></li>
- <li><a href="#">Security</a></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>
@@ -124,26 +126,14 @@
<div class="page-article">
<div class="page-header">
<h1>Applications</h1>
- <small><a href="https://github.com/timanglade/usergrid-site/blob/master/content/docs/applications/">contribute to this article on github</a></small>
+ <small><a target="_blank" href="https://github.com/usergrid/website/blob/master/content/docs/applications.md">contribute to this article on github</a></small>
</div>
<div class="toc">
- <ul>
-<li>
-<a href="#applications">Applications</a><ul>
-<li><a href="#application-properties">Application properties</a></li>
-<li><a href="#set-properties">Set properties</a></li>
-<li><a href="#collections">Collections</a></li>
-</ul>
-</li>
-</ul>
+
</div>
-<h2 id="applications"><a href="#applications">Applications</a></h2>
-<p>You can create a new application in an organization through the <a href="/admin-portal">Admin portal</a>. The Admin portal creates the new application by issuing a post against the management endpoint (see the âCreating an organization applicationâ section in <a href="/organization">Organization</a> for details). If you need to create an application programmatically in your app, you can also use the API to do this. You can access application entities using your app name or UUID, prefixed with the organization name or UUID:</p>
-<p><a href="http://api.usergrid.com/">https://api.usergrid.com</a>/{org_name|uuid}/{app_name|uuid}</p>
+<p>Each Organization can contain multiple Applications. You can access applications entities using their app name or UUID, prefixed with the organization name or UUID:</p>
+<pre><code>http://api.usergrid.com/org_name_or_uuid/app_name_or_uuid/</code></pre>
<p>Most mobile apps never access the application entity directly. For example you might have a server-side web app that accesses the application entity for configuration purposes. If you want to access your application entity programmatically, you can use the API.</p>
-<h3 id="application-properties"><a href="#application-properties">Application properties</a></h3>
-<p>The following are the system-defined properties for application entities. You can create application-specific properties for an application entity in addition to the system-defined properties. The system-defined properties are reserved. You cannot use these names to create other properties for an application entity. In addition the applications name is reserved for the applications collection â you canât use it to name another collection.</p>
-<p>The look-up properties for the entities of type application are uuid and name, that is, you can use the uuid and name properties to reference an application entity in an API call. However, you can search on a role using any property of the application entity. See <a href="/queries-and-parameters">Queries and parameters</a> for details on searching.</p>
<table>
<thead><tr class="header">
<th align="left">Property</th>
@@ -219,101 +209,6 @@
<td align="left">Time to live value for an access token obtained within the application</td>
</tr>
</tbody>
-</table><h3 id="set-properties"><a href="#set-properties">Set properties</a></h3>
-<p>The set properties for applications are listed in the table below.</p>
-<table>
-<thead><tr class="header">
-<th align="left">Set</th>
-<th align="left">Type</th>
-<th align="left">Description</th>
-</tr></thead>
-<tbody>
-<tr class="odd">
-<td align="left">collections</td>
-<td align="left">string</td>
-<td align="left">Set of collections</td>
-</tr>
-<tr class="even">
-<td align="left">rolenames</td>
-<td align="left">string</td>
-<td align="left">Set of roles assigned to an application</td>
-</tr>
-<tr class="odd">
-<td align="left">counters</td>
-<td align="left">string</td>
-<td align="left">Set of counters assigned to an application</td>
-</tr>
-<tr class="even">
-<td align="left">oauthproviders</td>
-<td align="left">string</td>
-<td align="left">Set of OAuth providers for the application</td>
-</tr>
-<tr class="odd">
-<td align="left">credentials</td>
-<td align="left">string</td>
-<td align="left">Set of credentials required to run the application</td>
-</tr>
-</tbody>
-</table><h3 id="collections"><a href="#collections">Collections</a></h3>
-<p>The collections for applications are listed in the table below.</p>
-<table>
-<thead><tr class="header">
-<th align="left">Collection</th>
-<th align="left">Type</th>
-<th align="left">Description</th>
-</tr></thead>
-<tbody>
-<tr class="odd">
-<td align="left">users</td>
-<td align="left">user</td>
-<td align="left">Collection of users</td>
-</tr>
-<tr class="even">
-<td align="left">groups</td>
-<td align="left">group</td>
-<td align="left">Collection of groups</td>
-</tr>
-<tr class="odd">
-<td align="left">folders</td>
-<td align="left">folder</td>
-<td align="left">Collection of assets that represent folder-like objects</td>
-</tr>
-<tr class="even">
-<td align="left">events</td>
-<td align="left">event</td>
-<td align="left">Collection of events posted by the application</td>
-</tr>
-<tr class="odd">
-<td align="left">assets</td>
-<td align="left">asset</td>
-<td align="left">Collection of assets that represent file-like objects</td>
-</tr>
-<tr class="even">
-<td align="left">activities</td>
-<td align="left">activity</td>
-<td align="left">Collection of activity stream actions</td>
-</tr>
-<tr class="odd">
-<td align="left">devices</td>
-<td align="left">device</td>
-<td align="left">Collection of devices in the service</td>
-</tr>
-<tr class="even">
-<td align="left">notifiers</td>
-<td align="left">notifier</td>
-<td align="left">Collection of notifiers used for push notifications</td>
-</tr>
-<tr class="odd">
-<td align="left">notifications</td>
-<td align="left">notification</td>
-<td align="left">Collection of push notifications that have been sent or are scheduled to be sent</td>
-</tr>
-<tr class="even">
-<td align="left">receipts</td>
-<td align="left">receipt</td>
-<td align="left">Collection of receipts from push notifications that were sent</td>
-</tr>
-</tbody>
</table>
</div>
</div>
@@ -322,8 +217,8 @@
<div class="col-md-3"></div>
<div class="col-md-9">
<div class="github-callout">
- <strong>Questions?</strong> Please do <a href="https://groups.google.com/forum/#!forum/usergrid">ask on the mailing-list</a>!<br/>
- <strong>Found an error?</strong> Weâd greatly appreciate a pull request about <a href="https://github.com/timanglade/usergrid-site/blob/master/content/docs/applications/">this article on github</a>.</div>
+ <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/applications.md">this article on github</a>.</div>
</div>
</div>
</div>
@@ -336,7 +231,7 @@
<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/#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>
@@ -392,7 +287,7 @@
<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 name of Apache TLP sponsor. 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>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>
Modified: incubator/usergrid/site/publish/docs/assets/index.html
URL: http://svn.apache.org/viewvc/incubator/usergrid/site/publish/docs/assets/index.html?rev=1550366&r1=1550365&r2=1550366&view=diff
==============================================================================
--- incubator/usergrid/site/publish/docs/assets/index.html (original)
+++ incubator/usergrid/site/publish/docs/assets/index.html Thu Dec 12 07:55:45 2013
@@ -45,8 +45,8 @@
</div>
<nav class="collapse navbar-collapse bf-navbar-collapse" role="navigation">
<ul class="nav navbar-nav navbar-right">
- <!--<li class="active"><a href="/docs/"><span class="icns icon-book"></span></a></li>-->
<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>
@@ -65,27 +65,28 @@
<div class="col-md-3">
<div class="bf-sidebar hidden-print" role="complementary">
<ul class="nav nav-list">
- <li><a href="#">Getting Up & Running Locally</a></li>
- <li><a href="#"><code>ugc</code> â the Command-line Client</a></li>
+ <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>
+ <a href="/docs/applications/">Applications</a>
<ul>
- <li><a href="#">Roles & Permissions</a></li>
- <li><a href="#">Queues</a></li>
- <li><a href="#">Events & Counters</a></li>
+ <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="#">Collections</a>
+ <a href="/docs/collections">Collections</a>
<ul>
- <li><a href="#">Query Language</a></li>
- <li><a href="#">Users & Devices</a></li>
- <li><a href="#">Groups</a></li>
- <li><a href="#">Activities</a></li>
- <li><a href="#">Assets</a></li>
+ <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>
@@ -95,27 +96,28 @@
<li class="nav-header"><span>Usage</span></li>
- <li><a href="/docs/rest-api">REST API</a></li>
- <li><a class="icns-apple" href="#">iOS SDK</a></li>
- <li><a class="icns-android" href="#">Android SDK</a></li>
- <li><a class="icns-html5" href="/docs/html5-javascript-sdk">HTML5 / JavaScript SDK</a></li>
- <li><a class="icns-windows" href="#">Windows 8 / Windows Phone / .net SDK</a></li>
- <li><a href="/docs/nodejs-module">Node.js module</a></li>
- <li><a href="/docs/ruby-gem">Ruby gem</a></li>
- <li><a href="#">Ruby on Rails gem</a></li>
- <li><a href="#">PHP library</a></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><a href="#">Design & Goals</a></li>
- <li><a href="#">Java Architecture</a></li>
- <li><a href="#">Cassandra Schema</a></li>
- <li><a href="#">Contributing</a></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><a href="#">Deploying</a></li>
- <li><a href="#">Monitoring</a></li>
- <li><a href="#">Upgrading</a></li>
- <li><a href="#">Security</a></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>
@@ -124,18 +126,12 @@
<div class="page-article">
<div class="page-header">
<h1>Assets</h1>
- <small><a href="https://github.com/timanglade/usergrid-site/blob/master/content/docs/assets/">contribute to this article on github</a></small>
+ <small><a target="_blank" href="https://github.com/usergrid/website/blob/master/content/docs/assets.md">contribute to this article on github</a></small>
</div>
<div class="toc">
- <ul>
-<li><a href="#asset-properties">Asset properties</a></li>
-<li><a href="#set-property">Set property</a></li>
-</ul>
+
</div>
<p>Asset entities are used primarily in Apache Usergrid to manage binary data objects such as images, video, and audio content. However, an asset does not have to be used for a binary object. For example, assets can be used to model a file system.</p>
-<p>Using App services APIs you can create, retrieve, update, delete, and query asset entities. See You do not have access to view this node for descriptions of these APIs.</p>
-<h2 id="asset-properties"><a href="#asset-properties">Asset properties</a></h2>
-<p>The following are the system-defined properties for asset entities. You can create application-specific properties for an asset entity in addition to the system-defined properties. The system-defined properties are reserved. You cannot use these names to create other properties for an asset entity. In addition the assets name is reserved for the assets collection â you canât use it to name another collection.</p>
<table>
<thead><tr class="header">
<th align="left">Property</th>
@@ -186,19 +182,6 @@
<td align="left">Content type of the asset (for example, âimage/jpegâ)</td>
</tr>
</tbody>
-</table><h2 id="set-property"><a href="#set-property">Set property</a></h2>
-<p>Assets have the following set property.</p>
-<table>
-<thead><tr class="header">
-<th align="left">Set</th>
-<th align="left">Type</th>
-<th align="left">Description</th>
-</tr></thead>
-<tbody><tr class="odd">
-<td align="left">connections</td>
-<td align="left">string</td>
-<td align="left">Set of connections for the asset</td>
-</tr></tbody>
</table><p>Â </p>
</div>
</div>
@@ -207,8 +190,8 @@
<div class="col-md-3"></div>
<div class="col-md-9">
<div class="github-callout">
- <strong>Questions?</strong> Please do <a href="https://groups.google.com/forum/#!forum/usergrid">ask on the mailing-list</a>!<br/>
- <strong>Found an error?</strong> Weâd greatly appreciate a pull request about <a href="https://github.com/timanglade/usergrid-site/blob/master/content/docs/assets/">this article on github</a>.</div>
+ <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/assets.md">this article on github</a>.</div>
</div>
</div>
</div>
@@ -221,7 +204,7 @@
<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/#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>
@@ -277,7 +260,7 @@
<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 name of Apache TLP sponsor. 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>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>
Added: incubator/usergrid/site/publish/docs/collections/index.html
URL: http://svn.apache.org/viewvc/incubator/usergrid/site/publish/docs/collections/index.html?rev=1550366&view=auto
==============================================================================
--- incubator/usergrid/site/publish/docs/collections/index.html (added)
+++ incubator/usergrid/site/publish/docs/collections/index.html Thu Dec 12 07:55:45 2013
@@ -0,0 +1,254 @@
+<!DOCTYPE html>
+<html lang="en">
+
+<head>
+ <meta charset="utf-8">
+ <title>Apache Usergrid (incubating) â 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>
+ <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>Collections</h1>
+ <small><a target="_blank" href="https://github.com/usergrid/website/blob/master/content/docs/collections.md">contribute to this article on github</a></small>
+ </div>
+ <div class="toc">
+ <ul>
+<li><a href="#reserved-collections">Reserved Collections</a></li>
+</ul>
+</div>
+<p>In Apache Usergrid, 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>Queries are always limited in scope to the current collection. That should be your primary consideration for data modeling in Apache Usergrid.</p>
+<h2 id="reserved-collections"><a href="#reserved-collections">Reserved Collections</a></h2>
+<p>The following collections are reserved in the system</p>
+<ul>
+<li>users</li>
+<li>groups</li>
+<li>activities</li>
+<li>devices</li>
+<li>assets</li>
+<li>folders</li>
+<li>queues</li>
+<li>events</li>
+<li>counters</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/collections.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
Added: incubator/usergrid/site/publish/docs/contributing/index.html
URL: http://svn.apache.org/viewvc/incubator/usergrid/site/publish/docs/contributing/index.html?rev=1550366&view=auto
==============================================================================
--- incubator/usergrid/site/publish/docs/contributing/index.html (added)
+++ incubator/usergrid/site/publish/docs/contributing/index.html Thu Dec 12 07:55:45 2013
@@ -0,0 +1,239 @@
+<!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