Author: rbaxter85
Date: Thu Jul 5 21:17:25 2012
New Revision: 1357930
URL: http://svn.apache.org/viewvc?rev=1357930&view=rev
Log:
Updated site
Added:
shindig/site/trunk/cms/trunk/content/code_conventions.mdtext
shindig/site/trunk/cms/trunk/content/faq.mdtext
shindig/site/trunk/cms/trunk/content/getting-help.mdtext
shindig/site/trunk/cms/trunk/content/jira_conventions.mdtext
shindig/site/trunk/cms/trunk/content/powered-by.mdtext
shindig/site/trunk/cms/trunk/content/releasing.mdtext
shindig/site/trunk/cms/trunk/content/resources.mdtext
shindig/site/trunk/cms/trunk/content/svn_conventions.mdtext
Modified:
shindig/site/trunk/cms/trunk/content/community_overview.mdtext
Added: shindig/site/trunk/cms/trunk/content/code_conventions.mdtext
URL:
http://svn.apache.org/viewvc/shindig/site/trunk/cms/trunk/content/code_conventions.mdtext?rev=1357930&view=auto
==============================================================================
--- shindig/site/trunk/cms/trunk/content/code_conventions.mdtext (added)
+++ shindig/site/trunk/cms/trunk/content/code_conventions.mdtext Thu Jul 5
21:17:25 2012
@@ -0,0 +1,51 @@
+Title: Apache Shindig Code Conventions
+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.
+
+# Apache Shindig Code Style And Code Conventions
+
+This document describes how developers and contributors should write code. The
reasoning
+of these styles and conventions is mainly for consistency, readability and
maintainability reasons.
+
+## Generic Code Style And Convention
+
+All working files (java, xml, others) should respect the following conventions:
+
+* License Header: Always add the current
+[ASF license header](http://www.apache.org/legal/src-headers.html#headers) in
all versionned files.
+* Trailing Whitespaces: Remove all trailing whitespaces. If your are an
Eclipse user, you could
+use the [Anyedit Eclipse Plugin](http://andrei.gmxhome.de/anyedit/).
+
+and the following style:
+
+* Indentation: Never use tabs!
+* Line wrapping: Always use a 100-column line width.
+
+Note: The specific styles and conventions, listed in the next sections, could
override these generic rules.
+
+## Java
+
+### Java Code Style
+
+The full Apache Shindig for Java is described in our
+[Wiki](http://cwiki.apache.org/SHINDIGxSITE/java-style.html).
+
+<span class="label label-important">Describe how to import Eclipse Java code
templates</span>
+
+## JavaScript
+
+<span class="label label-important">Describe how to import Eclipse JavaScript
code templates</span>
Modified: 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=1357930&r1=1357929&r2=1357930&view=diff
==============================================================================
--- shindig/site/trunk/cms/trunk/content/community_overview.mdtext (original)
+++ shindig/site/trunk/cms/trunk/content/community_overview.mdtext Thu Jul 5
21:17:25 2012
@@ -96,13 +96,13 @@ nothing else is frowned upon, as is aski
There are a number of conventions used in the project, which contributors and
developers alike should follow for
consistency's sake.
-* Code Style And Code Conventions
-* Jira Conventions
-* SVN Conventions
+* [Code Style And Code Conventions](code_conventions.html)
+* [JIRA Conventions](jira_conventions.html)
+* [SVN Conventions](svn_conventions.html)
## Developer Documentation
-* Apache Shindig Release Process
+* [Apache Shindig Release Process](releasing.html)
## Apache Resources
Added: shindig/site/trunk/cms/trunk/content/faq.mdtext
URL:
http://svn.apache.org/viewvc/shindig/site/trunk/cms/trunk/content/faq.mdtext?rev=1357930&view=auto
==============================================================================
--- shindig/site/trunk/cms/trunk/content/faq.mdtext (added)
+++ shindig/site/trunk/cms/trunk/content/faq.mdtext Thu Jul 5 21:17:25 2012
@@ -0,0 +1,19 @@
+Title: Frequently Asked Questions
+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.
+
+# Frequently Asked Questions
\ No newline at end of file
Added: shindig/site/trunk/cms/trunk/content/getting-help.mdtext
URL:
http://svn.apache.org/viewvc/shindig/site/trunk/cms/trunk/content/getting-help.mdtext?rev=1357930&view=auto
==============================================================================
--- shindig/site/trunk/cms/trunk/content/getting-help.mdtext (added)
+++ shindig/site/trunk/cms/trunk/content/getting-help.mdtext Thu Jul 5
21:17:25 2012
@@ -0,0 +1,48 @@
+Title: Getting Help
+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 Help
+
+So something didn't work as you expected it to? You think that Apache Shindig
is broken.
+What should you do?
+
+Here's a list of actions that you can take:
+
+## Search the mailing list archives
+
+Someone else might have experienced the same problem as you before. A list of
+mail-archives can be found on [mailing list index page](mail-lists.html).
Please
+search one of them before going any further.
+
+## Ask on the mailing list
+
+Our community is very helpful, just ask it the right way. See the references
section,
+at the end of this page, for info on how to do that. Subscribe to the
[list](mail-lists.html)
+and describe your problem there. Don't expect to get an answer right away.
Sometimes it
+takes a couple of days.
+
+## Submit an issue
+
+If it turns out that there is indeed something wrong with Apache Shindig, you
should report it
+to our issue management system [JIRA](issue-tracking.html).
+
+First of all you need to create an account in JIRA. This is so that we can
communicate with you
+while we work together on the issue. Go to the
+[sign up form](https://issues.apache.org/jira/secure/Signup!default.jspa) to
create an account
+if you don't already have one.
+
Added: shindig/site/trunk/cms/trunk/content/jira_conventions.mdtext
URL:
http://svn.apache.org/viewvc/shindig/site/trunk/cms/trunk/content/jira_conventions.mdtext?rev=1357930&view=auto
==============================================================================
--- shindig/site/trunk/cms/trunk/content/jira_conventions.mdtext (added)
+++ shindig/site/trunk/cms/trunk/content/jira_conventions.mdtext Thu Jul 5
21:17:25 2012
@@ -0,0 +1,73 @@
+Title: Apache Shindig JIRA Conventions
+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.
+
+# Apache Shindig JIRA Conventions
+
+This document describes how Apache Shindig developers should use JIRA, our
issue tracking.
+
+## When To Create a JIRA Issue?
+
+This section discusses when to create a JIRA issue versus just committing a
change in SVN.
+
+* Minor changes, like code reformatting, documentation fixes, etc. that
aren't going to
+impact other users can be committed without much issue.
+* Larger changes, like bug fixes, API changes, significant refactoring, new
classes, and
+pretty much any change of more than 100 lines, should have a JIRA ticket
associated with it,
+or at least an email discussion.
+
+## How To Use Issue Details?
+
+This section presents some conventions about the issue fields.
+
+### Priority
+
+Committers has the responsibility to realign priority by editing the issue.
+
+Reasoning: having a correct release note
+
+### Assignee
+
+Committers could assign an issue to a specific committer if he thinks it is
the right committer.
+
+### Component/s
+
+Committers has the responsibility to specify the correct the component by
editing the issue.
+
+Reasoning: having a correct release note.
+
+### Affects Version/s
+
+By default, the Maven team considers that an issue, which affects a given
version, affects
+also precedent versions, i.e. issue which affects Maven 2.0.9 will affect also
2.0,
+2.0.1 ... 2.0.9. If it is a regression, the committers should specify the
affected versions.
+
+Reasoning: having a correct release note.
+
+### Fix Version/s
+
+<span class="label label-important">TO BE DISCUSSED</span>
+
+### Time Tracking
+
+The Apache Shindig team never uses it. Committers could do it, but like said,
it will never be used.
+
+### Further Links
+
+* [JIRA Documentation](http://www.atlassian.com/software/jira/docs/latest/)
+* [What is an
Issue?](http://www.atlassian.com/software/jira/docs/latest/issues.html)
+* [What is a
project?](http://www.atlassian.com/software/jira/docs/latest/projects.html)
\ No newline at end of file
Added: shindig/site/trunk/cms/trunk/content/powered-by.mdtext
URL:
http://svn.apache.org/viewvc/shindig/site/trunk/cms/trunk/content/powered-by.mdtext?rev=1357930&view=auto
==============================================================================
--- shindig/site/trunk/cms/trunk/content/powered-by.mdtext (added)
+++ shindig/site/trunk/cms/trunk/content/powered-by.mdtext Thu Jul 5 21:17:25
2012
@@ -0,0 +1,19 @@
+Title: Powered By Apache Shindig
+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.
+
+# Powered by Apache Shindig
\ No newline at end of file
Added: shindig/site/trunk/cms/trunk/content/releasing.mdtext
URL:
http://svn.apache.org/viewvc/shindig/site/trunk/cms/trunk/content/releasing.mdtext?rev=1357930&view=auto
==============================================================================
--- shindig/site/trunk/cms/trunk/content/releasing.mdtext (added)
+++ shindig/site/trunk/cms/trunk/content/releasing.mdtext Thu Jul 5 21:17:25
2012
@@ -0,0 +1,183 @@
+Title: Releasing Apache Shindig
+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.
+
+# Apache Shindig Release Process
+
+This document describes how Apache Shindig's committers will make a release.
+
+* Apache Shindig Release Process
+ 1. Release Discussions
+ 2. Prepare The Release
+ 3. Stage The Release
+ 4. Deploy The Documentation
+ 5. Propose A Vote
+ 6. Publish The Release
+ 7. Publish The Website
+ 8. Announce The Release
+ 9. Celebrate :o)
+
+Notes:
+
+1. This process is based on the [Maven Release
Process](http://maven.apache.org/developers/release/releasing.html).
+Please read it firstly for the prerequisites and technical notes.
+2. The items 2 to 5 should take you 1-2 hours, depending your machine and
your Internet
+connection.
+3. 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.
+
+## 1. Release Discussions
+
+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 [Dev List](mail-lists.html).
+
+## 2. Prepare The Release
+
+Duration: 20 min
+
+Now that everybody in the community is happy to push a release, the release
manager needs to
+verify the source code before to continue:
+
+1. Make sure there are no snapshots (less the current version) in the POMs to
be released.
+2. Check that your POMs will not lose content when they are rewritten during
the release process.
+ * mvn release:prepare -DdryRun=true -Papache-release
+ * 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.
+ * Verify that all Apache Shindig modules will be touched, including
assembly and samples.
+
+Next, prepare the release by calling Maven:
+
+<pre>
+mvn release:clean -Papache-release
+mvn release:prepare -Papache-release
+</pre>
+
+Notes:
+
+1. -Papache-release is very important since assembly and samples modules are
not included
+by default in the build (for productivity reasons).
+2. Preparing the release will create a new tag in SVN, automatically checking
in on your
+behalf. Verify the SVN logs in the [Commit List](mail-lists.html) or review
the generated tag.
+3. All license headers and legal files will be checked by RAT (Release Audit
Tool).
+
+## 3. Stage The Release
+
+Duration: 30 min
+
+Call Maven to publish the generated artifacts:
+
+<pre>
+mvn release:perform -Papache-release
+</pre>
+
+Note: All artifacts will be signed and pushed to
+[https://repository.apache.org/](https://repository.apache.org/).
+
+Close the staging repository as described in the points 5 and 6 of the
+[Maven Release
Process](http://maven.apache.org/developers/release/releasing.html).
+
+## 4. Deploy The Documentation
+
+Duration: 20 min
+
+Call Maven to publish the generated technical site:
+
+<pre>
+cd target/checkout
+mvn site -Preporting
+mvn site:deploy
+</pre>
+
+Optional: Redeploy the current website:
+
+<span class="label label-important">Need to document how to update new
site.</span>
+
+## 5. Propose A Vote
+
+Start a release vote on the [Dev List](mail-lists.html). The vote must be
aligned with
+the [Apache](http://www.apache.org/foundation/voting.html) vote process.
+
+Typically, the mail should include the
+[Jira release
notes](http://www.atlassian.com/software/jira/docs/latest/releasenotes.html),
+the staging repository URL and the site URL, for instance:
+
+<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>
+
+## 6. Publish The Release
+
+Promote the release as described in the points 10 of the
+[Maven Release
Process](http://maven.apache.org/developers/release/releasing.html).
+
+Also, update Jira to specify the release date.
+
+## Publish The Website
+
+Update the [download
page](https://svn.apache.org/repos/asf/shindig/site/trunk/cms/trunk/content/download.mdtext)
+and redeploy the website (need to sync):
+
+<span class="label label-important">Need to document how to update new
site.</span>
+
+## 8. Announce The Release
+
+Create an announcement similar to:
+
+<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>
+
+## 9. Celebrate :o)
Added: shindig/site/trunk/cms/trunk/content/resources.mdtext
URL:
http://svn.apache.org/viewvc/shindig/site/trunk/cms/trunk/content/resources.mdtext?rev=1357930&view=auto
==============================================================================
--- shindig/site/trunk/cms/trunk/content/resources.mdtext (added)
+++ shindig/site/trunk/cms/trunk/content/resources.mdtext Thu Jul 5 21:17:25
2012
@@ -0,0 +1,40 @@
+Title: Apache Shindig Resources
+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.
+
+# Articles on Apache Shindig
+
+All articles on Apache Shindig are listed on our
+[Wiki](http://cwiki.apache.org/confluence/display/SHINDIG/Index#Index-ArticlesonShindig).
+
+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 [dev mailing list](mail-lists.html) to get in touch.
+
+# Resources
+
+The following list is some pointers on related OpenSocial resources.
+
+* [OpenSocial Foundation](http://opensocial.org/)
+* [OpenSocial Community Wiki](http://docs.opensocial.org)
+* [OpenSocial project](http://code.google.com/apis/opensocial)
+* [OpenSocial resources
project](http://code.google.com/p/opensocial-resources/)
+* [Gadget resources project](http://code.google.com/p/gadget-resources/)
+* [OpenSocial Templates](http://ostemplates-demo.appspot.com/)
+* [OpenSocial Dev App](http://osda.appspot.com/)
+* [OpenSocial Templates Developer App](http://ostemplates-devapp.appspot.com/)
+* <b>Add more, see [How to Contribute](community_overview.html) page</b>
\ No newline at end of file
Added: shindig/site/trunk/cms/trunk/content/svn_conventions.mdtext
URL:
http://svn.apache.org/viewvc/shindig/site/trunk/cms/trunk/content/svn_conventions.mdtext?rev=1357930&view=auto
==============================================================================
--- shindig/site/trunk/cms/trunk/content/svn_conventions.mdtext (added)
+++ shindig/site/trunk/cms/trunk/content/svn_conventions.mdtext Thu Jul 5
21:17:25 2012
@@ -0,0 +1,88 @@
+Title: Apache Shindig SVN Conventions
+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.
+
+# Apache Shindig SVN Conventions
+
+This document describes how developers should use SVN, our SCM.
+
+## Subversion Configuration
+
+Before committing files in subversion repository, you need to read the
+[Committer Subversion
Access](http://www.apache.org/dev/version-control.html#https-svn) document
+and you must set your svn client with this properties file: svn-props
+
+## Commit Message Template
+
+Based on [ASF committer's
FAQ](http://www.apache.org/dev/committers.html#applying-patches),
+the commits should have a message that follows this template:
+
+<pre>
+[issue1, issue2] <<comment>>
+Submitted by: (when it was a patch, put that persons name there)
+
+o some comments
+</pre>
+
+Where:
+
+* <b>issue</b> can be omitted if there was no relevant JIRA issue, though it
is strongly
+encouraged to create one for significant changes.
+* <b>Submitted by</b> only needs to be specified when a patch is being
applied for a non-committer.
+* <b>comments</b> some words about the commits.
+
+## Apply User Patch
+
+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.
+
+## Edit Commit Message
+
+If you want to edit a commit message, you could call:
+
+<pre>svn pe svn:log --revprop -r XXX</pre>
+
+where <b>XXX</b> is the wanted version
+
+## Other useful Subversion commands while developing
+
+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:
+
+<pre>$ svn revert -R</pre>
+
+The -R argument means that the command will recurse down all directories and
revert all changes.
+
+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:
+
+<pre>$ svn propset svn:ignore -F ~/bin/svnignore</pre>
+
+An example svnignore file:
+
+<pre>
+target
+*~
+*.log
+.classpath
+.project
+*.ipr
+*.iws
+*.iml
+</pre>
\ No newline at end of file
