From 4acdbda5c8e5135157955fb2209459f6a5c5cff2 Mon Sep 17 00:00:00 2001 From: Nick Burch Date: Tue, 29 May 2007 17:18:45 +0000 Subject: [PATCH] Further updates to the site git-svn-id: https://svn.apache.org/repos/asf/jakarta/poi/trunk@542593 13f79535-47bb-0310-9956-ffa450edef68 --- src/documentation/content/xdocs/book.xml | 2 +- .../content/xdocs/getinvolved/book.xml | 5 +- .../content/xdocs/getinvolved/branching.xml | 2 +- .../content/xdocs/getinvolved/index.xml | 10 +- src/documentation/content/xdocs/index.xml | 4 +- .../content/xdocs/mailinglists.xml | 97 +++++++++++++++++++ src/documentation/content/xdocs/mirrors.xml | 4 +- .../content/xdocs/subversion.xml | 86 ++++++++++++++++ 8 files changed, 197 insertions(+), 13 deletions(-) create mode 100644 src/documentation/content/xdocs/mailinglists.xml create mode 100644 src/documentation/content/xdocs/subversion.xml diff --git a/src/documentation/content/xdocs/book.xml b/src/documentation/content/xdocs/book.xml index e9c00f16d2..4666d7765a 100644 --- a/src/documentation/content/xdocs/book.xml +++ b/src/documentation/content/xdocs/book.xml @@ -75,7 +75,7 @@ - + diff --git a/src/documentation/content/xdocs/getinvolved/book.xml b/src/documentation/content/xdocs/getinvolved/book.xml index 9e9f13771a..d139954975 100644 --- a/src/documentation/content/xdocs/getinvolved/book.xml +++ b/src/documentation/content/xdocs/getinvolved/book.xml @@ -24,14 +24,15 @@ copyright="@year@ POI Project" xmlns:xlink="http://www.w3.org/1999/xlink"> - + - + + diff --git a/src/documentation/content/xdocs/getinvolved/branching.xml b/src/documentation/content/xdocs/getinvolved/branching.xml index 4957505652..166575be4e 100644 --- a/src/documentation/content/xdocs/getinvolved/branching.xml +++ b/src/documentation/content/xdocs/getinvolved/branching.xml @@ -24,7 +24,7 @@
Branching - +
diff --git a/src/documentation/content/xdocs/getinvolved/index.xml b/src/documentation/content/xdocs/getinvolved/index.xml index 9f55aa6db9..0ee102beef 100644 --- a/src/documentation/content/xdocs/getinvolved/index.xml +++ b/src/documentation/content/xdocs/getinvolved/index.xml @@ -82,27 +82,27 @@ the project vision, etc.
  • Use POI a bit, look for gaps in the documentation and examples.
  • Join the mail lists and share your knowledge with others.
    • -
  • Get Subversion and check out the POI source tree
    • +
  • Get Subversion and check out the POI source tree
  • Documentation is always the best place to start contributing, maybe you found that if the documentation just told you how to do X then it would make more sense, modify the documentation.
  • Get used to building POI, you'll be doing it a lot, be one with the build, know its targets, etc.
  • Write Unit Tests. Great way to understand POI. Look for classes that aren't tested, or aren't tested on a public/protected method level, start there.
  • (HSSF)Get the Excel 97 Developer's Kit - its out of print but its dirt cheap (seen copies for under $15 (US)) used on amazon. It explains the Excel file format.
  • Submit patches (see below) of your contributions, modifications.
    • -
  • Fill out new features, see Bug database for suggestions.
    • +
  • Fill out new features, see Bug database for suggestions.
    • Submitting Patches

    Create patches by getting the latest sources from Subversion. - Alter or add files as appropriate. Then, from the jakarta-poi directiory, + Alter or add files as appropriate. Then, from the poi directiory, type svn diff > mypatch.patch. This will capture all of your changes in a patch file of the appropriate format. Next, if you've added any files, create an archive (tar.bz2 preferred as its the smallest) in a - path-preserving archive format, relative to your jakarta-poi directory. + path-preserving archive format, relative to your poi directory. You'll attach both files in the next step.

    - Patches are submitted via the Bug Database. + Patches are submitted via the Bug Database. Create a new bug, set the subject to [PATCH] followed by a brief description. Explain you patch and any special instructions and submit/save it. Next, go back to the bug, and create attachements for the patch files you created. Be sure to describe not only the files purpose, but its format. diff --git a/src/documentation/content/xdocs/index.xml b/src/documentation/content/xdocs/index.xml index e478df0bda..da2d5ed3a8 100644 --- a/src/documentation/content/xdocs/index.xml +++ b/src/documentation/content/xdocs/index.xml @@ -35,9 +35,9 @@

    After quite a wait, version 3.0 of Apache POI (formerly Apache Jakarta POI) has now been released. You can view the changelog, and - download + download the source and binaries from your - local mirror.

    + local mirror.

    Purpose diff --git a/src/documentation/content/xdocs/mailinglists.xml b/src/documentation/content/xdocs/mailinglists.xml new file mode 100644 index 0000000000..6f2b68c98d --- /dev/null +++ b/src/documentation/content/xdocs/mailinglists.xml @@ -0,0 +1,97 @@ + + + + + +
    + Mailing Lists + + + +
    + + +
    Mailing Lists - Guidelines +

    + Before subscribing to any of the mailing lists, please make + sure that you have read and understand the following + guidelines: +

    +
      +
    • ASF guide to Mailing Lists
      • +
    • ASF Tips for email contributors
      • +
    • The Jakarta guide to Mailing Lists
      • +
    +
    +
    Lists +
    The POI User List +

    + Medium Traffic + Subscribe + Unsubscribe + Archive + gmane.org +

    +

    + This list is for users of POI to ask questions, share knowledge, + and discuss issues. POI developers are also expected to be + lurking on this list to offer support to users of POI. +

    +
    +
    The POI Developer List +

    + Low Traffic + Subscribe + Unsubscribe + Archive + gmane.org +

    +

    + This is the list where participating developers of the POI + project meet and discuss issues, code changes/additions, etc. + Subscribers to this list also get notices of each and every + code change, build results, testing notices, etc. + Do not send mail to this list with usage questions or + configuration problems. +

    +
    +
    The POI General List +

    + Low Traffic + Subscribe + Unsubscribe + Archive +

    +

    + This list exists for general discussions on POI, not specific to + code or problems with code. Used for discussion of general matters + relating to all of the POI project, such as the website and + changes in procedures. +

    +
    +
    + +
    + + Copyright 2007 The Apache Software Foundation or its licensors, as applicable. + $Revision: 496536 $ $Date: 2007-01-15 23:11:09 +0000 (Mon, 15 Jan 2007) $ + +
    +     diff --git a/src/documentation/content/xdocs/mirrors.xml b/src/documentation/content/xdocs/mirrors.xml index f21ef4ee00..e133fa4339 100644 --- a/src/documentation/content/xdocs/mirrors.xml +++ b/src/documentation/content/xdocs/mirrors.xml @@ -21,7 +21,7 @@
    - Jakarta POI Mirror Site + Apache POI Mirror Site @@ -31,7 +31,7 @@
    Mirrors

    These are mirrors of the - POI website. + POI website. If you know of others...report them! :-)

    diff --git a/src/documentation/content/xdocs/subversion.xml b/src/documentation/content/xdocs/subversion.xml new file mode 100644 index 0000000000..2e8b1b1d82 --- /dev/null +++ b/src/documentation/content/xdocs/subversion.xml @@ -0,0 +1,86 @@ + + + + + +
    + Subversion - Source Code Repository + + + +
    + + +
    Download the Source +

    + Most users of the source code probably don't need to have day to + day access to the source code as it changes. For these users we + provide easy to unpack source code downloads via our + download pages. +

    +
    +
    Access the Version Controlled Source Code +

    + For information on connecting to the ASF Subversion repositories, + see the + version control page. +

    + +

    Subversion is an open-source version control system. The root url + of the ASF Subversion repository is + http://svn.apache.org/repos/asf/ + for non-committers and + https://svn.apache.org/repos/asf/ + for committers. +

    + +

    NOTE: When checking out a subproject using + subversion, ensure that you are checking out a tag, a branch or trunk + (the main-line) and not all tags and branches, to avoid filling up + your hard-disk and wasting bandwidth. +

    + +

    NOTE: See this + Subversion + information page for a brief description of the relationship be + tween URL tuples such as trunks-proper and proper.

    + +
      +
    • For read only access to the Apache POI svn, please use + http://svn.apache.org/repos/asf/poi/trunk/
      • +
    • For committers (write) access to the Apache POI svn, please use + https://svn.apache.org/repos/asf/poi/trunk/
      • +
    • To browse the svn repository in your web browser, please us + ViewSVN
      • +
    + +

    If you are not a Committer, but you want to submit patches + or even request commit privileges, please see our + Guidelines for more + information.

    +
    + + +