Author: rbaxter85
Date: Tue Apr 24 01:42:46 2012
New Revision: 1329526
URL: http://svn.apache.org/viewvc?rev=1329526&view=rev
Log:
More updates to the site
Added:
shindig/site/trunk/cms/trunk/content/about_shindig_getting_started.mdtext
shindig/site/trunk/cms/trunk/content/community_overview.mdtext
shindig/site/trunk/cms/trunk/content/images/common_container.png (with
props)
shindig/site/trunk/cms/trunk/content/images/common_container_manage_gadgets.png
(with props)
shindig/site/trunk/cms/trunk/content/images/shindig-client.jpg (with
props)
Modified:
shindig/site/trunk/cms/trunk/content/about_shindig_overview.mdtext
shindig/site/trunk/cms/trunk/templates/navbar.html
Added: shindig/site/trunk/cms/trunk/content/about_shindig_getting_started.mdtext
URL:
http://svn.apache.org/viewvc/shindig/site/trunk/cms/trunk/content/about_shindig_getting_started.mdtext?rev=1329526&view=auto
==============================================================================
--- shindig/site/trunk/cms/trunk/content/about_shindig_getting_started.mdtext
(added)
+++ shindig/site/trunk/cms/trunk/content/about_shindig_getting_started.mdtext
Tue Apr 24 01:42:46 2012
@@ -0,0 +1,49 @@
+Title: Getting Started
+Notice: Licensed to the Apache Software Foundation (ASF) under one
+ or more contributor license agreements. See the NOTICE file
+ distributed with this work for additional information
+ regarding copyright ownership. The ASF licenses this file
+ to you under the Apache License, Version 2.0 (the
+ "License"); you may not use this file except in compliance
+ with the License. You may obtain a copy of the License at
+ .
+ http://www.apache.org/licenses/LICENSE-2.0
+ .
+ Unless required by applicable law or agreed to in writing,
+ software distributed under the License is distributed on an
+ "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ KIND, either express or implied. See the License for the
+ specific language governing permissions and limitations
+ under the License.
+
+# Getting Started
+
+So, you correctly [downloaded](download.html) and [installed](download.html)
Apache Shindig, what's next?
+
+## Discovering Apache Shindig Samples
+
+The sample container should be your first starting point:
+
+[http://localhost:8080/samplecontainer/examples/commoncontainer/index.html](http://localhost:8080/samplecontainer/examples/commoncontainer/index.html)
+
+The page displayed in the figure bellow is the Apache Shindig sample
container. Its goal is to help you to deploy and test your
+applications. It is build ontop of the common container client side code.
+
+
+
+By default there are no gadgets displayed in the container. You can add a
gadget to the container by entering a URL to a
+gadget definition and pressing "Preload and Add" or by selecting from a list
of predefined gadgets and pressing "Add Gadgets" in
+the manage gadgets section of the container.
+
+
+
+There are various sets of predefinied gadgets available to you in the sample
common container page. See each individual gadget
+for details on what it does.
+
+<span class="label label-important">Consider listing the other containers,
like the embedded experiences and container services container. Should we
continue to list the deprecated containers?</span>
+
+# Playing With Apache Shindig
+
+
+
+
Modified: shindig/site/trunk/cms/trunk/content/about_shindig_overview.mdtext
URL:
http://svn.apache.org/viewvc/shindig/site/trunk/cms/trunk/content/about_shindig_overview.mdtext?rev=1329526&r1=1329525&r2=1329526&view=diff
==============================================================================
--- shindig/site/trunk/cms/trunk/content/about_shindig_overview.mdtext
(original)
+++ shindig/site/trunk/cms/trunk/content/about_shindig_overview.mdtext Tue Apr
24 01:42:46 2012
@@ -45,4 +45,85 @@ number of sites. Since December 2007, Ap
# Apache Shindig Components
-## Server Side
\ No newline at end of file
+## Server Side
+
+The Java and PHP version of Apache Shindig have 3 major server side components:
+
+1. Persistent Data Loading Mechanism.
+2. Gadget Rendering Infrastructure.
+3. OpenSocial server side implementation.
+
+<div class="row-fluid">
+ <div class="span6">
+ <div class="thumbnail">
+ <div class="caption">
+ <h5>Components of Apache Shindig Java Server Side container</h5>
+ </div>
+ <img src="images/shindig-server-java.jpg"/>
+ </div>
+ </div>
+ <div class="span6">
+ <div class="thumbnail">
+ <div class="caption">
+ <h5>Components of Apache Shindig PHP Server Side container</h5>
+ </div>
+ <img src="images/shindig-server-php.jpg"/>
+ </div>
+ </div>
+</div>
+
+## Client Side
+
+The Javascript features are:
+
+* Gadget container (gadget.js), fully OpenSocial gadget compliant.
+* OpenSocial container.
+* [JSON](http://www.json.org/), Restful container and
[Caja](http://code.google.com/p/google-caja/) support.
+
+<div class="row-fluid">
+ <div class="span6">
+ <div class="thumbnail">
+ <img src="images/shindig-client.jpg"/>
+ </div>
+ </div>
+</div>
+
+## Put It Together: OpenSocial Flow
+
+The following is a typical flow to get a list of Friends.
+
+### Server Side Flow
+
+1. Call JsonRpcServlet.
+2. Get the appropriate handler.
+3. Get the JSON object from the DB.
+4. Populate responses into a list.
+5. Return to the client.
+
+In the case of the REST use, the flow will be:
+
+1. Call DataServiceServlet.
+2. Get the appropriate converter.
+3. Get the handler.
+4. Get the JSON object from the DB.
+5. Return to the client.
+
+### Client Side Flow
+
+1. Create request object.
+2. Populate request parameters.
+3. Send the request.
+
+## OpenSocial APIs
+
+Apache Shindig implements several OpenSocial APIs:
+
+* OpenSocial REST: for server to server communication
+* OpenSocial JSON-RPC: for gadget to server communication
+* Javascript: for gadgets
+
+For more information on the OpenSocial APIs see the [OpenSocial
spec](http://docs.opensocial.org/display/OSD/Specs).
+
+## Resources
+* [Overview of REST Implementation in Apache Shindig - Java
Version](https://sites.google.com/site/opensocialarticles/Home/shindig-rest-java)
by Rajdeep Dua.
+* [Presentation on Shindig Architecture -
Java](https://sites.google.com/site/opensocialarticles/shindig-architecture-presentation)
by Rajdeep Dua.
\ No newline at end of file
Added: shindig/site/trunk/cms/trunk/content/community_overview.mdtext
URL:
http://svn.apache.org/viewvc/shindig/site/trunk/cms/trunk/content/community_overview.mdtext?rev=1329526&view=auto
==============================================================================
--- shindig/site/trunk/cms/trunk/content/community_overview.mdtext (added)
+++ shindig/site/trunk/cms/trunk/content/community_overview.mdtext Tue Apr 24
01:42:46 2012
@@ -0,0 +1,73 @@
+Title: Overview
+Notice: Licensed to the Apache Software Foundation (ASF) under one
+ or more contributor license agreements. See the NOTICE file
+ distributed with this work for additional information
+ regarding copyright ownership. The ASF licenses this file
+ to you under the Apache License, Version 2.0 (the
+ "License"); you may not use this file except in compliance
+ with the License. You may obtain a copy of the License at
+ .
+ http://www.apache.org/licenses/LICENSE-2.0
+ .
+ Unless required by applicable law or agreed to in writing,
+ software distributed under the License is distributed on an
+ "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ KIND, either express or implied. See the License for the
+ specific language governing permissions and limitations
+ under the License.
+
+# Overview
+
+Apache Shindig, like any other opensource project, relies heavily on the
efforts of the entire user community to
+be ever vigilant for improvements, logging of defects, communicating
use-cases, generating documentation, and being wary
+of other users in need. This is a quick guide outlining what members of the
Apache Shindig community may do to make the
+system work better for everyone.
+
+## Why Would I Want To Help?
+
+There are several reasons these are good things.
+
+* By answering other people's questions, you can learn more for yourself
+* By submitting your own fixes, they get incorporated faster
+* By reporting issues, you ensure that bugs don't get missed, or forgotten
+* You are giving back to a community that has given you software for free
+
+## How to contribute?
+
+As with any open source project, there are several ways you can help:
+
+* Join the [mailing list](mail-lists.html) and answer other user's questions
+* Report bugs, feature requests and other issues in the [issue
tracking](issue-tracking.html) application.
+* [Build Java Apache Shindig](developers/java/build.html) or [Build PHP
Apache Shindig](developers/php/build.html)
+for yourself, in order to fix bugs.
+* [Submit patches][patches] to reported issues (both those you find, or that
others have filed)
+* Help with the documentation by pointing out areas that are lacking or
unclear, and if you are so inclined,
+submitting patches to correct it. You can quickly contribute rough thoughts to
the wiki, or you can volunteer to help
+collate and organize information that is already there.
+
+__Your participation in the community is much appreciated!__
+
+## Create and submitting a patch
+
+__Note:__ Be sure to respect our Java code style! You could also read this
thread
+[http://markmail.org/message/t6b7jgzvfjj4fiqu](http://markmail.org/message/t6b7jgzvfjj4fiqu).
+
+For new people to the project, creating patches is the way to get started and
build your reputation.
+
+1. Start editing the code, since Subversion is being used no checkout is
needed
+2. Move to top level folder, e.g. cd ~/src/shindig
+3. Generate diffs using svn di > fix-xxx-bug.patch
+4. If needed, remove from the patch file any changes you do not want to
submit until later
+5. If you're new, create an account on
[https://issues.apache.org/jira/browse/SHINDIG](https://issues.apache.org/jira/browse/SHINDIG)
+6. Create a new issue with the patch:
+ 1. Follow the "New" link:
[https://issues.apache.org/jira/secure/CreateIssue!default.jspa](https://issues.apache.org/jira/secure/CreateIssue!default.jspa)
+ 2. For the "Issue Type", select "Bug", "Improvement" or "New Feature"
+ 3. Click "Next>>"
+ 4. Enter summary / description and select the component
+ 5. Click "Create"
+ 6. Click "Attach file" and select the fix-xxx-bug.patch file
+ 7. Check the "Grant license to ASF for inclusion in ASF works" option
+ 8. Click on "Watching" and then click on "Start" watching to get updates
+7. If your patch includes major changes, the Apache Shindig project uses
[reviews.apache.org](https://reviews.apache.org/dashboard/) to review your
patch. You need a Google Account to process. Go to the sign up form to create
an account if you don't already have one. When creating a codereview issue add
[email protected] as the reviewer and DO NOT add dev@.
+
+The newly created issue will automatically be sent to [email protected].
You should also subscribe using [email protected] to see all the
feedback, in which case you'll get the updates on the issue without needing to
"Watch" them individually.
Added: shindig/site/trunk/cms/trunk/content/images/common_container.png
URL:
http://svn.apache.org/viewvc/shindig/site/trunk/cms/trunk/content/images/common_container.png?rev=1329526&view=auto
==============================================================================
Binary file - no diff available.
Propchange: shindig/site/trunk/cms/trunk/content/images/common_container.png
------------------------------------------------------------------------------
svn:mime-type = application/octet-stream
Added:
shindig/site/trunk/cms/trunk/content/images/common_container_manage_gadgets.png
URL:
http://svn.apache.org/viewvc/shindig/site/trunk/cms/trunk/content/images/common_container_manage_gadgets.png?rev=1329526&view=auto
==============================================================================
Binary file - no diff available.
Propchange:
shindig/site/trunk/cms/trunk/content/images/common_container_manage_gadgets.png
------------------------------------------------------------------------------
svn:mime-type = application/octet-stream
Added: shindig/site/trunk/cms/trunk/content/images/shindig-client.jpg
URL:
http://svn.apache.org/viewvc/shindig/site/trunk/cms/trunk/content/images/shindig-client.jpg?rev=1329526&view=auto
==============================================================================
Binary file - no diff available.
Propchange: shindig/site/trunk/cms/trunk/content/images/shindig-client.jpg
------------------------------------------------------------------------------
svn:mime-type = application/octet-stream
Modified: shindig/site/trunk/cms/trunk/templates/navbar.html
URL:
http://svn.apache.org/viewvc/shindig/site/trunk/cms/trunk/templates/navbar.html?rev=1329526&r1=1329525&r2=1329526&view=diff
==============================================================================
--- shindig/site/trunk/cms/trunk/templates/navbar.html (original)
+++ shindig/site/trunk/cms/trunk/templates/navbar.html Tue Apr 24 01:42:46 2012
@@ -17,7 +17,7 @@
</a>
<ul class="dropdown-menu">
<li><a href="about_shindig_overview.html">Overview</a></li>
- <li><a href="#">Getting Started</a></li>
+ <li><a href="about_shindig_getting_started.html">Getting
Started</a></li>
<li><a href="#">FAQ</a></li>
<li><a href="#">Resources</a></li>
<li><a href="#">Powered By</a></li>
@@ -41,7 +41,7 @@
<b class="caret"></b>
</a>
<ul class="dropdown-menu">
- <li><a href="#">Overview</a></li>
+ <li><a href="community_overview.html">Overview</a></li>
<li><a href="#">Getting Help</a></li>
<li><a href="#">Issue Tracking</a></li>
<li><a href="#">Source Repository</a></li>
