cherry picking docs from master
Project: http://git-wip-us.apache.org/repos/asf/incubator-usergrid/repo Commit: http://git-wip-us.apache.org/repos/asf/incubator-usergrid/commit/4a92ab09 Tree: http://git-wip-us.apache.org/repos/asf/incubator-usergrid/tree/4a92ab09 Diff: http://git-wip-us.apache.org/repos/asf/incubator-usergrid/diff/4a92ab09 Branch: refs/heads/two-dot-o-dev Commit: 4a92ab0961c625d98d51793b0921f9c1af00b57d Parents: 0bd37c9 Author: Dave Johnson <[email protected]> Authored: Wed Aug 5 10:55:15 2015 -0400 Committer: Dave Johnson <[email protected]> Committed: Wed Aug 12 13:01:34 2015 -0400 ---------------------------------------------------------------------- content/README.md | 7 + content/community/index.html | 579 + content/docs/.gitkeep | 0 content/docs/README.html | 370 + content/docs/_images/cassandra.png | Bin 0 -> 47467 bytes content/docs/_images/iOS10seeusermsg.jpg | Bin 0 -> 47979 bytes content/docs/_images/iOS1chooseapp.jpg | Bin 0 -> 43752 bytes content/docs/_images/iOS2register.jpg | Bin 0 -> 47339 bytes content/docs/_images/iOS5emptyfeed.jpg | Bin 0 -> 42009 bytes content/docs/_images/iOS6newmsg.jpg | Bin 0 -> 55357 bytes content/docs/_images/iOS7feed1msg.jpg | Bin 0 -> 45070 bytes content/docs/_images/login.png | Bin 0 -> 162318 bytes content/docs/_images/portal1.png | Bin 0 -> 202277 bytes content/docs/_images/portal2.png | Bin 0 -> 178318 bytes content/docs/_images/portal3.png | Bin 0 -> 486403 bytes content/docs/_images/portal4.png | Bin 0 -> 166079 bytes content/docs/_images/portal5.png | Bin 0 -> 217950 bytes content/docs/_images/rdbms.png | Bin 0 -> 40248 bytes content/docs/_images/reviews.png | Bin 0 -> 36333 bytes content/docs/_images/reviews2.png | Bin 0 -> 52726 bytes content/docs/_images/securitymodel0.png | Bin 0 -> 91321 bytes content/docs/_sources/README.txt | 69 + .../docs/_sources/asset-and-files/assets.txt | 20 + .../file-storage-configuration.txt | 39 + .../docs/_sources/asset-and-files/folders.txt | 85 + .../asset-and-files/legacy-asset-support.txt | 0 .../asset-and-files/retrieving-assets.txt | 27 + .../asset-and-files/uploading-assets.txt | 86 + .../creating-and-incrementing-counters.txt | 74 + .../counters-and-events/events-and-counters.txt | 8 + .../counters-and-events/retrieving-counters.txt | 109 + .../data-queries/advanced-query-usage.txt | 23 + .../data-queries/operators-and-types.txt | 120 + .../_sources/data-queries/query-language.txt | 427 + .../_sources/data-queries/query-parameters.txt | 153 + .../data-queries/querying-your-data.txt | 121 + .../docs/_sources/data-storage/collections.txt | 254 + .../_sources/data-storage/data-store-dbms.txt | 109 + content/docs/_sources/data-storage/entities.txt | 512 + .../_sources/data-storage/optimizing-access.txt | 185 + .../entity-connections/connecting-entities.txt | 60 + .../disconnecting-entities.txt | 79 + .../entity-connections/relationships.txt | 98 + .../entity-connections/retrieving-entities.txt | 94 + .../docs/_sources/geolocation/geolocation.txt | 72 + content/docs/_sources/geolocation/tbd.txt | 1 + .../creating-a-new-application.txt | 14 + .../getting-started/creating-account.txt | 21 + .../getting-started/using-a-sandbox-app.txt | 39 + .../_sources/getting-started/using-the-api.txt | 150 + content/docs/_sources/index.txt | 160 + .../installation/ug1-deploy-to-tomcat.txt | 179 + .../installation/ug1-launcher-quick-start.txt | 72 + .../installation/ug2-deploy-to-tomcat.txt | 167 + .../_sources/introduction/async-vs-sync.txt | 25 + .../docs/_sources/introduction/data-model.txt | 76 + .../_sources/introduction/usergrid-features.txt | 81 + .../docs/_sources/orgs-and-apps/admin-user.txt | 352 + .../docs/_sources/orgs-and-apps/application.txt | 100 + .../docs/_sources/orgs-and-apps/managing.txt | 50 + .../_sources/orgs-and-apps/organization.txt | 435 + .../docs/_sources/push-notifications/tbd.txt | 1 + .../push-notifications/users-devices.txt | 108 + .../docs/_sources/reference/contribute-code.txt | 18 + .../_sources/reference/presos-and-videos.txt | 31 + .../docs/_sources/rest-endpoints/api-docs.txt | 3319 + content/docs/_sources/sdks/ios.txt | 1 + content/docs/_sources/sdks/java.txt | 1 + content/docs/_sources/sdks/javascript.txt | 3 + content/docs/_sources/sdks/tbd.txt | 1 + content/docs/_sources/sdks/usage.txt | 16 + .../_sources/security-and-auth/app-security.txt | 19 + .../authenticating-api-requests.txt | 38 + ...enticating-users-and-application-clients.txt | 128 + .../changing-token-time-live-ttl.txt | 61 + .../security-and-auth/facebook-sign.txt | 158 + .../revoking-tokens-logout.txt | 32 + .../security-and-auth/securing-your-app.txt | 44 + .../user-authentication-types.txt | 63 + .../security-and-auth/using-permissions.txt | 115 + .../docs/_sources/user-management/activity.txt | 440 + content/docs/_sources/user-management/group.txt | 365 + .../docs/_sources/user-management/groups.txt | 38 + .../user-management/messagee-example.txt | 137 + .../user-management/user-connections.txt | 40 + .../user-management/user-management.txt | 42 + .../user-management/working-user-data.txt | 278 + content/docs/_static/ajax-loader.gif | Bin 0 -> 673 bytes content/docs/_static/basic.css | 599 + content/docs/_static/comment-bright.png | Bin 0 -> 3500 bytes content/docs/_static/comment-close.png | Bin 0 -> 3578 bytes content/docs/_static/comment.png | Bin 0 -> 3445 bytes content/docs/_static/css/badge_only.css | 4 + content/docs/_static/css/badge_only.css.map | 7 + content/docs/_static/css/theme.css | 5514 + content/docs/_static/css/theme.css.map | 7 + content/docs/_static/doctools.js | 263 + content/docs/_static/down-pressed.png | Bin 0 -> 347 bytes content/docs/_static/down.png | Bin 0 -> 347 bytes content/docs/_static/file.png | Bin 0 -> 358 bytes content/docs/_static/fonts/FontAwesome.otf | Bin 0 -> 62856 bytes content/docs/_static/fonts/Inconsolata-Bold.ttf | Bin 0 -> 47064 bytes content/docs/_static/fonts/Inconsolata.ttf | Bin 0 -> 63184 bytes content/docs/_static/fonts/Lato-Bold.ttf | Bin 0 -> 82368 bytes content/docs/_static/fonts/Lato-Regular.ttf | Bin 0 -> 81980 bytes content/docs/_static/fonts/RobotoSlab-Bold.ttf | Bin 0 -> 36596 bytes .../docs/_static/fonts/RobotoSlab-Regular.ttf | Bin 0 -> 36276 bytes .../docs/_static/fonts/fontawesome-webfont.eot | Bin 0 -> 38205 bytes .../docs/_static/fonts/fontawesome-webfont.svg | 414 + .../docs/_static/fonts/fontawesome-webfont.ttf | Bin 0 -> 80652 bytes .../docs/_static/fonts/fontawesome-webfont.woff | Bin 0 -> 44432 bytes content/docs/_static/jquery-1.11.1.js | 10308 ++ content/docs/_static/jquery.js | 4 + content/docs/_static/js/modernizr.min.js | 4 + content/docs/_static/js/theme.js | 131 + content/docs/_static/minus.png | Bin 0 -> 173 bytes content/docs/_static/plus.png | Bin 0 -> 173 bytes content/docs/_static/pygments.css | 63 + content/docs/_static/searchtools.js | 622 + content/docs/_static/underscore-1.3.1.js | 999 + content/docs/_static/underscore.js | 31 + content/docs/_static/up-pressed.png | Bin 0 -> 345 bytes content/docs/_static/up.png | Bin 0 -> 345 bytes content/docs/_static/websupport.js | 808 + content/docs/asset-and-files/assets.html | 331 + .../file-storage-configuration.html | 319 + content/docs/asset-and-files/folders.html | 388 + .../asset-and-files/legacy-asset-support.html | 277 + .../docs/asset-and-files/retrieving-assets.html | 356 + .../docs/asset-and-files/uploading-assets.html | 416 + .../creating-and-incrementing-counters.html | 406 + .../events-and-counters.html | 303 + .../retrieving-counters.html | 458 + .../docs/data-queries/advanced-query-usage.html | 321 + .../docs/data-queries/operators-and-types.html | 461 + content/docs/data-queries/query-language.html | 730 + content/docs/data-queries/query-parameters.html | 511 + .../docs/data-queries/querying-your-data.html | 453 + content/docs/data-storage/collections.html | 670 + content/docs/data-storage/data-store-dbms.html | 423 + content/docs/data-storage/entities.html | 1014 + .../docs/data-storage/optimizing-access.html | 557 + .../entity-connections/connecting-entities.html | 378 + .../disconnecting-entities.html | 395 + .../docs/entity-connections/relationships.html | 379 + .../entity-connections/retrieving-entities.html | 419 + content/docs/genindex.html | 282 + content/docs/geolocation/geolocation.html | 413 + content/docs/geolocation/tbd.html | 280 + .../creating-a-new-application.html | 320 + .../docs/getting-started/creating-account.html | 327 + .../getting-started/using-a-sandbox-app.html | 357 + content/docs/getting-started/using-the-api.html | 491 + content/docs/index.html | 732 + .../docs/installation/ug1-deploy-to-tomcat.html | 506 + .../installation/ug1-launcher-quick-start.html | 388 + .../docs/installation/ug2-deploy-to-tomcat.html | 509 + content/docs/introduction/async-vs-sync.html | 341 + content/docs/introduction/data-model.html | 449 + .../docs/introduction/usergrid-features.html | 449 + content/docs/objects.inv | Bin 0 -> 663 bytes content/docs/orgs-and-apps/admin-user.html | 780 + content/docs/orgs-and-apps/application.html | 495 + content/docs/orgs-and-apps/managing.html | 340 + content/docs/orgs-and-apps/organization.html | 1017 + content/docs/push-notifications/tbd.html | 280 + .../docs/push-notifications/users-devices.html | 537 + content/docs/reference/contribute-code.html | 315 + content/docs/reference/presos-and-videos.html | 335 + content/docs/rest-endpoints/api-docs.html | 4192 + content/docs/sdks/ios.html | 280 + content/docs/sdks/java.html | 280 + content/docs/sdks/javascript.html | 280 + content/docs/sdks/tbd.html | 291 + content/docs/sdks/usage.html | 308 + content/docs/search.html | 293 + content/docs/searchindex.js | 1 + .../docs/security-and-auth/app-security.html | 320 + .../authenticating-api-requests.html | 367 + ...nticating-users-and-application-clients.html | 528 + .../changing-token-time-live-ttl.html | 389 + .../docs/security-and-auth/facebook-sign.html | 506 + .../revoking-tokens-logout.html | 342 + .../security-and-auth/securing-your-app.html | 398 + .../user-authentication-types.html | 399 + .../security-and-auth/using-permissions.html | 510 + content/docs/user-management/activity.html | 867 + content/docs/user-management/group.html | 824 + content/docs/user-management/groups.html | 398 + .../docs/user-management/messagee-example.html | 485 + .../docs/user-management/user-connections.html | 358 + .../docs/user-management/user-management.html | 372 + .../docs/user-management/working-user-data.html | 700 + content/index.html | 264 + content/releases/index.html | 235 + docs/README.md | 49 +- docs/update-api-docs.sh | 4 +- docs/update-website.sh | 6 + website/README.md | 54 + website/content/community/index.html | 240 + website/layouts/default.html | 44 + website/layouts/footer.html | 94 + website/layouts/header.html | 229 + website/tmp/checksums | 2 + website/tmp/compiled_content | 91671 +++++++++++++++++ website/tmp/dependencies | Bin 0 -> 2372 bytes 206 files changed, 157440 insertions(+), 25 deletions(-) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/incubator-usergrid/blob/4a92ab09/content/README.md ---------------------------------------------------------------------- diff --git a/content/README.md b/content/README.md new file mode 100644 index 0000000..0bbec7e --- /dev/null +++ b/content/README.md @@ -0,0 +1,7 @@ +# Generated Website and Docs Content + +__DO NOT EDIT FILES IN THIS DIRECTORY__ + +The files here were generated by tools in the ``/docs`` and ``/website`` directories. + +See the README files there for information about updating the docs and website. \ No newline at end of file http://git-wip-us.apache.org/repos/asf/incubator-usergrid/blob/4a92ab09/content/community/index.html ---------------------------------------------------------------------- diff --git a/content/community/index.html b/content/community/index.html new file mode 100644 index 0000000..c78171e --- /dev/null +++ b/content/community/index.html @@ -0,0 +1,579 @@ +<!DOCTYPE html> +<html lang="en"> + +<head> + <meta charset="utf-8"> + <title>Apache Usergrid (incubating) â </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'> + + + <script type="text/javascript" + src="https://maps.googleapis.com/maps/api/js?key=AIzaSyBYSxyIKS22zC4wSLFXZGR8QKXbGWLFwYw&sensor=false"> + </script> + <script type="text/javascript"> + + var points = [ + new google.maps.LatLng(-33.8674869,151.2069902), + new google.maps.LatLng(40.2338438,-111.6585337), + new google.maps.LatLng(37.6909682,-122.3107517), + new google.maps.LatLng(-37.6825027,176.1880232), + new google.maps.LatLng(-0.023559,37.906193), + new google.maps.LatLng(41.00527,28.97696), + new google.maps.LatLng(47.1569444,27.5902778), + new google.maps.LatLng(49.261226,-123.1139268), + new google.maps.LatLng(55.378051,-3.435973), + new google.maps.LatLng(30.3321838,-81.65565099999999), + new google.maps.LatLng(30.267153,-97.7430608), + new google.maps.LatLng(-14.235004,-51.92528), + new google.maps.LatLng(41.76371109999999,-72.6850932), + new google.maps.LatLng(53.3498053,-6.2603097), + new google.maps.LatLng(-37.814107,144.96328), + new google.maps.LatLng(26.820553,30.802498), + new google.maps.LatLng(34.0522342,-118.2436849), + new google.maps.LatLng(37.566535,126.9779692), + new google.maps.LatLng(7.873053999999999,80.77179699999999), + new google.maps.LatLng(39.737567,-104.9847179), + new google.maps.LatLng(52.9399159,-73.5491361), + new google.maps.LatLng(40.7143528,-74.00597309999999), + new google.maps.LatLng(44.9374831,-93.20099979999999), + new google.maps.LatLng(38.963745,35.243322), + new google.maps.LatLng(35.7795897,-78.6381787), + new google.maps.LatLng(35.907757,127.766922), + new google.maps.LatLng(-6.2689913,106.8060388), + new google.maps.LatLng(27.3364347,-82.53065269999999), + new google.maps.LatLng(44.494887,11.3426163), + new google.maps.LatLng(39.952335,-75.16378900000001), + new google.maps.LatLng(37.09024,-95.712891), + new google.maps.LatLng(40.5852602,-105.084423), + new google.maps.LatLng(43.653226,-79.3831843), + new google.maps.LatLng(47.6062095,-122.3320708), + new google.maps.LatLng(31.046051,34.851612), + new google.maps.LatLng(51.41233,-0.300689), + new google.maps.LatLng(39.4699075,-0.3762881), + new google.maps.LatLng(51.51121389999999,-0.1198244), + new google.maps.LatLng(42.3556899,-83.361853), + new google.maps.LatLng(33.4483771,-112.0740373), + new google.maps.LatLng(45.5234515,-122.6762071), + new google.maps.LatLng(43.0730517,-89.4012302), + new google.maps.LatLng(36.1031378,-80.202394), + new google.maps.LatLng(37.7749295,-122.4194155), + new google.maps.LatLng(5.263234100000001,100.4846227), + new google.maps.LatLng(35.5950581,-82.5514869), + new google.maps.LatLng(35.86166,104.195397), + new google.maps.LatLng(34.4208305,-119.6981901), + new google.maps.LatLng(1.352083,103.819836), + new google.maps.LatLng(36.8507689,-76.28587259999999), + new google.maps.LatLng(22.396428,114.109497), + new google.maps.LatLng(48.856614,2.3522219), + new google.maps.LatLng(40.4167754,-3.7037902), + new google.maps.LatLng(18.5204303,73.8567437), + new google.maps.LatLng(36.1666667,-86.7833333), + new google.maps.LatLng(53.3498053,-6.2603097), + new google.maps.LatLng(26.0993883,-80.1343301), + new google.maps.LatLng(42.331427,-83.0457538), + new google.maps.LatLng(37.82206000000001,-122.272437), + new google.maps.LatLng(30.42130899999999,-87.2169149), + new google.maps.LatLng(44.4325,26.1038889), + new google.maps.LatLng(41.0700485,-81.49516210000002), + new google.maps.LatLng(12.9715987,77.5945627), + new google.maps.LatLng(53.41291,-8.24389), + new google.maps.LatLng(34.0583995,-106.8914159), + new google.maps.LatLng(-9.189967,-75.015152), + new google.maps.LatLng(55.6760968,12.5683371), + new google.maps.LatLng(53.9807737,-6.7148821), + new google.maps.LatLng(31.230416,121.473701), + new google.maps.LatLng(33.7489954,-84.3879824), + new google.maps.LatLng(8.4874949,76.948623), + new google.maps.LatLng(13.0524139,80.25082460000002), + new google.maps.LatLng(28.0836269,-80.60810889999999), + new google.maps.LatLng(39.0457549,-76.64127119999999), + new google.maps.LatLng(17.385044,78.486671), + new google.maps.LatLng(-23.5489433,-46.6388182), + new google.maps.LatLng(52.09179,5.114569899999999), + new google.maps.LatLng(19.2667,76.7833), + new google.maps.LatLng(19.0759837,72.8776559), + new google.maps.LatLng(12.9715987,77.5945627), + new google.maps.LatLng(41.1566892,-8.6239254), + new google.maps.LatLng(39.90403,116.407526), + new google.maps.LatLng(42.3584308,-71.0597732), + new google.maps.LatLng(32.725409,-97.3208496), + new google.maps.LatLng(39.074208,21.824312), + new google.maps.LatLng(10.066049,123.538599), + new google.maps.LatLng(37.42410599999999,-122.1660756), + new google.maps.LatLng(36.204824,138.252924) + ]; + + var map; + var markers = []; + var iterator = 0; + var dropped = false; + var recentered = false; + + function initialize() { + var mapOptions = { + center: new google.maps.LatLng(0,0), + //draggable: false, + //zoomControl: false, + scrollwheel: false, + streetViewControl: false, + mapTypeControl: false, + panControl: false, + //disableDoubleClickZoom: true, + zoom: 2, + //disableDefaultUI: true, + mapTypeId: google.maps.MapTypeId.ROADMAP + }; + map = new google.maps.Map(document.getElementById("map-canvas"), + mapOptions); + + google.maps.event.addDomListener(map, 'idle', function() { + if (recentered == false) { + map.setCenter(new google.maps.LatLng(20,0)); + recentered = true; + } + }); + + var bounds = new google.maps.LatLngBounds(); + + // Extend bounds with each point + for (var i = 0; i < points.length; i++) { + bounds.extend(points[i]); + } + map.fitBounds(bounds); + + if (document.hasFocus()) { + dropped = true; + drop(); + } + + + } + function drop() { + dropped = true; + for (var i = 0; i < points.length; i++) { + setTimeout(function() { + addMarker(); + }, i * 50); + } + } + + function addMarker() { + markers.push(new google.maps.Marker({ + position: points[iterator], + map: map, + draggable: false, + animation: google.maps.Animation.DROP + })); + iterator++; + } + + google.maps.event.addDomListener(window, 'load', initialize); + + window.onfocus = function () { + if (dropped == false) { + drop(); + } + }; + </script> + + + <!-- 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="active"><a href="/community/"><span class="icns icon-group"></span></a></li> + <li><a href="docs" 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 id="map-canvas" style="width: 100%;"></div> + +<section class="bf-tagline"> + <div class="container"> + <div class="row"> + <div class="col-md-12"> + <h2>The Apache Usergrid community has members in 170+ cities in 30 countries on 6 continents</h2> + </div> + </div> + </div> +</section> + + +<section class="bf-community"> + <div class="container"> + <div class="row"> + <div class="col-md-12" id="events"> + <h2 class="icns-calendar"><span>Events</span></h2> + </div> + </div> + <div class="row"> + <div class="col-md-3 done"> + <h3><a href=http://events.linuxfoundation.org/events/apachecon-north-america/">ApacheCon Denver</a><small>April 7-9</small></h3> + <p>Featuring our very own Dave Johnson who will deliver a talk on <a href="http://www.slideshare.net/snoopdave/how-to-contribute-to-apache-usergrid">"How to contribute to Apache Usergrid"</a><p> + </div> + <div class="col-md-3 done"> + <h3>Seoul Hack Day #1 <small>January 24</small></h3> + <p>KT is hosting a Usergrid evening in Gangnam, Seoul, South Korea! <a href="http://onoffmix.com/event/22000">Register on OnOffMix.com</a><p> + </div> + <div class="col-md-3 done"> + <h3>SF Bay Area Meetup #1 <small>January 23</small></h3> + <p>Canât join us for the afternoon hack day? Weâll host an evening meetup right afterwards! Or join us for both! <a href="http://www.meetup.com/apache-usergrid-bay-area/events/155130862/">Register on Meetup.com</a><p> + </div> + <div class="col-md-3"> + <h3> </h3> + <p><i>Want to organize a Usergrid event? <a href="mailto:[email protected]">Contact us!</a></i><p> + </div> + </div> + </div> +</section> + +<section class="bf-community"> + <div class="container"> + <div class="row"> + <div class="col-md-12" id="live"> + <h2 class="icns-chat"><span>Live Chat</span></h2> + </div> + </div> + <div class="row"> + <div class="col-md-3 done"> + <h3><a href="https://www.hipchat.com/gDDIQrdQa">HipChat</a></h3> + <p>Some of the Usergrid team hangs around in this HipChat Room: <a href="https://www.hipchat.com/gDDIQrdQa" target="_blank">https://www.hipchat.com/gDDIQrdQa</a>. Come by and chat for a spell!<p> + </div> + <div class="col-md-3 done"> + <h3>IRC</h3> + <p>Another (less used) option is the Usergrid IRC chat channel <a href="http://webchat.freenode.net/?channels=%23usergrid&uio=d4" target="_blank">#usergrid</a>.<p> + </div> + </div> +</section> + +<section class="bf-community"> + <div class="container"> + <div class="row"> + <div class="col-md-12"> + <h2 class="icns-envelope" id="mailing-lists"><span>Mailing-lists</span></h2> + </div> + </div> + <div class="row"> + <div class="col-md-4"> + <h3>Users</h3> + <p><em>Perfect if you build apps against Apache Usergrid or deploy Apache Usergrid.</em></p> + <p>To subscribe, send a blank email to<br/><a href="mailto:[email protected]">[email protected]</a>.</p> + <p>You can also <a href="https://mail-archives.apache.org/mod_mbox/incubator-usergrid-user/">read the archives</a>.</p> + </div> + <div class="col-md-4"> + <h3>Dev</h3> + <p><em>If you are building contributions & modifications to Apache Usergridâs stack, portal, cli and SDKs, this is the list for you.</em><p> + <p>To subscribe, send a blank email to<br/><a href="mailto:[email protected]">[email protected]</a>.</p> + <p>You can also <a href="https://mail-archives.apache.org/mod_mbox/incubator-usergrid-dev/">read the archives</a>.</p> + </div> + <div class="col-md-4"> + <h3>Commits</h3> + <p><em>This list receives an email whenever new code is contributed to Apache Usergrid.</em><p> + <p>To subscribe, send a blank email to<br/><a href="mailto:[email protected]">[email protected]</a>.</p> + <p>You can also <a href="https://mail-archives.apache.org/mod_mbox/incubator-usergrid-commits/">read the archives</a>.</p> + </div> + </div> + </div> +</section> + +<section class="bf-community"> + <div class="container"> + <div class="row"> + <div class="col-md-12"> + <h2 class="icns-briefcase" id="deployments"><span>Deployments</span></h2> + </div> + </div> + <div class="row"> + <a href="http://baas.io"> + <div class="col-md-3"> + <h3>baas.io (Korea Telecom)</h3> + <p>Korea Telecom uses Apache Usergrid as the core of its public mobile application development platform baas.io, in operation since 2012.<p> + </div> + </a> + <a href="http://globo.com"> + <div class="col-md-3"> + <h3>Globo.com</h3> + <p>Brazilian media conglomerate Globo uses Apache Usergrid as part of its internal publishing platform for globo.com<p> + </div> + </a> + <a href="http://developers.apigee.com"> + <div class="col-md-3"> + <h3>Apigee</h3> + <p>Californian startup Apigee uses Apache Usergrid as a component of its cloud developer platform<p> + </div> + </a> + <a href="http://easemob.com"> + <h3>Easemob</h3> + <p>Easemob uses Apache Usergrid as part of its <a href="http://easemob.com">IM Cloud development platform</a>, which provides cloud service for app developers to integrate IM service in munites.<p> + </div> + </a> + <div class="col-md-3"> + <h3> </h3> + <p><i>Want to be added to this list? <a href="mailto:[email protected]">Contact us!</a></i><p> + </div> + </div> + </div> +</section> + +<section class="bf-community committers"> + <div class="container"> + <div class="row"> + <div class="col-md-12"> + <h2 class="icns-group" id="committers"><span>Committers</span></h2> + </div> + </div> + <div class="row"> + <div class="col-md-2 text-center"> + <img src="/img/alberto.jpg" /> + <p>Alberto Leal</p> + </div> + <div class="col-md-2 text-center"> + <img src="/img/alex.png" /> + <p>Alex Karasulu</p> + </div> + <div class="col-md-2 text-center"> + <img src="/img/github.png" /> + <p>Askhat Asanaliev</p> + </div> + <div class="col-md-2 text-center"> + <img src="/img/dave.jpg" /> + <p>Dave Johnson</p> + </div> + <div class="col-md-2 text-center"> + <img src="/img/ed.jpg" /> + <p>Ed Anuff</p> + </div> + <div class="col-md-2 text-center"> + <img src="/img/github.png" /> + <p>Furkan Bicak</p> + </div> + </div> + <div class="row"> + <div class="col-md-2 text-center"> + <img src="/img/grey.png" /> + <p>George Reyes</p> + </div> + <div class="col-md-2 text-center"> + <img src="/img/nate.jpg" /> + <p>Nate McCall</p> + </div> + <div class="col-md-2 text-center"> + <img src="/img/rod.jpg" /> + <p>Rod Simpson</p> + </div> + <div class="col-md-2 text-center"> + <img src="/img/scott.jpg" /> + <p>Scott Ganyo</p> + </div> + <div class="col-md-2 text-center"> + <img src="/img/stliu.jpg" /> + <p>Shaozhuang Liu</p> + </div> + <div class="col-md-2 text-center"> + <img src="/img/shawn.jpg" /> + <p>Shawn Feldman</p> + </div> + </div> + <div class="row"> + <div class="col-md-2 text-center"> + <img src="/img/sungju.jpg" /> + <p>Sungju Jin</p> + </div> + <div class="col-md-2 text-center"> + <img src="/img/tim.jpg" /> + <p>Tim Anglade</p> + </div> + <div class="col-md-2 text-center"> + <img src="/img/todd.jpg" /> + <p>Todd Nine</p> + </div> + <div class="col-md-2 text-center"> + <img src="/img/github.png" /> + <p>Yigit Sapli</p> + </div> + <div class="col-md-2 text-center"> + <img src="/img/jeff.jpg" /> + <p>Jeff West</p> + </div> + <div class="col-md-2 text-center"> + </div> + </div> + </div> +</section> + +<section class="bf-community tools"> + <div class="container"> + <div class="row"> + <div class="col-md-12"> + <h2 class="icns-tools" id="tools"><span>Tools</span></h2> + </div> + </div> + <div class="row"> + <div class="col-md-2 text-center"> + <a href="http://www.jetbrains.com/idea/" target="_blank"><img src="/img/intellij.png" /></a> + <p>IntelliJ IDEA</p> + </div> + <div class="col-md-2 text-center"> + <a href="http://yourkit.com/" target="_blank"><img src="/img/yourkit.jpeg" /></a> + <p>YourKit Java Profiler</p> + </div> + <div class="col-md-2 text-center"> + <a href="http://structure101.com/" target="_blank"><img src="/img/structure101.png" /></a> + <p>structure101</p> + </div> + </div> + These great companies have provided free product licenses to the Apache Usergrid team. We use these tools and love them. Thank you! + </div> +</section> + + + + +<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="docs" 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> + <a href="https://twitter.com/snoopdave">@snoopdave</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/4a92ab09/content/docs/.gitkeep ---------------------------------------------------------------------- diff --git a/content/docs/.gitkeep b/content/docs/.gitkeep new file mode 100644 index 0000000..e69de29 http://git-wip-us.apache.org/repos/asf/incubator-usergrid/blob/4a92ab09/content/docs/README.html ---------------------------------------------------------------------- diff --git a/content/docs/README.html b/content/docs/README.html new file mode 100644 index 0000000..7abe7ff --- /dev/null +++ b/content/docs/README.html @@ -0,0 +1,370 @@ + + +<!DOCTYPE html> +<!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]--> +<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]--> +<head> + <meta charset="utf-8"> + + <meta name="viewport" content="width=device-width, initial-scale=1.0"> + + <title>Apache Usergrid Documentation — Apache Usergrid 1.0 documentation</title> + + + + + + + + + + + + + + + + <link rel="stylesheet" href="_static/css/theme.css" type="text/css" /> + + + + + + <link rel="top" title="Apache Usergrid 1.0 documentation" href="index.html"/> + + + <script src="_static/js/modernizr.min.js"></script> + +</head> + +<body class="wy-body-for-nav" role="document"> + + <div class="wy-grid-for-nav"> + + + <nav data-toggle="wy-nav-shift" class="wy-nav-side"> + <div class="wy-side-nav-search"> + + + + <a href="index.html" class="icon icon-home"> Apache Usergrid + + + + </a> + + + + + <div class="version"> + 1.0 + </div> + + + + +<div role="search"> + <form id="rtd-search-form" class="wy-form" action="search.html" method="get"> + <input type="text" name="q" placeholder="Search docs" /> + <input type="hidden" name="check_keywords" value="yes" /> + <input type="hidden" name="area" value="default" /> + </form> +</div> + + + </div> + + <div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation"> + + + + <p class="caption"><span class="caption-text">Introduction</span></p> +<ul> +<li class="toctree-l1"><a class="reference internal" href="introduction/usergrid-features.html">Usergrid Features</a></li> +<li class="toctree-l1"><a class="reference internal" href="introduction/data-model.html">Usergrid Data model</a></li> +<li class="toctree-l1"><a class="reference internal" href="introduction/async-vs-sync.html">Async vs. sync calls</a></li> +</ul> +<p class="caption"><span class="caption-text">Getting Started</span></p> +<ul> +<li class="toctree-l1"><a class="reference internal" href="getting-started/creating-a-new-application.html">Creating a new application</a></li> +<li class="toctree-l1"><a class="reference internal" href="getting-started/creating-account.html">Creating an Usergrid Account</a></li> +<li class="toctree-l1"><a class="reference internal" href="getting-started/using-a-sandbox-app.html">Using a Sandbox Application</a></li> +<li class="toctree-l1"><a class="reference internal" href="getting-started/using-the-api.html">Using the API</a></li> +</ul> +<p class="caption"><span class="caption-text">Data Storage</span></p> +<ul> +<li class="toctree-l1"><a class="reference internal" href="data-storage/data-store-dbms.html">The Usergrid Data Store</a></li> +<li class="toctree-l1"><a class="reference internal" href="data-storage/optimizing-access.html">Data Store Best Practices</a></li> +<li class="toctree-l1"><a class="reference internal" href="data-storage/collections.html">Collections</a></li> +<li class="toctree-l1"><a class="reference internal" href="data-storage/entities.html">Entities</a></li> +</ul> +<p class="caption"><span class="caption-text">Data Queries</span></p> +<ul> +<li class="toctree-l1"><a class="reference internal" href="data-queries/querying-your-data.html">Querying your data</a></li> +<li class="toctree-l1"><a class="reference internal" href="data-queries/query-parameters.html">Query parameters & clauses</a></li> +<li class="toctree-l1"><a class="reference internal" href="data-queries/operators-and-types.html">Query operators & data types</a></li> +<li class="toctree-l1"><a class="reference internal" href="data-queries/advanced-query-usage.html">Advanced query usage</a></li> +</ul> +<p class="caption"><span class="caption-text">Entity Connections</span></p> +<ul> +<li class="toctree-l1"><a class="reference internal" href="entity-connections/connecting-entities.html">Connecting entities</a></li> +<li class="toctree-l1"><a class="reference internal" href="entity-connections/retrieving-entities.html">Retrieving connections</a></li> +<li class="toctree-l1"><a class="reference internal" href="entity-connections/disconnecting-entities.html">Disconnecting entities</a></li> +</ul> +<p class="caption"><span class="caption-text">Security & Authentication</span></p> +<ul> +<li class="toctree-l1"><a class="reference internal" href="security-and-auth/app-security.html">Security & token authentication</a></li> +<li class="toctree-l1"><a class="reference internal" href="security-and-auth/using-permissions.html">Using permissions</a></li> +<li class="toctree-l1"><a class="reference internal" href="security-and-auth/authenticating-users-and-application-clients.html">Authenticating users & app clients</a></li> +<li class="toctree-l1"><a class="reference internal" href="security-and-auth/user-authentication-types.html">Authentication levels</a></li> +<li class="toctree-l1"><a class="reference internal" href="security-and-auth/changing-token-time-live-ttl.html">Changing token expiration (time-to-live)</a></li> +<li class="toctree-l1"><a class="reference internal" href="security-and-auth/authenticating-api-requests.html">Authenticating API requests</a></li> +<li class="toctree-l1"><a class="reference internal" href="security-and-auth/revoking-tokens-logout.html">Revoking tokens (logout)</a></li> +<li class="toctree-l1"><a class="reference internal" href="security-and-auth/facebook-sign.html">Facebook sign in</a></li> +<li class="toctree-l1"><a class="reference internal" href="security-and-auth/securing-your-app.html">Security best practices</a></li> +</ul> +<p class="caption"><span class="caption-text">User Management & Social Graph</span></p> +<ul> +<li class="toctree-l1"><a class="reference internal" href="user-management/user-management.html">User management & social graph</a></li> +<li class="toctree-l1"><a class="reference internal" href="user-management/working-user-data.html">Working with User Data</a></li> +<li class="toctree-l1"><a class="reference internal" href="user-management/group.html">Working with group data</a></li> +<li class="toctree-l1"><a class="reference internal" href="user-management/activity.html">Activity</a></li> +<li class="toctree-l1"><a class="reference internal" href="user-management/user-connections.html">Social Graph Connections</a></li> +<li class="toctree-l1"><a class="reference internal" href="user-management/user-connections.html#creating-other-connections">Creating other connections</a></li> +<li class="toctree-l1"><a class="reference internal" href="user-management/messagee-example.html">App Example - Messagee</a></li> +</ul> +<p class="caption"><span class="caption-text">Geo-location</span></p> +<ul> +<li class="toctree-l1"><a class="reference internal" href="geolocation/geolocation.html">Geolocating your Entities</a></li> +</ul> +<p class="caption"><span class="caption-text">Assets & Files</span></p> +<ul> +<li class="toctree-l1"><a class="reference internal" href="asset-and-files/uploading-assets.html">Uploading assets</a></li> +<li class="toctree-l1"><a class="reference internal" href="asset-and-files/retrieving-assets.html">Retrieving assets</a></li> +<li class="toctree-l1"><a class="reference internal" href="asset-and-files/folders.html">Folders</a></li> +</ul> +<p class="caption"><span class="caption-text">Counters & Events</span></p> +<ul> +<li class="toctree-l1"><a class="reference internal" href="counters-and-events/events-and-counters.html">Counters & events</a></li> +<li class="toctree-l1"><a class="reference internal" href="counters-and-events/creating-and-incrementing-counters.html">Creating & incrementing counters</a></li> +<li class="toctree-l1"><a class="reference internal" href="counters-and-events/creating-and-incrementing-counters.html#decrementing-resetting-counters">Decrementing/resetting counters</a></li> +<li class="toctree-l1"><a class="reference internal" href="counters-and-events/creating-and-incrementing-counters.html#using-counters-hierarchically">Using counters hierarchically</a></li> +<li class="toctree-l1"><a class="reference internal" href="counters-and-events/retrieving-counters.html">Retrieving counters</a></li> +</ul> +<p class="caption"><span class="caption-text">Organizations & Applications</span></p> +<ul> +<li class="toctree-l1"><a class="reference internal" href="orgs-and-apps/managing.html">Organization & application management</a></li> +<li class="toctree-l1"><a class="reference internal" href="orgs-and-apps/organization.html">Organization</a></li> +<li class="toctree-l1"><a class="reference internal" href="orgs-and-apps/application.html">Application</a></li> +</ul> +<p class="caption"><span class="caption-text">API Reference</span></p> +<ul> +<li class="toctree-l1"><a class="reference internal" href="rest-endpoints/api-docs.html">Methods</a></li> +<li class="toctree-l1"><a class="reference internal" href="rest-endpoints/api-docs.html#models">Models</a></li> +</ul> +<p class="caption"><span class="caption-text">Client SDKs</span></p> +<ul> +<li class="toctree-l1"><a class="reference internal" href="sdks/tbd.html">COMING SOON...</a></li> +</ul> +<p class="caption"><span class="caption-text">Installing the Stack</span></p> +<ul> +<li class="toctree-l1"><a class="reference internal" href="installation/ug1-deploy-to-tomcat.html">Usegrid 1: Deploying to Tomcat</a></li> +<li class="toctree-l1"><a class="reference internal" href="installation/ug1-launcher-quick-start.html">Usegrid 1: Launcher Quick-start</a></li> +<li class="toctree-l1"><a class="reference internal" href="installation/ug2-deploy-to-tomcat.html">Usergrid 2: Deploy to Tomcat</a></li> +</ul> +<p class="caption"><span class="caption-text">More about Usergrid</span></p> +<ul> +<li class="toctree-l1"><a class="reference internal" href="reference/presos-and-videos.html">Presentations & Videos</a></li> +<li class="toctree-l1"><a class="reference internal" href="reference/contribute-code.html">How to Contribute Code & Docs</a></li> +</ul> + + + + </div> + + </nav> + + <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"> + + + <nav class="wy-nav-top" role="navigation" aria-label="top navigation"> + <i data-toggle="wy-nav-top" class="fa fa-bars"></i> + <a href="index.html">Apache Usergrid</a> + </nav> + + + + <div class="wy-nav-content"> + <div class="rst-content"> + <div role="navigation" aria-label="breadcrumbs navigation"> + <ul class="wy-breadcrumbs"> + <li><a href="index.html">Docs</a> »</li> + + <li>Apache Usergrid Documentation</li> + <li class="wy-breadcrumbs-aside"> + + + <a href="_sources/README.txt" rel="nofollow"> View page source</a> + + + </li> + </ul> + <hr/> +</div> + <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article"> + <div itemprop="articleBody"> + + <div class="section" id="apache-usergrid-documentation"> +<h1>Apache Usergrid Documentation<a class="headerlink" href="#apache-usergrid-documentation" title="Permalink to this headline">¶</a></h1> +<p>Usergrid documentation is written in +<a class="reference external" href="https://help.github.com/articles/markdown-basics/">Markdown</a> (*.md) +and RST (.rst) formats and we use the Python based +<a class="reference external" href="http://sphinx-doc.org/">Sphinx-Docs</a> documentation system to +transform our Markdown and RST files to HTML format.</p> +<div class="section" id="prerequisites"> +<h2>Prerequisites<a class="headerlink" href="#prerequisites" title="Permalink to this headline">¶</a></h2> +<p>Sphinx requires Python and pip. Once you have Python, you can install +sphinx and pip like so:</p> +<div class="highlight-python"><div class="highlight"><pre>$ sudo easy_install sphinx +$ sudo easy_install pip +</pre></div> +</div> +</div> +<div class="section" id="how-to-change-update-the-usergrid-documentation"> +<h2>How to change/update the Usergrid documentation<a class="headerlink" href="#how-to-change-update-the-usergrid-documentation" title="Permalink to this headline">¶</a></h2> +</div> +<div class="section" id="how-to-build-the-usergrid-documentation-using-sphinx"> +<h2>How to build the Usergrid documentation using Sphinx<a class="headerlink" href="#how-to-build-the-usergrid-documentation-using-sphinx" title="Permalink to this headline">¶</a></h2> +<p>Sphinx runs via a Makefile in this, the docs directory. So, cd to this +directory and make html:</p> +<div class="highlight-python"><div class="highlight"><pre>cd $usergrid/docs +make clean html +</pre></div> +</div> +</div> +<div class="section" id="how-to-update-the-usergrid-docs"> +<h2>How to update the Usergrid docs<a class="headerlink" href="#how-to-update-the-usergrid-docs" title="Permalink to this headline">¶</a></h2> +<p>Find the Markdown (.md) or reST (.rst) files that you need to change, +edit them and then run <code class="docutils literal"><span class="pre">make</span> <span class="pre">clean</span> <span class="pre">html</span></code> to generate the HTML into the +<code class="docutils literal"><span class="pre">target/html</span></code> directory, where you can preview your changes.</p> +<div class="section" id="note-the-difference-between-rst-and-markdown-files"> +<h3>Note the difference between RST and Markdown files<a class="headerlink" href="#note-the-difference-between-rst-and-markdown-files" title="Permalink to this headline">¶</a></h3> +<p>Note that Sphinx’s native format is +<a class="reference external" href="http://docutils.sourceforge.net/rst.html">reStructuredText</a> (RST) +and not Markdown. This causes some issues. For example, using Sphinx +directives in Markdown files sometimes works and sometimes does not. RST +is a different format than Markdown and it has a different set of +directives, some very useful for organizing a large set of documentation +files.</p> +</div> +<div class="section" id="updating-the-table-of-contents"> +<h3>Updating the Table of Contents<a class="headerlink" href="#updating-the-table-of-contents" title="Permalink to this headline">¶</a></h3> +<p>The Table of Contents for the documentation is in index.rst, which ties +everything together with a series of RST <strong>toctree</strong> directives. All +other files should be written in Markdown, unless they need some special +RST directives that will not work in Markdown.</p> +</div> +<div class="section" id="dealing-with-other-tables"> +<h3>Dealing with other tables<a class="headerlink" href="#dealing-with-other-tables" title="Permalink to this headline">¶</a></h3> +<p>A note about tables. Markdown and reST do not have very good table +support. Simple tables are easy to do and you can find examples (e.g. +connecting-entities.md) but for tables with multiple lines in each cell, +you’ll probably want to use a raw HTML table, and there are plenty of +examples of that around too.</p> +</div> +</div> +<div class="section" id="how-to-publish-the-usergrid-docs-to-usergrid-website"> +<h2>How to publish the Usergrid docs to Usergrid website<a class="headerlink" href="#how-to-publish-the-usergrid-docs-to-usergrid-website" title="Permalink to this headline">¶</a></h2> +<p>To update the Usergrid website you must copy the udpated docs files from +<code class="docutils literal"><span class="pre">target/html</span></code> directory to the website directory at the root of the +Usergrid project, i.e. <code class="docutils literal"><span class="pre">${usergrid-project-dir}/website/docs</span></code>.</p> +<p>You can do this by running the script <code class="docutils literal"><span class="pre">update-website.sh</span></code>.</p> +<p>Once you’ve done that then you should follow the instructions in the +website/README.md file, which explains how to update the website.</p> +</div> +<div class="section" id="updating-the-rest-api-reference"> +<h2>Updating the REST API reference<a class="headerlink" href="#updating-the-rest-api-reference" title="Permalink to this headline">¶</a></h2> +<p>The REST API documentation in <code class="docutils literal"><span class="pre">rest-endpoints/api-docs.md</span></code> is +generated from a Swagger file in the directory <code class="docutils literal"><span class="pre">src/main/resources</span></code>, +so DO NOT edit that file directly.</p> +<p>If you need to update the REST API docs, you should edit the +usergrid-swagger.yaml file and then re-generate the file.</p> +<p>If you need to change the formatting of the REST API docs, then you will +need to edit the Mustache templates in <code class="docutils literal"><span class="pre">src/main/resource</span></code> and you may +need to edit the Groovy script that does the generation: +<code class="docutils literal"><span class="pre">src/main/groovy/usergrid.ApiDocGenerator</span></code>.</p> +<p>You will need: * Groovy 2.x * +<a class="reference external" href="https://github.com/spullara/mustache.java">Mustache.java</a></p> +<p><strong>NOTE</strong>: Mustache.hava is not in Maven Central so unfortunately, you +will have to Git Clone Mustache.java before you can run the generation +script.</p> +<p>This is the command to run the generation:</p> +<div class="highlight-python"><div class="highlight"><pre>groovy src/main/groovy/usergrid.ApiDocGenerator.groovy +</pre></div> +</div> +<p>The script will update the file <code class="docutils literal"><span class="pre">rest-endpoints/api-docs.md</span></code> and when +you are happy with your update you should commit and push that file with +Git.</p> +</div> +</div> + + + </div> + </div> + <footer> + + + <hr/> + + <div role="contentinfo"> + <p> + © Copyright 2013-2015, Apache Usergrid. + + </p> + </div> + Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a <a href="https://github.com/snide/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>. + +</footer> + + </div> + </div> + + </section> + + </div> + + + + + + <script type="text/javascript"> + var DOCUMENTATION_OPTIONS = { + URL_ROOT:'./', + VERSION:'1.0', + COLLAPSE_INDEX:false, + FILE_SUFFIX:'.html', + HAS_SOURCE: true + }; + </script> + <script type="text/javascript" src="_static/jquery.js"></script> + <script type="text/javascript" src="_static/underscore.js"></script> + <script type="text/javascript" src="_static/doctools.js"></script> + + + + + + <script type="text/javascript" src="_static/js/theme.js"></script> + + + + + <script type="text/javascript"> + jQuery(function () { + SphinxRtdTheme.StickyNav.enable(); + }); + </script> + + +</body> +</html> \ No newline at end of file http://git-wip-us.apache.org/repos/asf/incubator-usergrid/blob/4a92ab09/content/docs/_images/cassandra.png ---------------------------------------------------------------------- diff --git a/content/docs/_images/cassandra.png b/content/docs/_images/cassandra.png new file mode 100644 index 0000000..ac72781 Binary files /dev/null and b/content/docs/_images/cassandra.png differ http://git-wip-us.apache.org/repos/asf/incubator-usergrid/blob/4a92ab09/content/docs/_images/iOS10seeusermsg.jpg ---------------------------------------------------------------------- diff --git a/content/docs/_images/iOS10seeusermsg.jpg b/content/docs/_images/iOS10seeusermsg.jpg new file mode 100644 index 0000000..dfaee31 Binary files /dev/null and b/content/docs/_images/iOS10seeusermsg.jpg differ http://git-wip-us.apache.org/repos/asf/incubator-usergrid/blob/4a92ab09/content/docs/_images/iOS1chooseapp.jpg ---------------------------------------------------------------------- diff --git a/content/docs/_images/iOS1chooseapp.jpg b/content/docs/_images/iOS1chooseapp.jpg new file mode 100644 index 0000000..e81153f Binary files /dev/null and b/content/docs/_images/iOS1chooseapp.jpg differ http://git-wip-us.apache.org/repos/asf/incubator-usergrid/blob/4a92ab09/content/docs/_images/iOS2register.jpg ---------------------------------------------------------------------- diff --git a/content/docs/_images/iOS2register.jpg b/content/docs/_images/iOS2register.jpg new file mode 100644 index 0000000..7666320 Binary files /dev/null and b/content/docs/_images/iOS2register.jpg differ http://git-wip-us.apache.org/repos/asf/incubator-usergrid/blob/4a92ab09/content/docs/_images/iOS5emptyfeed.jpg ---------------------------------------------------------------------- diff --git a/content/docs/_images/iOS5emptyfeed.jpg b/content/docs/_images/iOS5emptyfeed.jpg new file mode 100644 index 0000000..6b03c67 Binary files /dev/null and b/content/docs/_images/iOS5emptyfeed.jpg differ http://git-wip-us.apache.org/repos/asf/incubator-usergrid/blob/4a92ab09/content/docs/_images/iOS6newmsg.jpg ---------------------------------------------------------------------- diff --git a/content/docs/_images/iOS6newmsg.jpg b/content/docs/_images/iOS6newmsg.jpg new file mode 100644 index 0000000..0fe6164 Binary files /dev/null and b/content/docs/_images/iOS6newmsg.jpg differ http://git-wip-us.apache.org/repos/asf/incubator-usergrid/blob/4a92ab09/content/docs/_images/iOS7feed1msg.jpg ---------------------------------------------------------------------- diff --git a/content/docs/_images/iOS7feed1msg.jpg b/content/docs/_images/iOS7feed1msg.jpg new file mode 100644 index 0000000..f64d378 Binary files /dev/null and b/content/docs/_images/iOS7feed1msg.jpg differ http://git-wip-us.apache.org/repos/asf/incubator-usergrid/blob/4a92ab09/content/docs/_images/login.png ---------------------------------------------------------------------- diff --git a/content/docs/_images/login.png b/content/docs/_images/login.png new file mode 100644 index 0000000..565cf49 Binary files /dev/null and b/content/docs/_images/login.png differ http://git-wip-us.apache.org/repos/asf/incubator-usergrid/blob/4a92ab09/content/docs/_images/portal1.png ---------------------------------------------------------------------- diff --git a/content/docs/_images/portal1.png b/content/docs/_images/portal1.png new file mode 100644 index 0000000..0298f12 Binary files /dev/null and b/content/docs/_images/portal1.png differ http://git-wip-us.apache.org/repos/asf/incubator-usergrid/blob/4a92ab09/content/docs/_images/portal2.png ---------------------------------------------------------------------- diff --git a/content/docs/_images/portal2.png b/content/docs/_images/portal2.png new file mode 100644 index 0000000..71b787f Binary files /dev/null and b/content/docs/_images/portal2.png differ http://git-wip-us.apache.org/repos/asf/incubator-usergrid/blob/4a92ab09/content/docs/_images/portal3.png ---------------------------------------------------------------------- diff --git a/content/docs/_images/portal3.png b/content/docs/_images/portal3.png new file mode 100644 index 0000000..89136a9 Binary files /dev/null and b/content/docs/_images/portal3.png differ http://git-wip-us.apache.org/repos/asf/incubator-usergrid/blob/4a92ab09/content/docs/_images/portal4.png ---------------------------------------------------------------------- diff --git a/content/docs/_images/portal4.png b/content/docs/_images/portal4.png new file mode 100644 index 0000000..be644e5 Binary files /dev/null and b/content/docs/_images/portal4.png differ http://git-wip-us.apache.org/repos/asf/incubator-usergrid/blob/4a92ab09/content/docs/_images/portal5.png ---------------------------------------------------------------------- diff --git a/content/docs/_images/portal5.png b/content/docs/_images/portal5.png new file mode 100644 index 0000000..f8781c5 Binary files /dev/null and b/content/docs/_images/portal5.png differ http://git-wip-us.apache.org/repos/asf/incubator-usergrid/blob/4a92ab09/content/docs/_images/rdbms.png ---------------------------------------------------------------------- diff --git a/content/docs/_images/rdbms.png b/content/docs/_images/rdbms.png new file mode 100644 index 0000000..ce9f2a7 Binary files /dev/null and b/content/docs/_images/rdbms.png differ http://git-wip-us.apache.org/repos/asf/incubator-usergrid/blob/4a92ab09/content/docs/_images/reviews.png ---------------------------------------------------------------------- diff --git a/content/docs/_images/reviews.png b/content/docs/_images/reviews.png new file mode 100644 index 0000000..3acb39d Binary files /dev/null and b/content/docs/_images/reviews.png differ http://git-wip-us.apache.org/repos/asf/incubator-usergrid/blob/4a92ab09/content/docs/_images/reviews2.png ---------------------------------------------------------------------- diff --git a/content/docs/_images/reviews2.png b/content/docs/_images/reviews2.png new file mode 100644 index 0000000..85872f2 Binary files /dev/null and b/content/docs/_images/reviews2.png differ http://git-wip-us.apache.org/repos/asf/incubator-usergrid/blob/4a92ab09/content/docs/_images/securitymodel0.png ---------------------------------------------------------------------- diff --git a/content/docs/_images/securitymodel0.png b/content/docs/_images/securitymodel0.png new file mode 100644 index 0000000..9f3ee82 Binary files /dev/null and b/content/docs/_images/securitymodel0.png differ http://git-wip-us.apache.org/repos/asf/incubator-usergrid/blob/4a92ab09/content/docs/_sources/README.txt ---------------------------------------------------------------------- diff --git a/content/docs/_sources/README.txt b/content/docs/_sources/README.txt new file mode 100644 index 0000000..58ccf3b --- /dev/null +++ b/content/docs/_sources/README.txt @@ -0,0 +1,69 @@ +# Apache Usergrid Documentation + +Usergrid documentation is written in [Markdown](https://help.github.com/articles/markdown-basics/) (*.md) and RST (.rst) formats and we use the Python based [Sphinx-Docs](http://sphinx-doc.org/) documentation system to transform our Markdown and RST files to HTML format. + +## Prerequisites + +Sphinx requires Python and pip. Once you have Python, you can install sphinx and pip like so: + + $ sudo easy_install sphinx + $ sudo easy_install pip + +## How to change/update the Usergrid documentation + + + +## How to build the Usergrid documentation using Sphinx + +Sphinx runs via a Makefile in this, the docs directory. So, cd to this directory and make html: + + cd $usergrid/docs + make clean html + +## How to update the Usergrid docs + +Find the Markdown (.md) or reST (.rst) files that you need to change, edit them and then run ``make clean html`` to generate the HTML into the ``target/html`` directory, where you can preview your changes. + +### Note the difference between RST and Markdown files + +Note that Sphinx's native format is [reStructuredText](http://docutils.sourceforge.net/rst.html) (RST) and not Markdown. This causes some issues. For example, using Sphinx directives in Markdown files sometimes works and sometimes does not. RST is a different format than Markdown and it has a different set of directives, some very useful for organizing a large set of documentation files. + +### Updating the Table of Contents + +The Table of Contents for the documentation is in index.rst, which ties everything together +with a series of RST __toctree__ directives. All other files should be written in Markdown, +unless they need some special RST directives that will not work in Markdown. + +### Dealing with other tables + +A note about tables. Markdown and reST do not have very good table support. Simple tables are easy to do and you can find examples (e.g. connecting-entities.md) but for tables with multiple lines in each cell, you'll probably want to use a raw HTML table, and there are plenty of examples of that around too. + +## How to publish the Usergrid docs to Usergrid website + +To update the Usergrid website you must copy the udpated docs files from ``target/html`` directory to the website directory at the root of the Usergrid project, i.e. ``${usergrid-project-dir}/website/docs``. + +You can do this by running the script ``update-website.sh``. + +Once you've done that then you should follow the instructions in the website/README.md file, which explains how to update the website. + +## Updating the REST API reference + +The REST API documentation in ``rest-endpoints/api-docs.md`` is generated from a Swagger file in the +directory ``src/main/resources``, so DO NOT edit that file directly. + +If you need to update the REST API docs, you should edit the usergrid-swagger.yaml file and then + re-generate the file. + +If you need to change the formatting of the REST API docs, then you will need to edit the Mustache templates in ``src/main/resource`` and you may need to edit the Groovy script that does the generation: ``src/main/groovy/usergrid.ApiDocGenerator``. + +You will need: +* Groovy 2.x +* [Mustache.java](https://github.com/spullara/mustache.java) + +__NOTE__: Mustache.hava is not in Maven Central so unfortunately, you will have to Git Clone Mustache.java before you can run the generation script. + +This is the command to run the generation: + + groovy src/main/groovy/usergrid.ApiDocGenerator.groovy + +The script will update the file ``rest-endpoints/api-docs.md`` and when you are happy with your update you should commit and push that file with Git. http://git-wip-us.apache.org/repos/asf/incubator-usergrid/blob/4a92ab09/content/docs/_sources/asset-and-files/assets.txt ---------------------------------------------------------------------- diff --git a/content/docs/_sources/asset-and-files/assets.txt b/content/docs/_sources/asset-and-files/assets.txt new file mode 100644 index 0000000..ea7291c --- /dev/null +++ b/content/docs/_sources/asset-and-files/assets.txt @@ -0,0 +1,20 @@ +# Assets + +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. + + + Property Type Description + -------------- -------- --------------------------------------------------------------------------------- + uuid UUID Assetâs unique entity ID + type string "asset" + name string Asset name (mandatory) + created long [UNIX timestamp](http://en.wikipedia.org/wiki/Unix_time) of entity creation + modified long [UNIX timestamp](http://en.wikipedia.org/wiki/Unix_time) of entity modification + owner UUID UUID of the assetâs owner (mandatory) + path string Relative path to the asset (mandatory) + content-type string Content type of the asset (for example, âimage/jpegâ) + + http://git-wip-us.apache.org/repos/asf/incubator-usergrid/blob/4a92ab09/content/docs/_sources/asset-and-files/file-storage-configuration.txt ---------------------------------------------------------------------- diff --git a/content/docs/_sources/asset-and-files/file-storage-configuration.txt b/content/docs/_sources/asset-and-files/file-storage-configuration.txt new file mode 100644 index 0000000..c56265a --- /dev/null +++ b/content/docs/_sources/asset-and-files/file-storage-configuration.txt @@ -0,0 +1,39 @@ +# File storage configuration + +Usergrid can store your assets either on your hard drive or in the Amazon S3 cloud. + +Local storage configuration +--- + +By default assets are stored in the temporary folder /tmp/usergrid +This can be changed by editing this file /stack/rest/src/main/resources/usergrid-rest-context.xml and replacing {usergrid.temp.files} by the wanted destination +```xml +<bean id="binaryStore" class="org.apache.usergrid.services.assets.data.LocalFileBinaryStore"> + <property name="reposLocation" value="${usergrid.temp.files}"/> +</bean> +``` + +AwS S3 configuration +--- + +To use your AWS S3 storage you need to change the binaryStore classpath and add several constructor arguments in /stack/rest/src/main/resources/usergrid-rest-context.xml + +Some examples : +```xml +<bean id="binaryStore" class="org.apache.usergrid.services.assets.data.AwsSdkS3BinaryStore"> + <constructor-arg name="accessId" value="x" /> + <constructor-arg name="secretKey" value="xx" /> + <constructor-arg name="bucketName" value="x" /> + <constructor-arg name="regionName" value="eu-central-1" /> +</bean> +``` +the regionName field is not mandatory, this code is also valid +```xml +<bean id="binaryStore" class="org.apache.usergrid.services.assets.data.AwsSdkS3BinaryStore"> + <constructor-arg name="accessId" value="x" /> + <constructor-arg name="secretKey" value="xx" /> + <constructor-arg name="bucketName" value="x" /> +</bean> +``` + +The filesize is limited to 50GB but you need to keep in mind that the file has to be stored on the hard drive before being sended to Amazon. http://git-wip-us.apache.org/repos/asf/incubator-usergrid/blob/4a92ab09/content/docs/_sources/asset-and-files/folders.txt ---------------------------------------------------------------------- diff --git a/content/docs/_sources/asset-and-files/folders.txt b/content/docs/_sources/asset-and-files/folders.txt new file mode 100644 index 0000000..7c425be --- /dev/null +++ b/content/docs/_sources/asset-and-files/folders.txt @@ -0,0 +1,85 @@ +# Folders + +## Linking a folder to an asset +In order to access the asset for the image in the folder, you need to link the folder to the asset. You can do that by issuing a POST request in the following format: + + POST /{org-uuid}/{app-uuid}/folders/{folder-uuid}/assets/{assets_id} + +where ``{folder-uuid}`` is the UUID of the folder, and ``{assets-uuid}`` is the UUID of the assets entity. + +Hereâs how you could link the folder and the asset you created for the my-image.jpg image: + + POST https://api.usergrid.com/my-org/my-app/folders/6640a601-2ac6-11e2-92c3-02e81ae640dc/assets/9501cda1-2d21-11e2-b4c6-02e81ac5a17b + +In the response, you should see the assets entity for the image added to the folder: + + { + "action": "post", + "application": "3400ba10-cd0c-11e1-bcf7-12313d1c4491", + "params": {}, + "path": "/folders/6640a601-2ac6-11e2-92c3-02e81ae640dc/assets", + "uri": "https://api.usergrid.com/my-org/my-app/folders/6640a601-2ac6-11e2-92c3-02e81ae640dc/assets", + "entities": [ + { + "uuid": "9501cda1-2d21-11e2-b4c6-02e81ac5a17b", + "type": "asset", + "name": "my-image.jpg", + "created": 1352763303163, + "modified": 1352763303163, + "metadata": { + "path": "/folders/6640a601-2ac6-11e2-92c3-02e81ae640dc/assets/9501cda1-2d21-11e2-b4c6-02e81ac5a17b" + }, + "owner": "5c0c1789-d503-11e1-b36a-12313b01d5c1", + "path": "/myassets/asset1" + } + ], + "timestamp": 1352830448045, + "duration": 54, + "organization": "my-orgâ, + "applicationName": "my-app" + } + +## Retrieve list of folder assets +You can also request a list of the linked contents of the folder like this: + + GET https://api.usergrid.com/my-org/my-app/folders/6640a601-2ac6-11e2-92c3-02e81ae640dc/assets + +The response should look something like this: + + { + "action": "get", + "application": "3400ba10-cd0c-11e1-bcf7-12313d1c4491", + "params": { + "_": [ + "1352830364891" + ] + }, + "path": "/folders/6640a601-2ac6-11e2-92c3-02e81ae640dc/assets", + "uri": "https://api.usergrid.com/my-org/my-app/folders/6640a601-2ac6-11e2-92c3-02e81ae640dc/assets", + "entities": [ + { + "uuid": "7bf47435-2ac8-11e2-b4c6-02e81ac5a17b", + "type": "asset", + "name": "my-image.jpg", + "created": 1352505133598, + "modified": 1352507245108, + "checksum": "8e0cd3866ee20746c99e9a9825f38ad8", + "content-length": 11853, + "content-type": "image/jpeg", + "etag": "\"8e0cd3866ee20746c99e9a9825f38ad8\"", + "metadata": { + "connecting": { + "assets": "/folders/6640a601-2ac6-11e2-92c3-02e81ae640dc/assets/7bf47435-2ac8-11e2-b4c6-02e81ac5a17b/connecting/assets" + }, + "connection": "assets", + "path": "/folders/6640a601-2ac6-11e2-92c3-02e81ae640dc/assets/7bf47435-2ac8-11e2-b4c6-02e81ac5a17b" + }, + "owner": "5c0c1789-d503-11e1-b36a-12313b01d5c1", + "path": "my-image" + } + ], + "timestamp": 1352830363797, + "duration": 57, + "organization": "my-org", + "applicationName": "my-app" + } http://git-wip-us.apache.org/repos/asf/incubator-usergrid/blob/4a92ab09/content/docs/_sources/asset-and-files/legacy-asset-support.txt ---------------------------------------------------------------------- diff --git a/content/docs/_sources/asset-and-files/legacy-asset-support.txt b/content/docs/_sources/asset-and-files/legacy-asset-support.txt new file mode 100644 index 0000000..e69de29 http://git-wip-us.apache.org/repos/asf/incubator-usergrid/blob/4a92ab09/content/docs/_sources/asset-and-files/retrieving-assets.txt ---------------------------------------------------------------------- diff --git a/content/docs/_sources/asset-and-files/retrieving-assets.txt b/content/docs/_sources/asset-and-files/retrieving-assets.txt new file mode 100644 index 0000000..9313ae8 --- /dev/null +++ b/content/docs/_sources/asset-and-files/retrieving-assets.txt @@ -0,0 +1,27 @@ +# Retrieving assets + +## Retrieving asset data + +To retrieve the asset from an entity, send a ``GET`` request with the ``Accept`` header set to the content type of the asset. The content type can be retrieved from the ``file-metadata.content-type`` property of the entity the asset is attached to. + +### Request syntax + + curl -X GET -H 'Accept: <content_type>' 'https://api.usergrid.com/<org>/<app>/<collection>/<entity> + +Parameters + +Parameter Description +--------- ----------- +content_type The content type of the attached asset. For example, text/plain, image/jpeg. +org Organization UUID or organization name +app Application UUID or application name +collection Name or UUID of the collection of the entity the asset is attached to. +entity Name or UUID of the entity the asset is attached to. + +### Example request +The following request will retrieve the data for a jpeg file attached to an entity named 'cloud' in the 'pictures' collection: + + curl -X GET -H 'Accept: image/jpeg' 'https://api.usergrid.com/your-org/your-app/pictures/cloud + +## Retrieving an asset entity +To retrieve the entity that an asset is attached to, perform a ``GET`` request as you normally would to retrieve an entity. For more information, see [Retrieving Data Entities](../data-storage/entities.html#retrieving-data-entities). \ No newline at end of file http://git-wip-us.apache.org/repos/asf/incubator-usergrid/blob/4a92ab09/content/docs/_sources/asset-and-files/uploading-assets.txt ---------------------------------------------------------------------- diff --git a/content/docs/_sources/asset-and-files/uploading-assets.txt b/content/docs/_sources/asset-and-files/uploading-assets.txt new file mode 100644 index 0000000..c5b836f --- /dev/null +++ b/content/docs/_sources/asset-and-files/uploading-assets.txt @@ -0,0 +1,86 @@ +# Uploading assets + +With Usergrid, you can store and retrieve files and assets that hold data objects such as images, video, and audio content. + +Usergrid manages these objects as Asset entities. Optionally, you can use Folder entities to organize related assets. + +## Uploading assets +Assets can be any file type and can be attached to any entity. When an asset is uploaded, Usergrid will automatically detect the file metadata for the asset and save it in the associated entity as a ``file-metadata`` property. Only 1 asset can be attached to an entity. + +To attach an asset to an entity, do the following: + +### Request syntax + + curl -X POST -F name='<filename>' -F file=@<file_location> 'https://api.usergrid.com/<org>/<app>/<collection>/<entity> + +Parameters + +Parameter Description +--------- ----------- +filename A filename to associate with the asset. +file_location The location of the asset to be uploaded. +org Organization UUID or organization name +app Application UUID or application name +collection Name or UUID of the collection of the entity you want to attach the asset to. +entity Name or UUID of an existing entity you want to attach the asset to. + +### Example request + + curl -X POST -i -F name='clouds' -F file=@happy_clouds.jpg 'https://api.usergrid.com/your-org/your-app/pictures/' + +### Example response + +Notice the ``file-metadata`` property in the response. + + { + "action" : "post", + "application" : "f34f4222-a166-11e2-a7f7-02e81adcf3d0", + "params" : { }, + "path" : "/users", + "uri" : "https://api.usergrid.com/amuramoto/sandbox/pictures", + "entities" : [ { + "uuid" : "410b213a-b379-11e3-a0e5-9953085ea376", + "type" : "user", + "name" : "test", + "created" : 1395681911491, + "modified" : 1399069838919, + "name" : "clouds", + "file" : "fobnszewobnioerabnoiawegbrn\n", + "file-metadata" : { + "content-type" : "image/jpeg", + "etag" : "\"2e1db7299b0a667ed80e674a0ef9d653\"", + "last-modified" : 1399070010115, + "content-length" : 28, + "checksum" : "2e1db7299b0a667ed80e674a0ef9d653" + }, + "metadata" : { + "connecting" : { + "likes" : "/users/410b213a-b379-11e3-a0e5-9953085ea376/connecting/likes" + }, + "path" : "/users/410b213a-b379-11e3-a0e5-9953085ea376", + "sets" : { + "rolenames" : "/users/410b213a-b379-11e3-a0e5-9953085ea376/roles", + "permissions" : "/users/410b213a-b379-11e3-a0e5-9953085ea376/permissions" + }, + "connections" : { + "follows" : "/users/410b213a-b379-11e3-a0e5-9953085ea376/follows" + }, + "collections" : { + "activities" : "/users/410b213a-b379-11e3-a0e5-9953085ea376/activities", + "devices" : "/users/410b213a-b379-11e3-a0e5-9953085ea376/devices", + "feed" : "/users/410b213a-b379-11e3-a0e5-9953085ea376/feed", + "groups" : "/users/410b213a-b379-11e3-a0e5-9953085ea376/groups", + "roles" : "/users/410b213a-b379-11e3-a0e5-9953085ea376/roles", + "following" : "/users/410b213a-b379-11e3-a0e5-9953085ea376/following", + "followers" : "/users/410b213a-b379-11e3-a0e5-9953085ea376/followers" + } + } + } ], + "timestamp" : 1399070009986, + "duration" : 441, + "organization" : "your-org", + "applicationName" : "your-app" + } + +## Updating assets +To update the data for an asset, perform the same request outlined above in 'Uploading assets' as a ``PUT`` request rather than a ``POST``.
