Update website with latest docs.
Project: http://git-wip-us.apache.org/repos/asf/incubator-usergrid/repo Commit: http://git-wip-us.apache.org/repos/asf/incubator-usergrid/commit/7662bc94 Tree: http://git-wip-us.apache.org/repos/asf/incubator-usergrid/tree/7662bc94 Diff: http://git-wip-us.apache.org/repos/asf/incubator-usergrid/diff/7662bc94 Branch: refs/heads/asf-site Commit: 7662bc9415122b81d456959d96c2c9284e250d0e Parents: 6b14418 Author: Dave Johnson <snoopd...@apache.org> Authored: Fri Aug 7 17:05:31 2015 -0400 Committer: Dave Johnson <snoopd...@apache.org> Committed: Fri Aug 7 17:05:31 2015 -0400 ---------------------------------------------------------------------- content/docs/README.html | 22 +- content/docs/_sources/README.txt | 11 +- .../file-storage-configuration.txt | 39 + .../docs/_sources/assets-and-files/folders.txt | 85 ++ .../assets-and-files/legacy-asset-support.txt | 0 .../assets-and-files/retrieving-assets.txt | 27 + .../assets-and-files/uploading-assets.txt | 86 ++ .../data-queries/operators-and-types.txt | 2 +- .../_sources/data-queries/query-parameters.txt | 2 +- .../data-queries/querying-your-data.txt | 2 +- .../docs/_sources/data-storage/collections.txt | 8 +- .../_sources/data-storage/data-store-dbms.txt | 12 +- content/docs/_sources/data-storage/entities.txt | 10 +- .../entity-connections/retrieving-entities.txt | 9 +- .../docs/_sources/geolocation/geolocation.txt | 2 +- .../creating-a-new-application.txt | 6 +- .../getting-started/creating-account.txt | 6 +- .../getting-started/using-a-sandbox-app.txt | 2 +- .../_sources/getting-started/using-the-api.txt | 2 +- content/docs/_sources/index.txt | 14 +- .../docs/_sources/introduction/data-model.txt | 30 +- content/docs/_sources/introduction/overview.txt | 17 + .../_sources/introduction/usergrid-features.txt | 28 +- .../docs/_sources/orgs-and-apps/admin-user.txt | 2 +- .../docs/_sources/orgs-and-apps/application.txt | 2 +- .../docs/_sources/rest-endpoints/api-docs.txt | 1162 +++++++--------- content/docs/_sources/sdks/ios-new.txt | 982 +++++++++++++ content/docs/_sources/sdks/ios.txt | 108 +- content/docs/_sources/sdks/sdk-outline.txt | 111 ++ .../authenticating-api-requests.txt | 6 +- ...enticating-users-and-application-clients.txt | 6 +- .../security-and-auth/facebook-sign.txt | 2 +- .../user-authentication-types.txt | 6 +- .../security-and-auth/using-permissions.txt | 4 +- .../_sources/security-and-auth/using-roles.txt | 304 ++++ .../docs/_sources/user-management/activity.txt | 17 +- content/docs/_sources/user-management/group.txt | 12 +- .../user-management/messagee-example.txt | 2 +- .../user-management/working-user-data.txt | 12 +- content/docs/_static/css/theme.css | 168 +-- .../file-storage-configuration.html | 322 +++++ content/docs/assets-and-files/folders.html | 391 ++++++ .../assets-and-files/legacy-asset-support.html | 280 ++++ .../assets-and-files/retrieving-assets.html | 359 +++++ .../docs/assets-and-files/uploading-assets.html | 419 ++++++ .../creating-and-incrementing-counters.html | 11 +- .../events-and-counters.html | 15 +- .../retrieving-counters.html | 11 +- .../docs/data-queries/advanced-query-usage.html | 11 +- .../docs/data-queries/operators-and-types.html | 15 +- content/docs/data-queries/query-parameters.html | 14 +- .../docs/data-queries/querying-your-data.html | 15 +- content/docs/data-storage/collections.html | 35 +- content/docs/data-storage/data-store-dbms.html | 31 +- content/docs/data-storage/entities.html | 38 +- .../docs/data-storage/optimizing-access.html | 11 +- .../entity-connections/connecting-entities.html | 11 +- .../disconnecting-entities.html | 11 +- .../entity-connections/retrieving-entities.html | 25 +- content/docs/genindex.html | 11 +- content/docs/geolocation/geolocation.html | 17 +- .../creating-a-new-application.html | 29 +- .../docs/getting-started/creating-account.html | 28 +- .../getting-started/using-a-sandbox-app.html | 26 +- content/docs/getting-started/using-the-api.html | 14 +- content/docs/index.html | 91 +- .../docs/installation/ug1-deploy-to-tomcat.html | 11 +- .../installation/ug1-launcher-quick-start.html | 11 +- .../docs/installation/ug2-deploy-to-tomcat.html | 11 +- content/docs/introduction/async-vs-sync.html | 15 +- content/docs/introduction/data-model.html | 41 +- content/docs/introduction/overview.html | 320 +++++ .../docs/introduction/usergrid-features.html | 78 +- content/docs/objects.inv | Bin 663 -> 666 bytes content/docs/orgs-and-apps/admin-user.html | 91 +- content/docs/orgs-and-apps/application.html | 26 +- content/docs/orgs-and-apps/managing.html | 11 +- content/docs/orgs-and-apps/organization.html | 11 +- content/docs/push-notifications/tbd.html | 11 +- .../docs/push-notifications/users-devices.html | 11 +- content/docs/reference/contribute-code.html | 11 +- content/docs/reference/presos-and-videos.html | 11 +- content/docs/rest-endpoints/api-docs.html | 1226 +++++++--------- content/docs/sdks/ios-new.html | 1310 ++++++++++++++++++ content/docs/sdks/ios.html | 133 +- content/docs/sdks/sdk-outline.html | 503 +++++++ content/docs/sdks/tbd.html | 11 +- content/docs/search.html | 11 +- content/docs/searchindex.js | 2 +- .../docs/security-and-auth/app-security.html | 11 +- .../authenticating-api-requests.html | 23 +- ...nticating-users-and-application-clients.html | 33 +- .../changing-token-time-live-ttl.html | 11 +- .../docs/security-and-auth/facebook-sign.html | 13 +- .../revoking-tokens-logout.html | 11 +- .../security-and-auth/securing-your-app.html | 11 +- .../user-authentication-types.html | 32 +- .../security-and-auth/using-permissions.html | 23 +- content/docs/security-and-auth/using-roles.html | 740 ++++++++++ content/docs/user-management/activity.html | 50 +- content/docs/user-management/group.html | 38 +- content/docs/user-management/groups.html | 11 +- .../docs/user-management/messagee-example.html | 15 +- .../docs/user-management/user-connections.html | 11 +- .../docs/user-management/user-management.html | 11 +- .../docs/user-management/working-user-data.html | 46 +- docs/rest-endpoints/api-docs.html | 588 ++++---- docs/src/main/resources/html/model.mustache | 2 +- 108 files changed, 8686 insertions(+), 2429 deletions(-) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/incubator-usergrid/blob/7662bc94/content/docs/README.html ---------------------------------------------------------------------- diff --git a/content/docs/README.html b/content/docs/README.html index 7abe7ff..1a6ca49 100644 --- a/content/docs/README.html +++ b/content/docs/README.html @@ -80,14 +80,15 @@ <p class="caption"><span class="caption-text">Introduction</span></p> <ul> +<li class="toctree-l1"><a class="reference internal" href="introduction/overview.html">Documentation Overview</a></li> <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/creating-a-new-application.html">Creating a new application</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> @@ -115,6 +116,7 @@ <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/using-roles.html">Using roles</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> @@ -139,9 +141,9 @@ </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> +<li class="toctree-l1"><a class="reference internal" href="assets-and-files/uploading-assets.html">Uploading assets</a></li> +<li class="toctree-l1"><a class="reference internal" href="assets-and-files/retrieving-assets.html">Retrieving assets</a></li> +<li class="toctree-l1"><a class="reference internal" href="assets-and-files/folders.html">Folders</a></li> </ul> <p class="caption"><span class="caption-text">Counters & Events</span></p> <ul> @@ -156,6 +158,7 @@ <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> +<li class="toctree-l1"><a class="reference internal" href="orgs-and-apps/admin-user.html">Admin user</a></li> </ul> <p class="caption"><span class="caption-text">API Reference</span></p> <ul> @@ -230,9 +233,6 @@ $ 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 @@ -275,6 +275,12 @@ examples of that around too.</p> </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>First you generate the HTML for the docs from the Markdown and reST +sources like so:</p> +<div class="highlight-python"><div class="highlight"><pre>cd $usergrid/docs +make clean html +</pre></div> +</div> <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> @@ -299,7 +305,7 @@ need to edit the Groovy script that does the generation: 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 +<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 http://git-wip-us.apache.org/repos/asf/incubator-usergrid/blob/7662bc94/content/docs/_sources/README.txt ---------------------------------------------------------------------- diff --git a/content/docs/_sources/README.txt b/content/docs/_sources/README.txt index 58ccf3b..2f7888c 100644 --- a/content/docs/_sources/README.txt +++ b/content/docs/_sources/README.txt @@ -9,10 +9,6 @@ Sphinx requires Python and pip. Once you have Python, you can install sphinx and $ 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: @@ -40,6 +36,11 @@ A note about tables. Markdown and reST do not have very good table support. Simp ## How to publish the Usergrid docs to Usergrid website +First you generate the HTML for the docs from the Markdown and reST sources like so: + + cd $usergrid/docs + make clean html + 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``. @@ -64,6 +65,6 @@ __NOTE__: Mustache.hava is not in Maven Central so unfortunately, you will have This is the command to run the generation: - groovy src/main/groovy/usergrid.ApiDocGenerator.groovy + 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/7662bc94/content/docs/_sources/assets-and-files/file-storage-configuration.txt ---------------------------------------------------------------------- diff --git a/content/docs/_sources/assets-and-files/file-storage-configuration.txt b/content/docs/_sources/assets-and-files/file-storage-configuration.txt new file mode 100644 index 0000000..c56265a --- /dev/null +++ b/content/docs/_sources/assets-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/7662bc94/content/docs/_sources/assets-and-files/folders.txt ---------------------------------------------------------------------- diff --git a/content/docs/_sources/assets-and-files/folders.txt b/content/docs/_sources/assets-and-files/folders.txt new file mode 100644 index 0000000..7c425be --- /dev/null +++ b/content/docs/_sources/assets-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/7662bc94/content/docs/_sources/assets-and-files/legacy-asset-support.txt ---------------------------------------------------------------------- diff --git a/content/docs/_sources/assets-and-files/legacy-asset-support.txt b/content/docs/_sources/assets-and-files/legacy-asset-support.txt new file mode 100644 index 0000000..e69de29 http://git-wip-us.apache.org/repos/asf/incubator-usergrid/blob/7662bc94/content/docs/_sources/assets-and-files/retrieving-assets.txt ---------------------------------------------------------------------- diff --git a/content/docs/_sources/assets-and-files/retrieving-assets.txt b/content/docs/_sources/assets-and-files/retrieving-assets.txt new file mode 100644 index 0000000..9313ae8 --- /dev/null +++ b/content/docs/_sources/assets-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/7662bc94/content/docs/_sources/assets-and-files/uploading-assets.txt ---------------------------------------------------------------------- diff --git a/content/docs/_sources/assets-and-files/uploading-assets.txt b/content/docs/_sources/assets-and-files/uploading-assets.txt new file mode 100644 index 0000000..c5b836f --- /dev/null +++ b/content/docs/_sources/assets-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``. http://git-wip-us.apache.org/repos/asf/incubator-usergrid/blob/7662bc94/content/docs/_sources/data-queries/operators-and-types.txt ---------------------------------------------------------------------- diff --git a/content/docs/_sources/data-queries/operators-and-types.txt b/content/docs/_sources/data-queries/operators-and-types.txt index c67ccd1..bb42107 100644 --- a/content/docs/_sources/data-queries/operators-and-types.txt +++ b/content/docs/_sources/data-queries/operators-and-types.txt @@ -64,7 +64,7 @@ As you develop queries, remember that entity properties each conform to a partic For example, if you create an entity with a price property with a value of 100.00, querying for 100 will return no results, since the API expected a decimal-delimited float value in your query. -For a list of property data types for each default entities, see Default Data Entity Types. +For a list of property data types for each default entities, see [Default Data Entities](../rest-endpoints/api-doc.html#models)s. <table class="usergrid-table"> <tr> http://git-wip-us.apache.org/repos/asf/incubator-usergrid/blob/7662bc94/content/docs/_sources/data-queries/query-parameters.txt ---------------------------------------------------------------------- diff --git a/content/docs/_sources/data-queries/query-parameters.txt b/content/docs/_sources/data-queries/query-parameters.txt index 9f9fc68..944c27b 100644 --- a/content/docs/_sources/data-queries/query-parameters.txt +++ b/content/docs/_sources/data-queries/query-parameters.txt @@ -48,7 +48,7 @@ The following table lists a few examples of the kind of searches you can do in q ### Location -If you've stored location data with your entities, you can query for the proximity of the geographical locations those entities represent. For more information on geolocation, see Geolocation. +If you've stored location data with your entities, you can query for the proximity of the geographical locations those entities represent. For more information on geolocation, see [Geolocation](../geolocation/geolocation.html). <table class="usergrid-table"> <tr> http://git-wip-us.apache.org/repos/asf/incubator-usergrid/blob/7662bc94/content/docs/_sources/data-queries/querying-your-data.txt ---------------------------------------------------------------------- diff --git a/content/docs/_sources/data-queries/querying-your-data.txt b/content/docs/_sources/data-queries/querying-your-data.txt index fa10169..2da961d 100644 --- a/content/docs/_sources/data-queries/querying-your-data.txt +++ b/content/docs/_sources/data-queries/querying-your-data.txt @@ -42,7 +42,7 @@ For example, the following request returns the address and phone number of users When you query your data, the API response is formatted in JavaScript Object Notation (JSON). This is a common format used for parameter and return values in REST web services. -Data corresponding to the response is captured in the responseâs entities array. The array will include one JSON-object for each entity returned for the query. Each returned entity will include a number of default properties, including the UUID of the entity, the entity type, and values for properties such as name, username, email, and so on. For a complete list of default properties by entity type, see Default Data Entity Types. +Data corresponding to the response is captured in the responseâs entities array. The array will include one JSON-object for each entity returned for the query. Each returned entity will include a number of default properties, including the UUID of the entity, the entity type, and values for properties such as name, username, email, and so on. For a complete list of default properties by entity type, see [Default Data Entities](../rest-endpoints/api-doc.html#models). For example, the following query for all entities of type user where the name property equals 'Gladys Kravitz': http://git-wip-us.apache.org/repos/asf/incubator-usergrid/blob/7662bc94/content/docs/_sources/data-storage/collections.txt ---------------------------------------------------------------------- diff --git a/content/docs/_sources/data-storage/collections.txt b/content/docs/_sources/data-storage/collections.txt index c072104..fa8652e 100644 --- a/content/docs/_sources/data-storage/collections.txt +++ b/content/docs/_sources/data-storage/collections.txt @@ -4,7 +4,7 @@ This article describes how to create collections in Advanced Usergrid. All entities are automatically associated with a corresponding collection based on the type 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. -__Note__: Although not shown in the API examples below, you need to provide a valid access token with each API call. See Authenticating users and application clients for details. +__Note__: Although not shown in the API examples below, you need to provide a valid access token with each API call. See [Authenticating users and application clients](../security-and-auth/authenticating-users-and-application-clients.html) for details. ### Creating a collection @@ -51,7 +51,7 @@ This article describes how to retrieve all of the entities in a collection. <div class="admonition note"> <p class="first admonition-title">Note</p> <p class="last">â¨By default, the Usergrid API returns 10 entities per request. For collections with more than 10 entities, use the returned 'cursor' property to retrieve the next 10 entities in the result set. You may also use the LIMIT parameter in a query string to increase the number of results returned. For more information on using cursors, see [Query Parameters](../data-queries/query-parameters.html).</p></div> -__Note__: Although not shown in the API examples below, you need to provide a valid access token with each API call. See Authenticating users and application clients for details. +__Note__: Although not shown in the API examples below, you need to provide a valid access token with each API call. See [Authenticating users and application clients](../security-and-auth/authenticating-users-and-application-clients.html) for details. ### Retrieving sets of entities from a collection @@ -115,7 +115,7 @@ Response: This article describes how to perform batch updates on all entities in a collection. Batch updates require the use of a query string in the request, which can either specify all entities in the collection or a subset of entities for the update to be performed on. For more information on queries, see Querying your data. -__Note__: Although not shown in the API examples below, you need to provide a valid access token with each API call. See Authenticating users and application clients for details. +__Note__: Although not shown in the API examples below, you need to provide a valid access token with each API call. See [Authenticating users and application clients](../security-and-auth/authenticating-users-and-application-clients.html) for details. ### Batch updating entities in a collection @@ -185,7 +185,7 @@ This article describes how to batch delete entities in a collection. Batch delet Currently, collections cannot be deleted; however, you can delete all of the entities from a collection. -__Note__: Although not shown in the API examples below, you need to provide a valid access token with each API call. See Authenticating users and application clients for details. +__Note__: Although not shown in the API examples below, you need to provide a valid access token with each API call. See [Authenticating users and application clients](../security-and-auth/authenticating-users-and-application-clients.html) for details. ### Batch deleting entities in a collection http://git-wip-us.apache.org/repos/asf/incubator-usergrid/blob/7662bc94/content/docs/_sources/data-storage/data-store-dbms.txt ---------------------------------------------------------------------- diff --git a/content/docs/_sources/data-storage/data-store-dbms.txt b/content/docs/_sources/data-storage/data-store-dbms.txt index 539cca6..56fbbdb 100644 --- a/content/docs/_sources/data-storage/data-store-dbms.txt +++ b/content/docs/_sources/data-storage/data-store-dbms.txt @@ -4,10 +4,10 @@ The Usergrid data store is backed by Cassandra, an open source distributed DBMS. <!-- workaround a Sphinx bug --> <div class="admonition note"> <p class="first admonition-title">Note</p> <p class="last"> -Usergrid is not a relational database. Optimizing for performance on a non-relational database like Cassandra differs a bit from relational databases. For more information, see Optimizing access to your Usergrid data store.</p> </div> +Usergrid is not a relational database. Optimizing for performance on a non-relational database like Cassandra differs a bit from relational databases. For more information, see [Optimizing access to your Usergrid data store](../data-storage/optimizing-access.html).</p> </div> -Cassandra is specifically designed to support applications that need flexibility and high scalability, particularly web and mobile applications. Usergrid client applications write and read data formatted as JavaScript Object Notation (JSON). (Usergrid provides SDKs through which client apps can do much of this work in their native language. For more information, see Usergrid SDKs.) +Cassandra is specifically designed to support applications that need flexibility and high scalability, particularly web and mobile applications. Usergrid client applications write and read data formatted as JavaScript Object Notation (JSON). (Usergrid provides SDKs through which client apps can do much of this work in their native language. For more information, see [Usergrid SDKs](../sdks/tbd.html).) With Cassandra as the underlying DBMS, apps benefit from: @@ -20,10 +20,10 @@ If you have experience with relational databases and are unfamiliar with "NoSQL" <table class="usergrid-table"> <tr> - <td></td> - <td>RDBMS</td> - <td>Cassandra</td> - <td>Usergrid</td> + <th></th> + <th>RDBMS</th> + <th>Cassandra</th> + <th>Usergrid</th> </tr> <tr> <td>Each tuple is modeled as</td> http://git-wip-us.apache.org/repos/asf/incubator-usergrid/blob/7662bc94/content/docs/_sources/data-storage/entities.txt ---------------------------------------------------------------------- diff --git a/content/docs/_sources/data-storage/entities.txt b/content/docs/_sources/data-storage/entities.txt index 5a70b18..be77ebd 100644 --- a/content/docs/_sources/data-storage/entities.txt +++ b/content/docs/_sources/data-storage/entities.txt @@ -5,7 +5,7 @@ This article describes how to create custom data entities and entity properties. The methods cited in this article should be used to create custom data entities. If you are using one of the Usergrid SDKs, use one of the entity type-specific SDK methods to create default data entities. -__Note__: Although not shown in the API examples below, you need to provide a valid access token with each API call. See Authenticating users and application clients for details. +__Note__: Although not shown in the API examples below, you need to provide a valid access token with each API call. See [Authenticating users and application clients](../security-and-auth/authenticating-users-and-application-clients.html) for details. ### Creating a custom entity When a new entity is created, Usergrid will automatically create a corresponding collection if one does not already exist. The collection will automatically be named with the plural form of the entity type. For example, creating a custom entity of type 'item' will automatically create a collection named 'items' in which all future 'item' entities will be saved. @@ -144,7 +144,7 @@ Any valid JSON object can be stored in an entity, regardless of the level of com ### Updating sub-properties An array of sub-properties is treated as a single object. This means that sub-properties cannot be updated atomically. All sub-properties of a given property must be updated as a set. -For more on updating an existing sub-property, see Updating Data Entities. +For more on updating an existing sub-property, see [Updating Data Entities](../data-storage/entities.html#updating-data-entities). Example Request/Response @@ -193,7 +193,7 @@ Example Request/Response ## Retrieving Data Entities This article describes how to retrieve entities from your account. -__Note__: Although not shown in the API examples below, you need to provide a valid access token with each API call. See Authenticating users and application clients for details. +__Note__: Although not shown in the API examples below, you need to provide a valid access token with each API call. See [Authenticating users and application clients](../security-and-auth/authenticating-users-and-application-clients.html) for details. With the exception of the user entity, all data entities can be retrieved by using their UUID or a 'name' property. The user entity can be retrieved by UUID or the 'username' property. The value for the 'name' or 'username' property must be unique. @@ -333,7 +333,7 @@ Response: This article describes how to update entities in your account. -__Note__: Although not shown in the API examples below, you need to provide a valid access token with each API call. See Authenticating users and application clients for details. +__Note__: Although not shown in the API examples below, you need to provide a valid access token with each API call. See [Authenticating users and application clients](../security-and-auth/authenticating-users-and-application-clients.html) for details. ### Updating an entity One or more properties can be updated with a single PUT request. For information on updating sub-properties, see Updating sub-properties below. @@ -454,7 +454,7 @@ Response: This article describes how to delete data entities. -__Note__:Although not shown in the API examples below, you need to provide a valid access token with each API call. See Authenticating users and application clients for details. +__Note__:Although not shown in the API examples below, you need to provide a valid access token with each API call. See [Authenticating users and application clients](../security-and-auth/authenticating-users-and-application-clients.html) for details. ### Deleting an entity http://git-wip-us.apache.org/repos/asf/incubator-usergrid/blob/7662bc94/content/docs/_sources/entity-connections/retrieving-entities.txt ---------------------------------------------------------------------- diff --git a/content/docs/_sources/entity-connections/retrieving-entities.txt b/content/docs/_sources/entity-connections/retrieving-entities.txt index 31eaf9c..6da8577 100644 --- a/content/docs/_sources/entity-connections/retrieving-entities.txt +++ b/content/docs/_sources/entity-connections/retrieving-entities.txt @@ -1,13 +1,12 @@ # Retrieving connections -Viewing all of an entities connections To see all of the connection types associated with an entity, simply retrieve the entity. -All of the connection types the entity has made to other entities will appear in the metadata.connections property. +All of the connection types the entity has made to other entities will appear in the ``metadata.connections`` property. -All of the connection types that other entities have made to the entity will appear in the metadata.connecting property. +All of the connection types that other entities have made to the entity will appear in the ``metadata.connecting`` property. -For user entities, following/followers connections can be accessed by sending a GET request to the URL in the collections.following and collections.followers properties. +For user entities, following/followers connections can be accessed by sending a ``GET`` request to the URL in the ``collections.following`` and ``collections.follower``s properties. Retrieve connected entities by connection type To get a list of entities a specified entity has connected to with a specific connection type, do the following: @@ -83,7 +82,7 @@ All of the entities that have made a connection of that type to the specified en ## Retrieve all connecting entities by type -To get a list of all the entities that have created a connection of a specific type to a specified entity, use the same method as shown above in Retrieve connected entities by connection type, and set the relationship to connecting/<relationship>. +To get a list of all the entities that have created a connection of a specific type to a specified entity, use the same method as shown above in Retrieve connected entities by connection type, and set the relationship to ``connecting/<relationship>``. All of the entities that have made a connection to the specified entity will be returned in the entities property of the response. http://git-wip-us.apache.org/repos/asf/incubator-usergrid/blob/7662bc94/content/docs/_sources/geolocation/geolocation.txt ---------------------------------------------------------------------- diff --git a/content/docs/_sources/geolocation/geolocation.txt b/content/docs/_sources/geolocation/geolocation.txt index ede4e3c..3da555c 100644 --- a/content/docs/_sources/geolocation/geolocation.txt +++ b/content/docs/_sources/geolocation/geolocation.txt @@ -36,7 +36,7 @@ Location-aware apps require the ability to return content and results based on t The returned results are sorted from nearest to furthest. Entities with the same location are returned in the order they were created. -The location parameter can be appended to any standard API Services query. For more information on how to query your API Services data, see Querying your data. +The location parameter can be appended to any standard API Services query. For more information on how to query your API Services data, see [Querying your Data](../data-queries/querying-your-data.html). For example, here is how you would find all the devices within 8,046 meters (~10 miles) of the center of San Francisco: http://git-wip-us.apache.org/repos/asf/incubator-usergrid/blob/7662bc94/content/docs/_sources/getting-started/creating-a-new-application.txt ---------------------------------------------------------------------- diff --git a/content/docs/_sources/getting-started/creating-a-new-application.txt b/content/docs/_sources/getting-started/creating-a-new-application.txt index cc5f577..ce5fb7a 100644 --- a/content/docs/_sources/getting-started/creating-a-new-application.txt +++ b/content/docs/_sources/getting-started/creating-a-new-application.txt @@ -8,7 +8,9 @@ To create a new application with the admin portal: 1. In the admin portal, from the dropdown menu at the far top left, select the organization to which you will add the new application. 1. Click the ADD NEW APP button, located at the top of the screen, next to the application drop-down. 1. In the dialog box, enter a new application name, then click the Create button. Your new application will automatically be selected in the applications drop-down menu. -Applications can also be created programmatically with a POST request to the API. For more, see Application. + +Applications can also be created programatically with a ``POST`` request to the API. For more, see [Application](../orgs-and-apps/application.html). ## Securing an application -If this is going to be a production application, be sure to configure security roles that provide only the level of access your users will need. For more on security, see Security best practices. \ No newline at end of file +If this is going to be a production application, be sure to configure security roles that provide only the level of access your users will need. For more on security, see [Security Best Practices](../security-and-auth/securing-your-app.html) +. \ No newline at end of file http://git-wip-us.apache.org/repos/asf/incubator-usergrid/blob/7662bc94/content/docs/_sources/getting-started/creating-account.txt ---------------------------------------------------------------------- diff --git a/content/docs/_sources/getting-started/creating-account.txt b/content/docs/_sources/getting-started/creating-account.txt index 1440926..f4f542a 100644 --- a/content/docs/_sources/getting-started/creating-account.txt +++ b/content/docs/_sources/getting-started/creating-account.txt @@ -3,7 +3,7 @@ To get started using the Usergrid, you'll need an Usergrid account. (Before read With an account, you get the following useful things: -* A sandbox application you can try things with (we automatically create one for you with your new account). The sandbox is a partitioned area of the data store where you can add example data and try out API calls. The sandbox isn't secure, but it's handy to play in. For more about the sandbox, see "Using Your Application Sandbox". +* A sandbox application you can try things with (we automatically create one for you with your new account). The sandbox is a partitioned area of the data store where you can add example data and try out API calls. The sandbox isn't secure, but it's handy to play in. For more about the sandbox, see [Using Your Application Sandbox](../getting-started/using-a-sandbox-app.html). * The ability to create more applications (in addition to the sandbox). You can (and should!) make these as secure as you need to. These are the applications that you'll have behind the apps you make available to your users. * Access to the Admin Portal. In the portal, you can do the following: ** Create and manage applications. @@ -11,11 +11,11 @@ With an account, you get the following useful things: ** Manage the data in your app. ** Manage app features, including push notifications, activities, analytics, and so on. ** Try out API calls with a shell command window. -** To create an Usergrid account and see a very short tutorial to get started with, go to the get started page. +** To create an Usergrid account and see a very short tutorial to get started with, go to the get started page of the Portal. ## Next steps Ready to learn and do more? -* Install an SDK that will be most useful for your application environment. For more about Usergrid's SDKs, see SDKs. +* Install an SDK that will be most useful for your application environment. For more about Usergrid's SDKs, see [SDKs](../sdks/tbd.html). * Review Usergrid features for information on concepts and features. * Consult the API Reference for usage details. \ No newline at end of file http://git-wip-us.apache.org/repos/asf/incubator-usergrid/blob/7662bc94/content/docs/_sources/getting-started/using-a-sandbox-app.txt ---------------------------------------------------------------------- diff --git a/content/docs/_sources/getting-started/using-a-sandbox-app.txt b/content/docs/_sources/getting-started/using-a-sandbox-app.txt index 7fb9cd1..75c296f 100644 --- a/content/docs/_sources/getting-started/using-a-sandbox-app.txt +++ b/content/docs/_sources/getting-started/using-a-sandbox-app.txt @@ -2,7 +2,7 @@ ## What is the sandbox application? -When you create a new Usergrid account (see Creating an Usergrid Account) to use services for developers, Usergrid creates a new application for you on its servers. With the new application, called "sandbox," you can add your own example data and try out API calls that do things with the data. Be sure to see Using the API for suggestions. +When you create a new Usergrid account (see [Creating an Usergrid Account](creating-account.html)) to use services for developers, Usergrid creates a new application for you on its servers. With the new application, called "sandbox," you can add your own example data and try out API calls that do things with the data. Be sure to see Using the API for suggestions. ## Is the sandbox secure? http://git-wip-us.apache.org/repos/asf/incubator-usergrid/blob/7662bc94/content/docs/_sources/getting-started/using-the-api.txt ---------------------------------------------------------------------- diff --git a/content/docs/_sources/getting-started/using-the-api.txt b/content/docs/_sources/getting-started/using-the-api.txt index 9a7ba2d..d85f86a 100644 --- a/content/docs/_sources/getting-started/using-the-api.txt +++ b/content/docs/_sources/getting-started/using-the-api.txt @@ -59,7 +59,7 @@ For example, this request retrieves users whose Facebook first name is john: /users?ql=select * where facebook.first_name ='john' -For further information about queries, see Queries and parameters. +For further information about queries, see [Querying your Data](../data-queries/querying-your-data.html) ## Authentication (OAuth) Usergrid implements the OAuth 2.0 standard for authenticating users, clients and API requests. http://git-wip-us.apache.org/repos/asf/incubator-usergrid/blob/7662bc94/content/docs/_sources/index.txt ---------------------------------------------------------------------- diff --git a/content/docs/_sources/index.txt b/content/docs/_sources/index.txt index e25eebc..1afd267 100644 --- a/content/docs/_sources/index.txt +++ b/content/docs/_sources/index.txt @@ -8,6 +8,7 @@ Apache Usergrid Documentation :maxdepth: 2 :caption: Introduction + introduction/overview.md introduction/usergrid-features introduction/data-model introduction/async-vs-sync @@ -18,8 +19,8 @@ Apache Usergrid Documentation :maxdepth: 2 :caption: Getting Started - getting-started/creating-a-new-application getting-started/creating-account + getting-started/creating-a-new-application getting-started/using-a-sandbox-app getting-started/using-the-api.md @@ -63,6 +64,7 @@ Apache Usergrid Documentation security-and-auth/app-security security-and-auth/using-permissions + security-and-auth/using-roles security-and-auth/authenticating-users-and-application-clients security-and-auth/user-authentication-types security-and-auth/changing-token-time-live-ttl @@ -98,9 +100,9 @@ Apache Usergrid Documentation :maxdepth: 2 :caption: Assets & Files - asset-and-files/uploading-assets.md - asset-and-files/retrieving-assets.md - asset-and-files/folders.md + assets-and-files/uploading-assets.md + assets-and-files/retrieving-assets.md + assets-and-files/folders.md .. _counters-and-events: @@ -121,7 +123,7 @@ Apache Usergrid Documentation orgs-and-apps/managing orgs-and-apps/organization orgs-and-apps/application - orgs-and-apps/adminuser + orgs-and-apps/admin-user .. _rest-endpoints: @@ -138,7 +140,7 @@ Apache Usergrid Documentation :caption: Client SDKs sdks/tbd - + .. _installation: .. toctree:: http://git-wip-us.apache.org/repos/asf/incubator-usergrid/blob/7662bc94/content/docs/_sources/introduction/data-model.txt ---------------------------------------------------------------------- diff --git a/content/docs/_sources/introduction/data-model.txt b/content/docs/_sources/introduction/data-model.txt index 0278b97..41421bd 100644 --- a/content/docs/_sources/introduction/data-model.txt +++ b/content/docs/_sources/introduction/data-model.txt @@ -8,7 +8,7 @@ An organization contains one or more applications, and represents administrator- An organization with the same name as your username is automatically created for you when you sign up. By default, you are assigned as the administrator of this organization. ## Applications -In Usergrid, you can create one or more applications within an organization. Applications represent an instance of application data associated with an app, and you may create as many applications as you wish. This allows you to utilize the backend in a way that corresponds to your development process. For example, you might create separate applications for development and production instances of your app. By default, all organization have a sandbox application (see Using a Sandbox Application for important information regarding the default sandbox application). +In Usergrid, you can create one or more applications within an organization. Applications represent an instance of application data associated with an app, and you may create as many applications as you wish. This allows you to utilize the backend in a way that corresponds to your development process. For example, you might create separate applications for development and production instances of your app. By default, all organization have a sandbox application (see Using a [Sandbox Application](../getting-started/using-a-sandbox-app.html) for important information regarding the default sandbox application). Each application provides the infrastructure for storing, retrieving, updating and deleting the entities and collections associated with a specific app instance. @@ -33,20 +33,20 @@ Here is a simple example of an entity: } ## Default entities -The following entity types are predefined in Usergrid. For more details, see Default Data Entity Types. - -* user -* group -* role -* application -* activity -* device -* asset -* folder -* event -* notifier -* notification -* receipt +The following entity types are predefined in Usergrid. For more details, see the [API Reference](../rest-endpoints/api-docs.html) + +* [user](../rest-endpoints/api-docs.html#user) +* [group](../rest-endpoints/api-docs.html#group) +* [role](../rest-endpoints/api-docs.html#role) +* [application](../rest-endpoints/api-docs.html#application) +* [activity](../rest-endpoints/api-docs.html#activity) +* [device](../rest-endpoints/api-docs.html#device) +* [asset](../rest-endpoints/api-docs.html#asset) +* [folder](../rest-endpoints/api-docs.html#folder) +* [event](../rest-endpoints/api-docs.html#event) +* [notifier](../rest-endpoints/api-docs.html#notifier) +* [notification](../rest-endpoints/api-docs.html#notification) +* [receipt](../rest-endpoints/api-docs.html#recept) ## Properties http://git-wip-us.apache.org/repos/asf/incubator-usergrid/blob/7662bc94/content/docs/_sources/introduction/overview.txt ---------------------------------------------------------------------- diff --git a/content/docs/_sources/introduction/overview.txt b/content/docs/_sources/introduction/overview.txt new file mode 100644 index 0000000..e9c6968 --- /dev/null +++ b/content/docs/_sources/introduction/overview.txt @@ -0,0 +1,17 @@ +# Documentation Overview + +The Usergrid documentation is written for a couple of distinctly different audiences: + +* __Application Developer__: this is you if you are a Javascript, iOS, Android, Java or other developer who wants to build an app that uses the Usergrid APIs for data storage, user management, authentication, etc. __Most of our docs are written for application developers__ so browse the left side-bar and work your way down the topics list. + + +* __Deployment/Operations Engineer__: this is for you if you are the person who will be installing Usergrid, setting up the required Cassandra database and other things that Usergrid needs. Currently, we have limited docs for installation, deployment and maintenance of Usergrid: + * [Deploying to Tomcat](../ug1-deploy-to-tomacat): How to build and deploy Usergrid to Tomcat and Cassandra. + * [Launcher Quick Start](../ug1-launcher-quick-start): How to build and run Usergrid via the Usergrid Launcher. + + +* __Open Source Contributor__: How to "give back" and contribute to Usergrid. Usergrid welcomes code and documentation contributions, GitHub pull-requests, bug reports and suggestions for improvement. + * [How to Contribute Code & Docs](../reference/contribute-code): + + + http://git-wip-us.apache.org/repos/asf/incubator-usergrid/blob/7662bc94/content/docs/_sources/introduction/usergrid-features.txt ---------------------------------------------------------------------- diff --git a/content/docs/_sources/introduction/usergrid-features.txt b/content/docs/_sources/introduction/usergrid-features.txt index 5e57071..1a2f0d6 100644 --- a/content/docs/_sources/introduction/usergrid-features.txt +++ b/content/docs/_sources/introduction/usergrid-features.txt @@ -10,21 +10,21 @@ With Usergrid, developers can set up their own cloud-based data platform in minu At the core of Usergrid is a flexible platform that can store any type of application data, from simple records like a catalog of books to complex associations like user relationships. No matter what type of data drives your app, you can store it as collections of data entities and immediately perform complex queries or full-text searches on any field. You can also create custom entities with custom properties, giving you the ability to store data and context in a way that makes sense for your app. -To learn more about entities and collections, see Usergrid Data model. +To learn more about entities and collections, see [Usergrid Data model](data-model.html). -For a complete list of the default data entities available, see Default Data Entity Types. +For a complete list of the default data entities available, see [Models](../rest-endpoint/api-docs.html#models). ### Files & assets Images, video, and audio are key components of a great app experience. With Usergrid, you can upload and retrieve binary objects from the same data store as the rest of your application data, eliminating the need to set up content delivery networks (CDNs) and easing implementation. We handle all the back-end details that keep your content quickly accessible. -To learn more about files and asset storage, see Uploading files and assets . +To learn more about files and asset storage, see [Uploading files and assets](../assets-and-files/uploading-assets.html). ## Flexible data querying One of Usergrid' most powerful features is the ability to perform SQL-style queries and full-text searches on data entities, as well as their properties. This lets you quickly retrieve specific data entities based on multiple criteria, then utilize that data to power social features, target push notifications, perform user analysis, and more. -Learn more about querying app data, see Data query overview. +Learn more about querying app data, see [Data query overview](../data-queries/querying-your-data.html). ## Social @@ -32,13 +32,13 @@ Learn more about querying app data, see Data query overview. You can create relationships between data entities to help build features, improve user experience, and contextualize data. For example, you might associate a user with their devices to capture valuable geolocation data, create relationships between users to build social graphs, or implement popular features such as activity streams. -To learn more about entity relationships, see Entity connections. +To learn more about entity relationships, see [Entity connections](../entity-connections/connecting-entities.html). ### Activity streams A key aspect of social networking apps is the ability to provide and publish data streams of user actions, such as ongoing lists of comments, activities, and tweets. Usergrid simplifies management and routing of these data streams by providing an activity entity that is specifically designed to automatically create a relationship between activities and the user who created them. -To learn more about activities and activity feeds, see Activity feeds. +To learn more about activities and activity feeds, see [Activity feeds](../user-management/activity.html). ## User management @@ -46,7 +46,7 @@ To learn more about activities and activity feeds, see Activity feeds. You can easily add and manage users by providing the core services necessary to handle secure registration and log in, including OAuth 2.0-compliant client authentication. In addition, any number of default or custom data entities and properties can be associated with a user entity to create complete user profiles. -To learn more about user management, see User. +To learn more about user management, see [User Management](../user-management/user-management.html). To learn more about authentication, see Authenticating users and application clients. @@ -54,28 +54,28 @@ To learn more about authentication, see Authenticating users and application cli Applications often require the ability to configure fine-grain control of user access to data, features and functionality. Usergrid solves the implementation details of user access with roles and permissions. Simply create roles that represent user types or access levels, such as Administrator, then assign the necessary permissions to that role. With a single API call, you can then associate your roles with any user or group of users. -To learn more about user roles and permissions, see Managing access by defining permission rules. +To learn more about user roles and permissions, see [Using Permissions](../security-and-auth/securing-your-app.html). ### Groups Groups are a flexible way to organize your users based on any number of criteria. For example, you might group users based on interests or location to more effectively deliver relevant content, target offers, or customize campaigns. You can also take advantage of the groups entity to enable group-based social networking activities, such as allowing your users to create private information feeds or circles of friends. -To learn more about groups, see Working with group data. +To learn more about groups, see [Working with group data](../user-management/groups.html). ### Third-party authentication In addition to supporting user management and OAuth-based login for your app, Usergrid also makes it easy to integrate third-party authentication through such popular services as Facebook, Twitter and other OAuth-enabled accounts. Providing third-party sign-in can improve user experience, while increasing adoption, giving you access to valuable information from social networks and services. -To learn more about using third-party sign-in, see Facebook sign in. +To learn more about using third-party sign-in, see [Facebook sign in](../security-and-auth/facebook-sign.html). ## Geolocation The device entity allows you to capture geolocation data from your users' GPS-enabled devices to more effectively target campaigns, push notifications, offers and more. Geolocation also gives you an important data point for contextualizing and analyzing trends and user behavior. -To learn more about geolocation, see Geolocation. +To learn more about geolocation, see [Geolocation](../geolocation/geolocation.html). -## Push notifications +## Push notifications (Coming soon...) -Push notifications are the most effective way to engage your users with relevant content, and thanks to Usergrid, implementing them can be done in minutes. Simply register your app and your user's devices with a notification provider, such as Apple Push Notification Service or Google Cloud Messaging, then use the Usergrid notification entity to send millions of push notifications a month at no cost. When used in conjunction with queries of user and application data, push notifications become a powerful tool for leveraging user data, ensuring relevancy and driving engagement. +__(Coming Usergrid 2.0)__ Push notifications are the most effective way to engage your users with relevant content, and thanks to Usergrid, implementing them can be done in minutes. Simply register your app and your user's devices with a notification provider, such as Apple Push Notification Service or Google Cloud Messaging, then use the Usergrid notification entity to send millions of push notifications a month at no cost. When used in conjunction with queries of user and application data, push notifications become a powerful tool for leveraging user data, ensuring relevancy and driving engagement. -To learn more about push notifications, see Push notifications overview. +To learn more about push notifications, see [Push notifications overview](../push-notifications/tbd.html). http://git-wip-us.apache.org/repos/asf/incubator-usergrid/blob/7662bc94/content/docs/_sources/orgs-and-apps/admin-user.txt ---------------------------------------------------------------------- diff --git a/content/docs/_sources/orgs-and-apps/admin-user.txt b/content/docs/_sources/orgs-and-apps/admin-user.txt index 87b96f9..6b1b7d3 100644 --- a/content/docs/_sources/orgs-and-apps/admin-user.txt +++ b/content/docs/_sources/orgs-and-apps/admin-user.txt @@ -1,4 +1,4 @@ -# Admin user$ +# Admin user An admin user has full access to perform any operation on all organization accounts of which the admin user is a member. Using the API Services BaaS API, you can create, update, or retrieve an admin user. You can also set or reset an admin user's password, activite or reactivate an admin user, and get an admin user's activity feed. In addition, you can add, retrieve, or remove an admin user from an organization. For information on these organization-related operations, see [Organization](organization.html). http://git-wip-us.apache.org/repos/asf/incubator-usergrid/blob/7662bc94/content/docs/_sources/orgs-and-apps/application.txt ---------------------------------------------------------------------- diff --git a/content/docs/_sources/orgs-and-apps/application.txt b/content/docs/_sources/orgs-and-apps/application.txt index 7495aee..801b9ef 100644 --- a/content/docs/_sources/orgs-and-apps/application.txt +++ b/content/docs/_sources/orgs-and-apps/application.txt @@ -1,5 +1,5 @@ # Application -You can create a new application in an organization through the Admin portal. The Admin portal creates the new application by issuing a post against the management endpoint (see the "Creating an organization application" section in Organization 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: +You can create a new application in an organization through the Admin portal. The Admin portal creates the new application by issuing a post against the management endpoint (see the [Creating an Application](../orgs-and-apps/application.html#creating-an-application) section in Organization 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: https://api.usergrid.com/{org_name|uuid}/{app_name|uuid}
