You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@accumulo.apache.org by el...@apache.org on 2013/10/25 21:36:14 UTC

svn commit: r1535833 - in /accumulo/site/trunk: content/contrib.mdtext content/source.mdtext templates/sidenav.mdtext

Author: elserj
Date: Fri Oct 25 19:36:14 2013
New Revision: 1535833

URL: http://svn.apache.org/r1535833
Log:
ACCUMULO-1799 Applying patch to website to list Accumulo contrib repos to the public

Added:
    accumulo/site/trunk/content/contrib.mdtext
Modified:
    accumulo/site/trunk/content/source.mdtext
    accumulo/site/trunk/templates/sidenav.mdtext

Added: accumulo/site/trunk/content/contrib.mdtext
URL: http://svn.apache.org/viewvc/accumulo/site/trunk/content/contrib.mdtext?rev=1535833&view=auto
==============================================================================
--- accumulo/site/trunk/content/contrib.mdtext (added)
+++ accumulo/site/trunk/content/contrib.mdtext Fri Oct 25 19:36:14 2013
@@ -0,0 +1,53 @@
+Title: Apache Accumulo Contrib Projects
+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.
+# Contrib Scope
+Apache Accumulo is a complex distributed system. In order to minimize that complexity for both operators and developers the project maintains contrib repositories for instructive applications and code that builds interoperability between Accumulo and other systems. This helps minimize the set of dependencies needed when building or installing Accumulo, keeps the build time down, and allows the contrib projects to follow their own release schedule.
+
+# Existing Contrib Projects
+Each of the below contrib project handles their own development and release cycle. For information on what version(s) of Accumulo they work with, see the documentation for the individual project.
+
+## Instamo Archetype 
+A Maven Archetype that automates the customization of Instamo to quickly spin up an Accumulo process in memory.
+
+The Apache Accumulo Instamo Archetype uses [Git](http://git-scm.com/) version control ([browse](https://git-wip-us.apache.org/repos/asf?p=accumulo-instamo-archetype.git;a=summary)|[checkout](http://git-wip-us.apache.org/repos/asf/accumulo-instamo-archetype.git)). It builds with [Apache Maven][maven]. See the [section on contributing](#contributing-to-contrib) for instructions on submitting issues and patches.
+
+## Wikisearch Application
+A complex application example that makes use of most of the Accumulo feature stack. The Wikisearch application provides an example of indexing and querying Wikipedia data within Accumulo. It is a great place to start if you want to get familiar with good development practices building on Accumulo. 
+
+For details on setting up the application, see the project's README. You can also read [an overview and some performance numbers](example/wikisearch.html).
+
+The Apache Accumulo Wikisearch Example uses [Git](http://git-scm.com/) version control ([browse](https://git-wip-us.apache.org/repos/asf?p=accumulo-wikisearch.git;a=summary)|[checkout](http://git-wip-us.apache.org/repos/asf/accumulo-wikisearch.git)). It builds with [Apache Mave][maven]. See the [section on contributing](#contributing-to-contrib) for instructions on submitting issues and patches.
+
+## Pig Support
+A storage module for [Pig](http://pig.apache.org/) allows users to use an Accumulo as either a source or a sink when writing analytics in the Pig scripting language. For details on which Pig version(s) are required to run the storage module, see the project details.
+
+The Apache Accumulo Pig Module uses [Git](http://git-scm.com/) version control ([browse](https://git-wip-us.apache.org/repos/asf?p=accumulo-pig.git;a=summary)|[checkout](http://git-wip-us.apache.org/repos/asf/accumulo-pig.git)). It builds with [Apache Maven][maven]. See the [section on contributing](#contributing-to-contrib) for instructions on submitting issues and patches.
+
+## Hama Integration
+An implementation for running [Bulk Synchronous Parallel (BSP) algorithms](http://hama.apache.org/hama_bsp_tutorial.html) implemented via [Apache Hama](http://hama.apache.org/) on top of data stored in Accumulo.
+
+The Apache Accumulo BSP implementation uses [Git](http://git-scm.com/) version control ([browse](https://git-wip-us.apache.org/repos/asf?p=accumulo-bsp.git;a=summary)|[checkout](http://git-wip-us.apache.org/repos/asf/accumulo-bsp.git)). It builds with [Apache Mave][maven]. See the [section on contributing](#contributing-to-contrib) for instructions on submitting issues and patches.
+
+# Contributing to Contrib
+All contributions to the various Apache Accumulo contrib projects should follow the [same process used in the primary project](git.html#the-implementation). All contributions should have a corresponding issue filed in the [contrib component in the Accumulo issue tracker](https://issues.apache.org/jira/browse/ACCUMULO/component/12316610).
+
+# Adding a new Contrib Project
+Proposals for new contrib projects should be sent to the [Accumulo mailing list](mailing_list.html) for [developers](mailto:dev@accumulo.apache.org?subject=[Accumulo Contrib Proposal]). 
+
+If an example application only makes use of a single Accumulo feature, it is probably better off as an Accumulo version-specific example. You can see several of these demonstrative applications in the [simple example codebase](https://git-wip-us.apache.org/repos/asf?p=accumulo.git;a=tree;f=examples/simple;) and the related published documentation for versions [1.4](1.4/examples/) and [1.5](1.5/examples/).
+

Modified: accumulo/site/trunk/content/source.mdtext
URL: http://svn.apache.org/viewvc/accumulo/site/trunk/content/source.mdtext?rev=1535833&r1=1535832&r2=1535833&view=diff
==============================================================================
--- accumulo/site/trunk/content/source.mdtext (original)
+++ accumulo/site/trunk/content/source.mdtext Fri Oct 25 19:36:14 2013
@@ -27,6 +27,15 @@ Accumulo's web site is maintained with [
 Committers may edit the site by following [these instructions][cmsusage].  Non-committers should follow
 [this FAQ entry][cmsanon].
 
+## Contribs
+
+Accumulo has a number of [contrib projects](contrib.html) that maintain their own code repositories and release schedules. All build with [Apache Maven][maven].
+
+* Instamo Archetype ([browse](https://git-wip-us.apache.org/repos/asf?p=accumulo-instamo-archetype.git;a=summary)|[checkout](http://git-wip-us.apache.org/repos/asf/accumulo-instamo-archetype.git))
+* Wikisearch Application ([browse](https://git-wip-us.apache.org/repos/asf?p=accumulo-wikisearch.git;a=summary)|[checkout](http://git-wip-us.apache.org/repos/asf/accumulo-wikisearch.git))
+* Apache Pig Support ([browse](https://git-wip-us.apache.org/repos/asf?p=accumulo-pig.git;a=summary)|[checkout](http://git-wip-us.apache.org/repos/asf/accumulo-pig.git))
+* BSP via Apache Hama ([browse](https://git-wip-us.apache.org/repos/asf?p=accumulo-bsp.git;a=summary)|[checkout](http://git-wip-us.apache.org/repos/asf/accumulo-bsp.git))
+
 ## Developer's Guide
 
 ### Building code

Modified: accumulo/site/trunk/templates/sidenav.mdtext
URL: http://svn.apache.org/viewvc/accumulo/site/trunk/templates/sidenav.mdtext?rev=1535833&r1=1535832&r2=1535833&view=diff
==============================================================================
--- accumulo/site/trunk/templates/sidenav.mdtext (original)
+++ accumulo/site/trunk/templates/sidenav.mdtext Fri Oct 25 19:36:14 2013
@@ -12,6 +12,7 @@
 # Development
  - [Source & Guide](/source.html)
  - [Git WIP](/git.html)
+ - [Contrib Projects](/contrib.html)
  - [Issues](https://issues.apache.org/jira/browse/accumulo)
  - [Builds](https://builds.apache.org/view/A-D/view/Accumulo/)