Added: websites/staging/shindig/trunk/content/releasing.html ============================================================================== --- websites/staging/shindig/trunk/content/releasing.html (added) +++ websites/staging/shindig/trunk/content/releasing.html Tue Jul 10 20:56:19 2012 @@ -0,0 +1,332 @@ +<!-- + * 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. +--> +<!DOCTYPE html> +<!-- + * 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. +--> +<html lang="en"> + <head> + <meta charset="utf-8"> + <title>Shindig - Releasing Apache Shindig</title> + <meta name="viewport" content="width=device-width, initial-scale=1.0"> + <meta name="description" content=""> + <meta name="author" content=""> + + <!-- Le styles --> + <link href="bootstrap/css/bootstrap.css" rel="stylesheet"> + <style type="text/css"> + body { + padding-top: 60px; + padding-bottom: 40px; + } + </style> + <link href="bootstrap/css/bootstrap-responsive.css" rel="stylesheet"> + + <!-- Le HTML5 shim, for IE6-8 support of HTML5 elements --> + <!--[if lt IE 9]> + <script src="//html5shim.googlecode.com/svn/trunk/html5.js"></script> + <![endif]--> + + <!-- Le fav and touch icons --> + <link rel="shortcut icon" href="images/favicon.ico"> + <link rel="apple-touch-icon" href="images/apple-touch-icon.png"> + <link rel="apple-touch-icon" sizes="72x72" href="images/apple-touch-icon-72x72.png"> + <link rel="apple-touch-icon" sizes="114x114" href="images/apple-touch-icon-114x114.png"> + </head> + + <body> + + <div class="navbar navbar-fixed-top"> + <div class="navbar-inner"> + <div class="container"> + <a class="btn btn-navbar" data-toggle="collapse" data-target=".nav-collapse"> + <span class="icon-bar"></span> + <span class="icon-bar"></span> + <span class="icon-bar"></span> + </a> + <a class="brand" href="index.html">Apache Shindig</a> + <!-- + * 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. +--> +<div class="nav-collapse"> + <ul class="nav"> + <li class="dropdown"> + <a class="dropdown-toggle" data-toggle="dropdown" href="#menu1"> + Get Shindig + <b class="caret"></b> + </a> + <ul class="dropdown-menu"> + <li><a href="download.html">Download</a></li> + <li><a href="license.html">License</a></li> + </ul> + </li> + <li class="dropdown"> + <a class="dropdown-toggle" data-toggle="dropdown" href="#menu1"> + About Shindig + <b class="caret"></b> + </a> + <ul class="dropdown-menu"> + <li><a href="about_shindig_overview.html">Overview</a></li> + <li><a href="about_shindig_getting_started.html">Getting Started</a></li> + <li><a href="faq.html">FAQ</a></li> + <li><a href="resources.html">Resources</a></li> + <li><a href="powered-by.html">Powered By</a></li> + </ul> + </li> + <li class="dropdown"> + <a class="dropdown-toggle" data-toggle="dropdown" href="#menu1"> + Documentation + <b class="caret"></b> + </a> + <ul class="dropdown-menu"> + <li><a href="#">Centre</a></li> + <li><a href="#">Java</a></li> + <li><a href="#">PHP</a></li> + <li><a href="#">Features</a></li> + </ul> + </li> + <li class="dropdown"> + <a class="dropdown-toggle" data-toggle="dropdown" href="#menu1"> + Community + <b class="caret"></b> + </a> + <ul class="dropdown-menu"> + <li><a href="community_overview.html">Overview</a></li> + <li><a href="getting-help.html">Getting Help</a></li> + <li><a href="issue-tracking.html">Issue Tracking</a></li> + <li><a href="source-repository.html">Source Repository</a></li> + <li><a href="https://cwiki.apache.org/confluence/display/SHINDIG/Index";>Wiki</a></li> + <li><a href="#">The Shindig Team</a></li> + </ul> + </li> + <li class="dropdown"> + <a class="dropdown-toggle" data-toggle="dropdown" href="#menu1"> + Misc + <b class="caret"></b> + </a> + <ul class="dropdown-menu"> + <li><a href="http://www.apache.org/";>Apache</a></li> + <li><a href="http://www.apache.org/foundation/sponsorship.html";>Sponsorship</a></li> + <li><a href="http://www.apache.org/foundation/thanks.html";>Thanks</a></li> + </ul> + </li> + <li class="dropdown"> + <a class="dropdown-toggle" data-toggle="dropdown" href="#menu1"> + Project Doc + <b class="caret"></b> + </a> + <ul class="dropdown-menu"> + <li><a href="#">Project Information</a></li> + </ul> + </li> + </ul> + </div><!--/.nav-collapse --> + </div> + </div> + </div> + + <div class="container"> + <h1 id="apache-shindig-release-process">Apache Shindig Release Process</h1> +<p>This document describes how Apache Shindig's committers will make a release.</p> +<ul> +<li>Apache Shindig Release Process<ol> +<li>Release Discussions</li> +<li>Prepare The Release</li> +<li>Stage The Release</li> +<li>Deploy The Documentation</li> +<li>Propose A Vote</li> +<li>Publish The Release</li> +<li>Publish The Website</li> +<li>Announce The Release</li> +<li>Celebrate :o)</li> +</ol> +</li> +</ul> +<p>Notes:</p> +<ol> +<li>This process is based on the <a href="http://maven.apache.org/developers/release/releasing.html";>Maven Release Process</a>. +Please read it firstly for the prerequisites and technical notes.</li> +<li>The items 2 to 5 should take you 1-2 hours, depending your machine and your Internet +connection.</li> +<li>Some of the build steps require more than the default amount of maven memory. +You should set MAVEN_OPTS to a larger value, -Xmx512m seems to be sufficient.</li> +</ol> +<h2 id="1-release-discussions">1. Release Discussions</h2> +<p>The starting point will be a consensus in the developer community about the release and the +JIRA issues to include (or not) in the next release. Typically, the discussion will be +on the <a href="mail-lists.html">Dev List</a>.</p> +<h2 id="2-prepare-the-release">2. Prepare The Release</h2> +<p>Duration: 20 min</p> +<p>Now that everybody in the community is happy to push a release, the release manager needs to +verify the source code before to continue:</p> +<ol> +<li>Make sure there are no snapshots (less the current version) in the POMs to be released.</li> +<li>Check that your POMs will not lose content when they are rewritten during the release process.<ul> +<li>mvn release:prepare -DdryRun=true -Papache-release</li> +<li>Diff the original file pom.xml with the one called pom.xml.tag to see if the license or +any other info has been removed. The only things that should be different between these files +are the version and scm elements. Any other changes, you must backport yourself to the +original pom.xml file and commit before proceeding with the release.</li> +<li>Verify that all Apache Shindig modules will be touched, including assembly and samples.</li> +</ul> +</li> +</ol> +<p>Next, prepare the release by calling Maven:</p> +<pre> +mvn release:clean -Papache-release +mvn release:prepare -Papache-release +</pre> + +<p>Notes:</p> +<ol> +<li>-Papache-release is very important since assembly and samples modules are not included +by default in the build (for productivity reasons).</li> +<li>Preparing the release will create a new tag in SVN, automatically checking in on your +behalf. Verify the SVN logs in the <a href="mail-lists.html">Commit List</a> or review the generated tag.</li> +<li>All license headers and legal files will be checked by RAT (Release Audit Tool).</li> +</ol> +<h2 id="3-stage-the-release">3. Stage The Release</h2> +<p>Duration: 30 min</p> +<p>Call Maven to publish the generated artifacts:</p> +<pre> +mvn release:perform -Papache-release +</pre> + +<p>Note: All artifacts will be signed and pushed to +<a href="https://repository.apache.org/";>https://repository.apache.org/</a>.</p> +<p>Close the staging repository as described in the points 5 and 6 of the +<a href="http://maven.apache.org/developers/release/releasing.html";>Maven Release Process</a>.</p> +<h2 id="4-deploy-the-documentation">4. Deploy The Documentation</h2> +<p>Duration: 20 min</p> +<p>Call Maven to publish the generated technical site:</p> +<pre> +cd target/checkout +mvn site -Preporting +mvn site:deploy +</pre> + +<p>Optional: Redeploy the current website:</p> +<p><span class="label label-important">Need to document how to update new site.</span></p> +<h2 id="5-propose-a-vote">5. Propose A Vote</h2> +<p>Start a release vote on the <a href="mail-lists.html">Dev List</a>. The vote must be aligned with +the <a href="http://www.apache.org/foundation/voting.html";>Apache</a> vote process.</p> +<p>Typically, the mail should include the +<a href="http://www.atlassian.com/software/jira/docs/latest/releasenotes.html";>Jira release notes</a>, +the staging repository URL and the site URL, for instance:</p> +<pre> +To: "Shindig Developers List" <[email protected]> +Subject: [VOTE] Release Apache Shindig version X.Y + +Hi, + +We solved N issues: +https://issues.apache.org/jira/secure/ReleaseNote.jspa?version=XXX&styleName=Html&projectId=12310741 + +There are still a couple of issues left in JIRA: +https://issues.apache.org/jira/secure/IssueNavigator.jspa?reset=true&pid=12310741&status=1 + +Staging repo: +https://repository.apache.org/content/repositories/shindig-staging-[YOUR REPOSITORY ID]/ + +Web site: +http://shindig.apache.org/ + +Vote open for 72 hours. + +[ ] +1 +[ ] +0 +[ ] -1 +</pre> + +<h2 id="6-publish-the-release">6. Publish The Release</h2> +<p>Promote the release as described in the points 10 of the +<a href="http://maven.apache.org/developers/release/releasing.html";>Maven Release Process</a>.</p> +<p>Also, update Jira to specify the release date.</p> +<h2 id="publish-the-website">Publish The Website</h2> +<p>Update the <a href="https://svn.apache.org/repos/asf/shindig/site/trunk/cms/trunk/content/download.mdtext";>download page</a> +and redeploy the website (need to sync):</p> +<p><span class="label label-important">Need to document how to update new site.</span></p> +<h2 id="8-announce-the-release">8. Announce The Release</h2> +<p>Create an announcement similar to:</p> +<pre> +From: [email protected] +To: [email protected], [email protected] +Subject: [ANN] Apache Shindig X.Y Released + +The Apache Shindig team is proud to announce the release +of Apache Shindig, version X.Y-incubating. + +Apache Shindig is a JavaScript container and +implementations of the backend APIs and proxy required for hosting +OpenSocial applications. + +http://shindig.apache.org/ + +Enjoy, + +-The Apache Shindig Team +</pre> + +<h2 id="9-celebrate-o">9. Celebrate :o)</h2> + <hr> + + <footer> + <p>Copyright © 2007-2012 <a href="http://www.apache.org";>The Apache Software Foundation</a>. All Rights Reserved.</p> + </footer> + + </div> <!-- /container --> + + <!-- Le javascript + ================================================== --> + <!-- Placed at the end of the document so the pages load faster --> + <script src="jquery/js/jquery-1.7.1.min.js"></script> + <script src="bootstrap/js/bootstrap.min.js"></script> + + </body> +</html>
Added: websites/staging/shindig/trunk/content/resources.html ============================================================================== --- websites/staging/shindig/trunk/content/resources.html (added) +++ websites/staging/shindig/trunk/content/resources.html Tue Jul 10 20:56:19 2012 @@ -0,0 +1,209 @@ +<!-- + * 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. +--> +<!DOCTYPE html> +<!-- + * 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. +--> +<html lang="en"> + <head> + <meta charset="utf-8"> + <title>Shindig - Apache Shindig Resources</title> + <meta name="viewport" content="width=device-width, initial-scale=1.0"> + <meta name="description" content=""> + <meta name="author" content=""> + + <!-- Le styles --> + <link href="bootstrap/css/bootstrap.css" rel="stylesheet"> + <style type="text/css"> + body { + padding-top: 60px; + padding-bottom: 40px; + } + </style> + <link href="bootstrap/css/bootstrap-responsive.css" rel="stylesheet"> + + <!-- Le HTML5 shim, for IE6-8 support of HTML5 elements --> + <!--[if lt IE 9]> + <script src="//html5shim.googlecode.com/svn/trunk/html5.js"></script> + <![endif]--> + + <!-- Le fav and touch icons --> + <link rel="shortcut icon" href="images/favicon.ico"> + <link rel="apple-touch-icon" href="images/apple-touch-icon.png"> + <link rel="apple-touch-icon" sizes="72x72" href="images/apple-touch-icon-72x72.png"> + <link rel="apple-touch-icon" sizes="114x114" href="images/apple-touch-icon-114x114.png"> + </head> + + <body> + + <div class="navbar navbar-fixed-top"> + <div class="navbar-inner"> + <div class="container"> + <a class="btn btn-navbar" data-toggle="collapse" data-target=".nav-collapse"> + <span class="icon-bar"></span> + <span class="icon-bar"></span> + <span class="icon-bar"></span> + </a> + <a class="brand" href="index.html">Apache Shindig</a> + <!-- + * 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. +--> +<div class="nav-collapse"> + <ul class="nav"> + <li class="dropdown"> + <a class="dropdown-toggle" data-toggle="dropdown" href="#menu1"> + Get Shindig + <b class="caret"></b> + </a> + <ul class="dropdown-menu"> + <li><a href="download.html">Download</a></li> + <li><a href="license.html">License</a></li> + </ul> + </li> + <li class="dropdown"> + <a class="dropdown-toggle" data-toggle="dropdown" href="#menu1"> + About Shindig + <b class="caret"></b> + </a> + <ul class="dropdown-menu"> + <li><a href="about_shindig_overview.html">Overview</a></li> + <li><a href="about_shindig_getting_started.html">Getting Started</a></li> + <li><a href="faq.html">FAQ</a></li> + <li><a href="resources.html">Resources</a></li> + <li><a href="powered-by.html">Powered By</a></li> + </ul> + </li> + <li class="dropdown"> + <a class="dropdown-toggle" data-toggle="dropdown" href="#menu1"> + Documentation + <b class="caret"></b> + </a> + <ul class="dropdown-menu"> + <li><a href="#">Centre</a></li> + <li><a href="#">Java</a></li> + <li><a href="#">PHP</a></li> + <li><a href="#">Features</a></li> + </ul> + </li> + <li class="dropdown"> + <a class="dropdown-toggle" data-toggle="dropdown" href="#menu1"> + Community + <b class="caret"></b> + </a> + <ul class="dropdown-menu"> + <li><a href="community_overview.html">Overview</a></li> + <li><a href="getting-help.html">Getting Help</a></li> + <li><a href="issue-tracking.html">Issue Tracking</a></li> + <li><a href="source-repository.html">Source Repository</a></li> + <li><a href="https://cwiki.apache.org/confluence/display/SHINDIG/Index";>Wiki</a></li> + <li><a href="#">The Shindig Team</a></li> + </ul> + </li> + <li class="dropdown"> + <a class="dropdown-toggle" data-toggle="dropdown" href="#menu1"> + Misc + <b class="caret"></b> + </a> + <ul class="dropdown-menu"> + <li><a href="http://www.apache.org/";>Apache</a></li> + <li><a href="http://www.apache.org/foundation/sponsorship.html";>Sponsorship</a></li> + <li><a href="http://www.apache.org/foundation/thanks.html";>Thanks</a></li> + </ul> + </li> + <li class="dropdown"> + <a class="dropdown-toggle" data-toggle="dropdown" href="#menu1"> + Project Doc + <b class="caret"></b> + </a> + <ul class="dropdown-menu"> + <li><a href="#">Project Information</a></li> + </ul> + </li> + </ul> + </div><!--/.nav-collapse --> + </div> + </div> + </div> + + <div class="container"> + <h1 id="articles-on-apache-shindig">Articles on Apache Shindig</h1> +<p>All articles on Apache Shindig are listed on our +<a href="http://cwiki.apache.org/confluence/display/SHINDIG/Index#Index-ArticlesonShindig";>Wiki</a>.</p> +<p>If you are writing an article on Apache Shindig we suggest contacting the developers on the +mailing list as we would be happy to provide feedback to help ensure accuracy in your article. +Just ping us on the <a href="mail-lists.html">dev mailing list</a> to get in touch.</p> +<h1 id="resources">Resources</h1> +<p>The following list is some pointers on related OpenSocial resources.</p> +<ul> +<li><a href="http://opensocial.org/";>OpenSocial Foundation</a></li> +<li><a href="http://docs.opensocial.org";>OpenSocial Community Wiki</a></li> +<li><a href="http://code.google.com/apis/opensocial";>OpenSocial project</a></li> +<li><a href="http://code.google.com/p/opensocial-resources/";>OpenSocial resources project</a></li> +<li><a href="http://code.google.com/p/gadget-resources/";>Gadget resources project</a></li> +<li><a href="http://ostemplates-demo.appspot.com/";>OpenSocial Templates</a></li> +<li><a href="http://osda.appspot.com/";>OpenSocial Dev App</a></li> +<li><a href="http://ostemplates-devapp.appspot.com/";>OpenSocial Templates Developer App</a></li> +<li><b>Add more, see <a href="community_overview.html">How to Contribute</a> page</b></li> +</ul> + <hr> + + <footer> + <p>Copyright © 2007-2012 <a href="http://www.apache.org";>The Apache Software Foundation</a>. All Rights Reserved.</p> + </footer> + + </div> <!-- /container --> + + <!-- Le javascript + ================================================== --> + <!-- Placed at the end of the document so the pages load faster --> + <script src="jquery/js/jquery-1.7.1.min.js"></script> + <script src="bootstrap/js/bootstrap.min.js"></script> + + </body> +</html> Added: websites/staging/shindig/trunk/content/sitemap.html ============================================================================== --- websites/staging/shindig/trunk/content/sitemap.html (added) +++ websites/staging/shindig/trunk/content/sitemap.html Tue Jul 10 20:56:19 2012 @@ -0,0 +1,19 @@ +<!-- + * 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. +--> + Added: websites/staging/shindig/trunk/content/source-repository.html ============================================================================== --- websites/staging/shindig/trunk/content/source-repository.html (added) +++ websites/staging/shindig/trunk/content/source-repository.html Tue Jul 10 20:56:19 2012 @@ -0,0 +1,230 @@ +<!-- + * 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. +--> +<!DOCTYPE html> +<!-- + * 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. +--> +<html lang="en"> + <head> + <meta charset="utf-8"> + <title>Shindig - Source Repository</title> + <meta name="viewport" content="width=device-width, initial-scale=1.0"> + <meta name="description" content=""> + <meta name="author" content=""> + + <!-- Le styles --> + <link href="bootstrap/css/bootstrap.css" rel="stylesheet"> + <style type="text/css"> + body { + padding-top: 60px; + padding-bottom: 40px; + } + </style> + <link href="bootstrap/css/bootstrap-responsive.css" rel="stylesheet"> + + <!-- Le HTML5 shim, for IE6-8 support of HTML5 elements --> + <!--[if lt IE 9]> + <script src="//html5shim.googlecode.com/svn/trunk/html5.js"></script> + <![endif]--> + + <!-- Le fav and touch icons --> + <link rel="shortcut icon" href="images/favicon.ico"> + <link rel="apple-touch-icon" href="images/apple-touch-icon.png"> + <link rel="apple-touch-icon" sizes="72x72" href="images/apple-touch-icon-72x72.png"> + <link rel="apple-touch-icon" sizes="114x114" href="images/apple-touch-icon-114x114.png"> + </head> + + <body> + + <div class="navbar navbar-fixed-top"> + <div class="navbar-inner"> + <div class="container"> + <a class="btn btn-navbar" data-toggle="collapse" data-target=".nav-collapse"> + <span class="icon-bar"></span> + <span class="icon-bar"></span> + <span class="icon-bar"></span> + </a> + <a class="brand" href="index.html">Apache Shindig</a> + <!-- + * 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. +--> +<div class="nav-collapse"> + <ul class="nav"> + <li class="dropdown"> + <a class="dropdown-toggle" data-toggle="dropdown" href="#menu1"> + Get Shindig + <b class="caret"></b> + </a> + <ul class="dropdown-menu"> + <li><a href="download.html">Download</a></li> + <li><a href="license.html">License</a></li> + </ul> + </li> + <li class="dropdown"> + <a class="dropdown-toggle" data-toggle="dropdown" href="#menu1"> + About Shindig + <b class="caret"></b> + </a> + <ul class="dropdown-menu"> + <li><a href="about_shindig_overview.html">Overview</a></li> + <li><a href="about_shindig_getting_started.html">Getting Started</a></li> + <li><a href="faq.html">FAQ</a></li> + <li><a href="resources.html">Resources</a></li> + <li><a href="powered-by.html">Powered By</a></li> + </ul> + </li> + <li class="dropdown"> + <a class="dropdown-toggle" data-toggle="dropdown" href="#menu1"> + Documentation + <b class="caret"></b> + </a> + <ul class="dropdown-menu"> + <li><a href="#">Centre</a></li> + <li><a href="#">Java</a></li> + <li><a href="#">PHP</a></li> + <li><a href="#">Features</a></li> + </ul> + </li> + <li class="dropdown"> + <a class="dropdown-toggle" data-toggle="dropdown" href="#menu1"> + Community + <b class="caret"></b> + </a> + <ul class="dropdown-menu"> + <li><a href="community_overview.html">Overview</a></li> + <li><a href="getting-help.html">Getting Help</a></li> + <li><a href="issue-tracking.html">Issue Tracking</a></li> + <li><a href="source-repository.html">Source Repository</a></li> + <li><a href="https://cwiki.apache.org/confluence/display/SHINDIG/Index";>Wiki</a></li> + <li><a href="#">The Shindig Team</a></li> + </ul> + </li> + <li class="dropdown"> + <a class="dropdown-toggle" data-toggle="dropdown" href="#menu1"> + Misc + <b class="caret"></b> + </a> + <ul class="dropdown-menu"> + <li><a href="http://www.apache.org/";>Apache</a></li> + <li><a href="http://www.apache.org/foundation/sponsorship.html";>Sponsorship</a></li> + <li><a href="http://www.apache.org/foundation/thanks.html";>Thanks</a></li> + </ul> + </li> + <li class="dropdown"> + <a class="dropdown-toggle" data-toggle="dropdown" href="#menu1"> + Project Doc + <b class="caret"></b> + </a> + <ul class="dropdown-menu"> + <li><a href="#">Project Information</a></li> + </ul> + </li> + </ul> + </div><!--/.nav-collapse --> + </div> + </div> + </div> + + <div class="container"> + <h1 id="source-repository">Source Repository</h1> +<p>Apache Shindig projects use <a href="http://subversion.tigris.org/";>Subversion</a> to manage their source code. +Instructions on Subversion use can be found in the online book <a href="http://svnbook.red-bean.com/";>Version Control with Subversion</a>.</p> +<h2 id="web-access">Web Access</h2> +<p>The following list shows the links to the online source repositories for the various versions of Apache Shindig:</p> +<pre><a href="https://svn.apache.org/repos/asf/shindig/trunk/";>https://svn.apache.org/repos/asf/shindig/trunk/</a></pre> + +<h2 id="anonymous-access">Anonymous Access</h2> +<p>The source can be checked out anonymously from SVN with one of these commands depending on the development +line you are looking for:</p> +<pre>$ svn checkout http://svn.apache.org/repos/asf/shindig/trunk/ shindig</pre> + +<h2 id="developer-access">Developer Access</h2> +<p>Everyone can access the Subversion repository via HTTP, but committers must checkout the Subversion repository +via HTTPS to gain write access:</p> +<pre>$ svn checkout https://svn.apache.org/repos/asf/shindig/trunk/ shindig</pre> + +<p>To commit changes to the repository, execute the following command to commit your changes +(svn will prompt you for your password):</p> +<pre>$ svn commit --username your-username -m "A message"</pre> + +<h2 id="access-from-behind-a-firewall">Access from behind a Firewall</h2> +<p>For those users who are stuck behind a corporate firewall which is blocking HTTP access to the +Subversion repository, you can try to access it via the developer connection:</p> +<pre>$ svn checkout https://svn.apache.org/repos/asf/shindig/trunk/ shindig</pre> + +<h2 id="access-through-a-proxy">Access through a Proxy</h2> +<p>The Subversion client can go through a proxy, if you configure it to do so. First, edit your +servers configuration file to indicate which proxy to use. The file's location depends on your +operating system. On Linux or Unix it is located in the directory ~/.subversion. On Windows it +is in %APPDATA%\Subversion (try echo %APPDATA%, note this is a hidden directory).</p> +<p>There are comments in the file explaining what to do. If you don't have that file, get the +latest Subversion client and run any command; this will cause the configuration directory and +template files to be created.</p> +<p>Example: Edit the servers file and add something like:</p> +<pre> +[global] +http-proxy-host = your.proxy.name +http-proxy-port = 3128 +</pre> + <hr> + + <footer> + <p>Copyright © 2007-2012 <a href="http://www.apache.org";>The Apache Software Foundation</a>. All Rights Reserved.</p> + </footer> + + </div> <!-- /container --> + + <!-- Le javascript + ================================================== --> + <!-- Placed at the end of the document so the pages load faster --> + <script src="jquery/js/jquery-1.7.1.min.js"></script> + <script src="bootstrap/js/bootstrap.min.js"></script> + + </body> +</html> Added: websites/staging/shindig/trunk/content/svn_conventions.html ============================================================================== --- websites/staging/shindig/trunk/content/svn_conventions.html (added) +++ websites/staging/shindig/trunk/content/svn_conventions.html Tue Jul 10 20:56:19 2012 @@ -0,0 +1,244 @@ +<!-- + * 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. +--> +<!DOCTYPE html> +<!-- + * 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. +--> +<html lang="en"> + <head> + <meta charset="utf-8"> + <title>Shindig - Apache Shindig SVN Conventions</title> + <meta name="viewport" content="width=device-width, initial-scale=1.0"> + <meta name="description" content=""> + <meta name="author" content=""> + + <!-- Le styles --> + <link href="bootstrap/css/bootstrap.css" rel="stylesheet"> + <style type="text/css"> + body { + padding-top: 60px; + padding-bottom: 40px; + } + </style> + <link href="bootstrap/css/bootstrap-responsive.css" rel="stylesheet"> + + <!-- Le HTML5 shim, for IE6-8 support of HTML5 elements --> + <!--[if lt IE 9]> + <script src="//html5shim.googlecode.com/svn/trunk/html5.js"></script> + <![endif]--> + + <!-- Le fav and touch icons --> + <link rel="shortcut icon" href="images/favicon.ico"> + <link rel="apple-touch-icon" href="images/apple-touch-icon.png"> + <link rel="apple-touch-icon" sizes="72x72" href="images/apple-touch-icon-72x72.png"> + <link rel="apple-touch-icon" sizes="114x114" href="images/apple-touch-icon-114x114.png"> + </head> + + <body> + + <div class="navbar navbar-fixed-top"> + <div class="navbar-inner"> + <div class="container"> + <a class="btn btn-navbar" data-toggle="collapse" data-target=".nav-collapse"> + <span class="icon-bar"></span> + <span class="icon-bar"></span> + <span class="icon-bar"></span> + </a> + <a class="brand" href="index.html">Apache Shindig</a> + <!-- + * 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. +--> +<div class="nav-collapse"> + <ul class="nav"> + <li class="dropdown"> + <a class="dropdown-toggle" data-toggle="dropdown" href="#menu1"> + Get Shindig + <b class="caret"></b> + </a> + <ul class="dropdown-menu"> + <li><a href="download.html">Download</a></li> + <li><a href="license.html">License</a></li> + </ul> + </li> + <li class="dropdown"> + <a class="dropdown-toggle" data-toggle="dropdown" href="#menu1"> + About Shindig + <b class="caret"></b> + </a> + <ul class="dropdown-menu"> + <li><a href="about_shindig_overview.html">Overview</a></li> + <li><a href="about_shindig_getting_started.html">Getting Started</a></li> + <li><a href="faq.html">FAQ</a></li> + <li><a href="resources.html">Resources</a></li> + <li><a href="powered-by.html">Powered By</a></li> + </ul> + </li> + <li class="dropdown"> + <a class="dropdown-toggle" data-toggle="dropdown" href="#menu1"> + Documentation + <b class="caret"></b> + </a> + <ul class="dropdown-menu"> + <li><a href="#">Centre</a></li> + <li><a href="#">Java</a></li> + <li><a href="#">PHP</a></li> + <li><a href="#">Features</a></li> + </ul> + </li> + <li class="dropdown"> + <a class="dropdown-toggle" data-toggle="dropdown" href="#menu1"> + Community + <b class="caret"></b> + </a> + <ul class="dropdown-menu"> + <li><a href="community_overview.html">Overview</a></li> + <li><a href="getting-help.html">Getting Help</a></li> + <li><a href="issue-tracking.html">Issue Tracking</a></li> + <li><a href="source-repository.html">Source Repository</a></li> + <li><a href="https://cwiki.apache.org/confluence/display/SHINDIG/Index";>Wiki</a></li> + <li><a href="#">The Shindig Team</a></li> + </ul> + </li> + <li class="dropdown"> + <a class="dropdown-toggle" data-toggle="dropdown" href="#menu1"> + Misc + <b class="caret"></b> + </a> + <ul class="dropdown-menu"> + <li><a href="http://www.apache.org/";>Apache</a></li> + <li><a href="http://www.apache.org/foundation/sponsorship.html";>Sponsorship</a></li> + <li><a href="http://www.apache.org/foundation/thanks.html";>Thanks</a></li> + </ul> + </li> + <li class="dropdown"> + <a class="dropdown-toggle" data-toggle="dropdown" href="#menu1"> + Project Doc + <b class="caret"></b> + </a> + <ul class="dropdown-menu"> + <li><a href="#">Project Information</a></li> + </ul> + </li> + </ul> + </div><!--/.nav-collapse --> + </div> + </div> + </div> + + <div class="container"> + <h1 id="apache-shindig-svn-conventions">Apache Shindig SVN Conventions</h1> +<p>This document describes how developers should use SVN, our SCM.</p> +<h2 id="subversion-configuration">Subversion Configuration</h2> +<p>Before committing files in subversion repository, you need to read the +<a href="http://www.apache.org/dev/version-control.html#https-svn";>Committer Subversion Access</a> document +and you must set your svn client with this properties file: svn-props</p> +<h2 id="commit-message-template">Commit Message Template</h2> +<p>Based on <a href="http://www.apache.org/dev/committers.html#applying-patches";>ASF committer's FAQ</a>, +the commits should have a message that follows this template:</p> +<pre> +[issue1, issue2] <<comment>> +Submitted by: (when it was a patch, put that persons name there) + +o some comments +</pre> + +<p>Where:</p> +<ul> +<li><b>issue</b> can be omitted if there was no relevant JIRA issue, though it is strongly +encouraged to create one for significant changes.</li> +<li><b>Submitted by</b> only needs to be specified when a patch is being applied for a non-committer.</li> +<li><b>comments</b> some words about the commits.</li> +</ul> +<h2 id="apply-user-patch">Apply User Patch</h2> +<p>By default, the committer should apply the patch without any <b>major</b> modifications. +In a second step, the committer could apply any changes as usual.</p> +<h2 id="edit-commit-message">Edit Commit Message</h2> +<p>If you want to edit a commit message, you could call:</p> +<pre>svn pe svn:log --revprop -r XXX</pre> + +<p>where <b>XXX</b> is the wanted version</p> +<h2 id="other-useful-subversion-commands-while-developing">Other useful Subversion commands while developing</h2> +<p>If you've done a chunk of work and you would like ditch your changes and start from +scratch use this command to revert to the original checkout:</p> +<pre>$ svn revert -R</pre> + +<p>The -R argument means that the command will recurse down all directories and revert all changes.</p> +<p>Before committing code to the Subversion repository we always set the svn:ignore property on the +directory to prevent some files and directories to be checked in. We always exclude the IDE +project files and the target/ directory. Instead of keeping all of the excludes in mind all +the time it's useful to put them all in a file and reference the file with the -F option:</p> +<pre>$ svn propset svn:ignore -F ~/bin/svnignore</pre> + +<p>An example svnignore file:</p> +<pre> +target +*~ +*.log +.classpath +.project +*.ipr +*.iws +*.iml +</pre> + <hr> + + <footer> + <p>Copyright © 2007-2012 <a href="http://www.apache.org";>The Apache Software Foundation</a>. All Rights Reserved.</p> + </footer> + + </div> <!-- /container --> + + <!-- Le javascript + ================================================== --> + <!-- Placed at the end of the document so the pages load faster --> + <script src="jquery/js/jquery-1.7.1.min.js"></script> + <script src="bootstrap/js/bootstrap.min.js"></script> + + </body> +</html>
