usergrid-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From sun...@apache.org
Subject git commit: Update docs
Date Wed, 22 Oct 2014 17:57:21 GMT
Repository: incubator-usergrid
Updated Branches:
  refs/heads/putting-docs-on-git cf41fc4fc -> 2d073b5a7


Update 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/2d073b5a
Tree: http://git-wip-us.apache.org/repos/asf/incubator-usergrid/tree/2d073b5a
Diff: http://git-wip-us.apache.org/repos/asf/incubator-usergrid/diff/2d073b5a

Branch: refs/heads/putting-docs-on-git
Commit: 2d073b5a76c41ef99343341076dfade0a9432ccc
Parents: cf41fc4
Author: Sungju Jin <sungju@softwaregeeks.org>
Authored: Thu Oct 23 02:57:24 2014 +0900
Committer: Sungju Jin <sungju@softwaregeeks.org>
Committed: Thu Oct 23 02:57:24 2014 +0900

----------------------------------------------------------------------
 docs/index.md                |  1 +
 docs/organizations-admins.md | 41 +++++++++++++++++++++++++--------------
 docs/usage.md                | 15 ++++++++++++++
 3 files changed, 42 insertions(+), 15 deletions(-)
----------------------------------------------------------------------


http://git-wip-us.apache.org/repos/asf/incubator-usergrid/blob/2d073b5a/docs/index.md
----------------------------------------------------------------------
diff --git a/docs/index.md b/docs/index.md
index 49e7164..312d5ba 100644
--- a/docs/index.md
+++ b/docs/index.md
@@ -6,6 +6,7 @@ Apache Usergrid Documents
    deploy-local
    getting-up-and-running-locally
    organizations-admins
+   usage
    presentations-and-videos
    upgrading
    contribute-code
\ No newline at end of file

http://git-wip-us.apache.org/repos/asf/incubator-usergrid/blob/2d073b5a/docs/organizations-admins.md
----------------------------------------------------------------------
diff --git a/docs/organizations-admins.md b/docs/organizations-admins.md
index bbe6443..6886de3 100644
--- a/docs/organizations-admins.md
+++ b/docs/organizations-admins.md
@@ -13,7 +13,8 @@ Organizations & Admins
 	concepts/activity
 	concepts/assets
 
-###### Organizations
+Organizations
+             
 
 An organization represents the highest level of the Apache Usergrid data
 hierarchy. It contains applications (and the entities and collections
@@ -22,23 +23,33 @@ organization can be representative of a company, team, or project. It
 allows multiple applications  to be shared within the organization with
 other administrators.
 
++----------------+----------+--------------------------------------------------------------------------------------+
+| Property       | Type     | Description                                               
                          |
++================+==========+======================================================================================+
+| uuid           | UUID     | Organization’s unique entity ID                         
                            |
++----------------+----------+--------------------------------------------------------------------------------------+
+| type           | string   | "organization"                                            
                          |
++----------------+----------+--------------------------------------------------------------------------------------+
+| 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   |
++----------------+----------+--------------------------------------------------------------------------------------+
+| organization   | string   | The name of the organization.                             
                          |
++----------------+----------+--------------------------------------------------------------------------------------+
+| username       | string   | The username of the administrator.                        
                          |
++----------------+----------+--------------------------------------------------------------------------------------+
+| name           | string   | The name of the administrator.                            
                          |
++----------------+----------+--------------------------------------------------------------------------------------+
+| email          | string   | The email address of the administrator.                   
                          |
++----------------+----------+--------------------------------------------------------------------------------------+
+| password       | string   | The password of the administrator. (create-only)          
                          |
++----------------+----------+--------------------------------------------------------------------------------------+
 
-Property                                Type      Description
---------------------------------------- --------- ---------------------------------------------------------------------
-uuid                                    UUID      Organization’s unique entity ID
-type                                    string    "organization"
-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
-organization                            string    The name of the organization.
-username                                string    The username of the administrator.
-name                                    string    The name of the administrator.
-email                                   string    The email address of the administrator.
-password                                string    The password of the administrator. (create-only)
-
-###### Admins
+Admins
+      
 
 An admin user has full access to perform any operation on all
 organization accounts of which the admin user is a member. Using the App
 services 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.
\ No newline at end of file
+admin user, and get an admin user's activity feed.

http://git-wip-us.apache.org/repos/asf/incubator-usergrid/blob/2d073b5a/docs/usage.md
----------------------------------------------------------------------
diff --git a/docs/usage.md b/docs/usage.md
new file mode 100644
index 0000000..b169d1a
--- /dev/null
+++ b/docs/usage.md
@@ -0,0 +1,15 @@
+# SDKs & Tools
+
+## SDKs
+
+* [iOS SDK](https://github.com/apache/incubator-usergrid/tree/master/sdks/ios)
+* [Android SDK](https://github.com/apache/incubator-usergrid/tree/master/sdks/android)
+* [HTML5 / JavaScript SDK](https://github.com/apache/incubator-usergrid/tree/master/sdks/html5-javascript)
+* [Windows 8 / Windows Phone / .net SDK](https://github.com/apache/incubator-usergrid/tree/master/sdks/dotnet)
+* [Ruby gem](https://github.com/apache/incubator-usergrid/tree/master/sdks/ruby)
+* [Ruby on Rails gem](https://github.com/apache/incubator-usergrid/tree/master/sdks/ruby-on-rails)
+* [PHP library](https://github.com/apache/incubator-usergrid/tree/master/sdks/php)
+* [Java library](https://github.com/apache/incubator-usergrid/tree/master/sdks/java)
+
+## Tools
+[ugc — the Command-line Client](https://github.com/apache/incubator-usergrid/tree/master/ugc#usergrid-command-line-ugc)
\ No newline at end of file


Mime
View raw message