svn commit: r1604189 - in /tika/site/src/site: apt/contribute.apt site.xml

[ni...@apache.org]

Author: nick
Date: Fri Jun 20 15:24:07 2014
New Revision: 1604189

URL: http://svn.apache.org/r1604189
Log:
Start on a "Contributing to Apache Tika" page, still needs a few more bits

Added:
    tika/site/src/site/apt/contribute.apt
Modified:
    tika/site/src/site/site.xml

Added: tika/site/src/site/apt/contribute.apt
URL: http://svn.apache.org/viewvc/tika/site/src/site/apt/contribute.apt?rev=1604189&view=auto
==============================================================================
--- tika/site/src/site/apt/contribute.apt (added)
+++ tika/site/src/site/apt/contribute.apt Fri Jun 20 15:24:07 2014
@@ -0,0 +1,87 @@
+                       ----------
+                       Contribute
+                       ----------
+
+~~ 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.
+
+Contribute to Apache Tika
+
+   TODO Something general about contributing
+
+Source Code
+
+   To download the source code for the latest release of Apache Tika, please
+   see the {{{./download.html}Download page}}.
+
+   The master copy of the Apache Tika source code is held in SVN. You can
+   checkout the code from 
+   {{{https://svn.apache.org/repos/asf/tika/trunk}https://svn.apache.org/repos/asf/tika/trunk}}
+   and you can browse it online through
+   {{{http://svn.apache.org/viewvc/tika/trunk/}Viewvc}}
+
+   For those who prefer working with Git, a read only mirror is available
+   from {{{http://git.apache.org/}git.apache.org}}. We also maintain a 
+   {{{https://github.com/apache/tika/}GitHub mirror}}, which you are welcome
+   to fork from and open pull requests to.
+
+Reporting Issues
+
+   TODO Something about using 
+   {{{https://issues.apache.org/jira/browse/TIKA}JIRA}} to report issues
+
+New Parsers, Detectors and Mime Types
+
+   TODO Link to the resources in {{{./parser_guide.apt}Parser Quick Start
+   Guide}} on adding new mime types and new parsers
+
+Submitting Enhancements and Fixes
+
+   All enhancements and fixes should have a 
+   {{{https://issues.apache.org/jira/browse/TIKA}JIRA Issue or Enhancement}}
+   opened for them. This should describe the problem and the proposed fix
+   / new code. The JIRA can be used for discussions on the code, and provides
+   a single identifier for the change.
+
+   SVN - For users of SVN, you can use <<<svn diff>>> to generate a patch
+   file of your changes, which can then be attached to the issue. Note that
+   a SVN diff won't normally include new or binary files, so these will need
+   to be attached as well.
+
+   Git - Git users are advised to produce a single patch file for their
+   change, and attach this resulting file to the issue.
+
+   Github Pulls - If you are working from our 
+   {{{https://github.com/apache/tika/}GitHub mirror}}, it is possible to
+   open a pull request for your change. Please include the JIRA Issue number
+   in the pull request, so it can be linked by the ASF GitHub bot. 
+
+   ReviewBoard - If you have a Work-In-Progress patch for which you would 
+   like feedback / review / assistance, you can use the 
+   {{{https://reviews.apache.org/dashboard/}Apache ReviewBoard Instance}} to
+   post your code. Please reference the JIRA Issue number from the review 
+   request, and add a link to it to the JIRA Issue.
+
+   Unit tests, License Headers - Wherever possible, we like new functionality
+   and fixes to include small-ish unit tests. Whenever you make changes,
+   please re-run the unit test suite (<<<mvn install>>> is one way to trigger
+   this), and ensure your changes don't break anything. If adding new files,
+   please include the Apache License v2 license header at the top of the
+   file.
+
+Other Resources
+
+   TODO Link to thinks like {{{http://community.apache.org/}ComDev}}, the
+   Nutch contribution wiki etc

Modified: tika/site/src/site/site.xml
URL: http://svn.apache.org/viewvc/tika/site/src/site/site.xml?rev=1604189&r1=1604188&r2=1604189&view=diff
==============================================================================
--- tika/site/src/site/site.xml (original)
+++ tika/site/src/site/site.xml Fri Jun 20 15:24:07 2014
@@ -34,6 +34,7 @@
     <menu name="Apache Tika">
       <item name="Introduction" href="index.html"/>
       <item name="Download" href="download.html"/>
+      <item name="Contribute" href="contribute.html"/>
       <item name="Mailing Lists" href="mail-lists.html"/>
       <item name="Tika Wiki" href="http://wiki.apache.org/tika/"/>
       <item name="Issue Tracker" href="https://issues.apache.org/jira/browse/TIKA"/>