You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@usergrid.apache.org by sn...@apache.org on 2015/08/07 23:06:01 UTC
[07/21] incubator-usergrid git commit: Fix broken links and add
missing references.
Fix broken links and add missing references.
Project: http://git-wip-us.apache.org/repos/asf/incubator-usergrid/repo
Commit: http://git-wip-us.apache.org/repos/asf/incubator-usergrid/commit/6b144189
Tree: http://git-wip-us.apache.org/repos/asf/incubator-usergrid/tree/6b144189
Diff: http://git-wip-us.apache.org/repos/asf/incubator-usergrid/diff/6b144189
Branch: refs/heads/master
Commit: 6b144189aba9de1d6ca1a8c95f41f789583e0f5b
Parents: fc52c0e
Author: Dave Johnson <sn...@apache.org>
Authored: Fri Aug 7 13:51:15 2015 -0400
Committer: Dave Johnson <sn...@apache.org>
Committed: Fri Aug 7 13:51:15 2015 -0400
----------------------------------------------------------------------
docs/README.md | 2 +-
docs/_static/css/theme.css | 164 +++---------------------------
docs/data-storage/data-store-dbms.md | 8 +-
docs/index.rst | 5 +-
docs/introduction/data-model.md | 28 ++---
docs/introduction/overview.md | 17 ++++
docs/orgs-and-apps/admin-user.md | 2 +-
7 files changed, 55 insertions(+), 171 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/incubator-usergrid/blob/6b144189/docs/README.md
----------------------------------------------------------------------
diff --git a/docs/README.md b/docs/README.md
index 07ab32b..2f7888c 100644
--- a/docs/README.md
+++ b/docs/README.md
@@ -65,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/6b144189/docs/_static/css/theme.css
----------------------------------------------------------------------
diff --git a/docs/_static/css/theme.css b/docs/_static/css/theme.css
index f225469..b0b1c33 100755
--- a/docs/_static/css/theme.css
+++ b/docs/_static/css/theme.css
@@ -5314,9 +5314,9 @@ span[id*='MathJax-Span'] {
/*# sourceMappingURL=theme.css.map */
-/* Usergrid specific */
+/* Start - Usergrid Additions */
-.usergrid-table {
+.usergrid-table, docutils {
border: 1px solid grey;
margin-bottom: 2em;
}
@@ -5331,6 +5331,10 @@ span[id*='MathJax-Span'] {
font-size: 80%;
}
+.usergrid-table th, .docutils th {
+ background-color: #e5ebeb;
+}
+
.caption-text {
font-size:140%;
}
@@ -5360,159 +5364,21 @@ h2.usergrid-DELETE-heading {
margin-bottom: 2em;
}
-/* css from petstore example
-
-body {
- font-family: Trebuchet MS, sans-serif;
+div.wy-menu-vertical li {
font-size: 15px;
- color: #444;
- margin-right: 24px;
+ margin-bottom: 0.0em;
+ margin-left: 1.5em;
}
-h1 {
- font-size: 25px;
-}
-h2 {
- font-size: 20px;
-}
-h3 {
+ul.simple li, ol.simple li {
font-size: 16px;
- font-weight: bold;
-}
-hr {
- height: 1px;
- border: 0;
- color: #ddd;
- background-color: #ddd;
- display: none;
-}
-
-.app-desc {
- clear: both;
- margin-left: 20px;
-}
-.param-name {
- width: 100%;
-}
-.license-info {
- margin-left: 20px;
-}
-
-.license-url {
- margin-left: 20px;
-}
-
-.model {
- margin: 0 0 0px 20px;
-}
-
-.method {
- margin-left: 20px;
-}
-
-.method-notes {
- margin: 10px 0 20px 0;
- font-size: 90%;
- color: #555;
-}
-
-pre {
- padding: 10px;
- margin-bottom: 2px;
+ margin-top: 0.5em;
+ margin-bottom: 0.5em;
}
-pre.get {
- background-color: #0f6ab4;
-}
-
-pre.post {
- background-color: #10a54a;
-}
-
-pre.put {
- background-color: #c5862b;
-}
-
-pre.delete {
- background-color: #a41e22;
-}
-
-.huge {
- color: #fff;
-}
-
-pre.example {
- background-color: #f3f3f3;
- padding: 10px;
- border: 1px solid #ddd;
-}
-
-code {
- white-space: pre;
-}
-
-.nickname {
- font-weight: bold;
-}
-
-.method-path {
- font-size: 1.5em;
- background-color: #0f6ab4;
-}
-
-.parameter {
- width: 500px;
-}
-
-.param {
- width: 500px;
- padding: 10px 0 0 20px;
- font-weight: bold;
-}
-
-.param-desc {
- width: 700px;
- padding: 0 0 0 20px;
- color: #777;
-}
-
-.param-type {
- font-style: italic;
-}
-
-.field-label {
- padding: 0;
- margin: 0;
- clear: both;
-}
-
-.field-items {
- padding: 0 0 15px 0;
- margin-bottom: 15px;
-}
-
-.return-type {
- clear: both;
- padding-bottom: 10px;
-}
-
-.param-header {
- font-weight: bold;
-}
-
-.method-tags {
- text-align: right;
-}
-
-.method-tag {
- background: none repeat scroll 0% 0% #24A600;
- border-radius: 3px;
- padding: 2px 10px;
- margin: 2px;
- color: #FFF;
- display: inline-block;
- text-decoration: none;
+h1 p {
+ font-size:150%;
}
-*/
+/* End - Usergrid Additions */
http://git-wip-us.apache.org/repos/asf/incubator-usergrid/blob/6b144189/docs/data-storage/data-store-dbms.md
----------------------------------------------------------------------
diff --git a/docs/data-storage/data-store-dbms.md b/docs/data-storage/data-store-dbms.md
index 0ea09d4..56fbbdb 100644
--- a/docs/data-storage/data-store-dbms.md
+++ b/docs/data-storage/data-store-dbms.md
@@ -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/6b144189/docs/index.rst
----------------------------------------------------------------------
diff --git a/docs/index.rst b/docs/index.rst
index bcb3092..1afd267 100644
--- a/docs/index.rst
+++ b/docs/index.rst
@@ -8,6 +8,7 @@ Apache Usergrid Documentation
:maxdepth: 2
:caption: Introduction
+ introduction/overview.md
introduction/usergrid-features
introduction/data-model
introduction/async-vs-sync
@@ -122,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:
@@ -139,7 +140,7 @@ Apache Usergrid Documentation
:caption: Client SDKs
sdks/tbd
-
+
.. _installation:
.. toctree::
http://git-wip-us.apache.org/repos/asf/incubator-usergrid/blob/6b144189/docs/introduction/data-model.md
----------------------------------------------------------------------
diff --git a/docs/introduction/data-model.md b/docs/introduction/data-model.md
index 111e225..41421bd 100644
--- a/docs/introduction/data-model.md
+++ b/docs/introduction/data-model.md
@@ -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/6b144189/docs/introduction/overview.md
----------------------------------------------------------------------
diff --git a/docs/introduction/overview.md b/docs/introduction/overview.md
new file mode 100644
index 0000000..e9c6968
--- /dev/null
+++ b/docs/introduction/overview.md
@@ -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/6b144189/docs/orgs-and-apps/admin-user.md
----------------------------------------------------------------------
diff --git a/docs/orgs-and-apps/admin-user.md b/docs/orgs-and-apps/admin-user.md
index 87b96f9..6b1b7d3 100644
--- a/docs/orgs-and-apps/admin-user.md
+++ b/docs/orgs-and-apps/admin-user.md
@@ -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).