From da6c43f5d7973e1c9a76391d2a09c8c8dfb5eb97 Mon Sep 17 00:00:00 2001 From: Michael Busch Date: Fri, 11 Jan 2008 07:50:59 +0000 Subject: [PATCH] Separate project's web site from version-specific documentation. git-svn-id: https://svn.apache.org/repos/asf/lucene/java/trunk@611094 13f79535-47bb-0310-9956-ffa450edef68 --- .../src/documentation/content/xdocs/demo4.xml | 4 +- .../content/xdocs/developer-resources.xml | 82 --------- .../documentation/content/xdocs/features.xml | 47 ----- .../src/documentation/content/xdocs/index.xml | 161 ++---------------- .../documentation/content/xdocs/javadocs.xml | 19 --- .../content/xdocs/mailinglists.xml | 56 ------ .../documentation/content/xdocs/releases.xml | 29 ---- .../documentation/content/xdocs/resources.xml | 21 --- .../src/documentation/content/xdocs/site.xml | 108 ++++++------ .../content/xdocs/systemrequirements.xml | 30 ---- .../src/documentation/content/xdocs/tabs.xml | 5 +- .../documentation/content/xdocs/whoweare.xml | 61 ------- 12 files changed, 71 insertions(+), 552 deletions(-) delete mode 100644 src/site/src/documentation/content/xdocs/developer-resources.xml delete mode 100644 src/site/src/documentation/content/xdocs/features.xml delete mode 100644 src/site/src/documentation/content/xdocs/javadocs.xml delete mode 100644 src/site/src/documentation/content/xdocs/mailinglists.xml delete mode 100644 src/site/src/documentation/content/xdocs/releases.xml delete mode 100644 src/site/src/documentation/content/xdocs/resources.xml delete mode 100644 src/site/src/documentation/content/xdocs/systemrequirements.xml delete mode 100644 src/site/src/documentation/content/xdocs/whoweare.xml diff --git a/src/site/src/documentation/content/xdocs/demo4.xml b/src/site/src/documentation/content/xdocs/demo4.xml index 6376421ad9c..5ed6389a4af 100644 --- a/src/site/src/documentation/content/xdocs/demo4.xml +++ b/src/site/src/documentation/content/xdocs/demo4.xml @@ -139,14 +139,14 @@ In time some of these things may be added to Lucene as features (if you've got a to hear it!), but for now: this is where you begin and the search engine/indexer ends. Lastly, one would assume you'd want to follow the above advice and customize the application to look a little more fancy than black on white with "Lucene Template" at the top. We'll see you on the Lucene -Users' or Developers' mailing lists! +Users' or Developers' mailing lists!

When to contact the Author

Please resist the urge to contact the authors of this document (without bribes of fame and fortune -attached). First contact the mailing lists, taking care to mailing lists, taking care to Ask Questions The Smart Way. Certainly you'll get the most help that way as well. That being said, feedback, and modifications to this document and samples are ever so greatly appreciated. They are just best sent to the lists diff --git a/src/site/src/documentation/content/xdocs/developer-resources.xml b/src/site/src/documentation/content/xdocs/developer-resources.xml deleted file mode 100644 index b684b00b559..00000000000 --- a/src/site/src/documentation/content/xdocs/developer-resources.xml +++ /dev/null @@ -1,82 +0,0 @@ - - -

Apache Lucene - Developer Resources
- -Grant Ingersoll - - -
Making a Contribution -

Lucene Java is always looking for contributions, especially in the areas of documentation. See the Wiki for details on contributing.

-
- -
Nightly Build Javadocs -

Unofficial Javadocs from the nightly build are available at: -

-

-
-
Downloads -

System Requirements are detailed here.

-
Clover Test Coverage Reports -

- Clover - test coverage results are available - here - for the nightly build. -

-
-
Hudson -

- Hudson is providing continuous integration capabilities to the Lucene - project. It is responsible for running nightly builds, code coverage reports as well as building the nightly version - of the website. -

-
-
- Nightly Build Download -

Nightly builds are based on the trunk version of the code checked into - SVN -

- Download via Hudson -
-
- Source Code -

The source files are now stored using Subversion (see http://subversion.tigris.org/ and http://svnbook.red-bean.com/) -

-

- svn checkout http://svn.apache.org/repos/asf/lucene/java/trunk lucene/java/trunk -

- -
- -
- - - - diff --git a/src/site/src/documentation/content/xdocs/features.xml b/src/site/src/documentation/content/xdocs/features.xml deleted file mode 100644 index dc49be6a300..00000000000 --- a/src/site/src/documentation/content/xdocs/features.xml +++ /dev/null @@ -1,47 +0,0 @@ - - -
-Apache Lucene - Features -
- - -
Features -

Lucene offers powerful features through a simple API:

-
- -
Scalable, High-Performance Indexing -
    -
  • over 20MB/minute on Pentium M 1.5GHz
    • -
  • small RAM requirements -- only 1MB heap
    • -
  • incremental indexing as fast as batch indexing
    • -
  • index size roughly 20-30% the size of text indexed
    • -
-
- - - -
Cross-Platform Solution - -
- - - - diff --git a/src/site/src/documentation/content/xdocs/index.xml b/src/site/src/documentation/content/xdocs/index.xml index 9cfc1a0af2a..191d2bce882 100644 --- a/src/site/src/documentation/content/xdocs/index.xml +++ b/src/site/src/documentation/content/xdocs/index.xml @@ -1,151 +1,16 @@ -
- - Apache Lucene - Overview - -
- -
- Apache Lucene -

- Apache Lucene is a high-performance, full-featured text search engine - library written entirely in Java. It is a technology suitable for nearly any - application that requires full-text search, especially cross-platform. -

-

- Apache Lucene is an open source project available for - free download. - Please use the links on the left to access Lucene. -

-
- -
- Lucene News - - - -
- 24 December 2007 - Nightly Snapshots available in the Apache Maven Snapshot Repository -

- We are now publishing nightly artifacts to the Maven Snapshot Repository. The current version is '2.3-SNAPSHOT'. -

-

- The artifacts include: -

    -
  • Binary jars
    • -
  • Sources
    • -
  • Javadocs
    • -
- You can find separate artifacts for the core, demo, and the different contrib modules. -

-

- Merry Christmas! -

-
-
- 26 August 2007 - Lucene at ApacheCon Atlanta -

ApacheCon US logo - Lucene will once again be well represented at ApacheCon USA in Atlanta this November 12-16, 2007. -

-

The following talks and trainings are scheduled for this year's conference: -

-

-
-
- 19 June 2007 - Release 2.2 available - -

This release has many improvements since release 2.1. New major features: -

- In addition Lucene 2.2 has many performance - improvements, bug fixes, etc. See - CHANGES.txt - for details. -

- -

Lucene 2.2 includes index format changes that are not readable - by older versions of Lucene. Lucene 2.2 can both read and update - older Lucene indexes. Adding to an index with an older format - will cause it to be converted to the newer format. -

- -

Binary and source distributions are - available - here. -

-
-
- 18 February 2007 - Lucene at ApacheCon Europe -

- ApacheCon Europe logo - Lucene Java and related Lucene projects will have extensive representation at ApacheCon Europe in Amsterdam this year. For the 2007 session, - Yonik Seeley will be giving the Full-Text Search with Lucene talk at 10:30 am on May 2nd. Immediately following, Grant Ingersoll - will be presenting Advanced Lucene at 11:30. Grant will also be leading a full day tutorial session on May 1st titled - Lucene Boot Camp. -

-

Lucene related talks include Solr committer Bertrand Delacrétaz's talk titled Beyond full-text searches with Solr and Lucene and - Hadoop committer Owen O'Malley's Introduction to Hadoop. -

-

Registration is now open on the ApacheCon website.

-
-
- 17 February 2007 - Release 2.1 available - -

This release has many improvements since release - 2.0, including new features, performance - improvements, bug fixes, etc. See - CHANGES.txt - for details. -

- -

Lucene 2.1 includes index format changes that are not readable - by older versions of Lucene. Lucene 2.1 can both read and update - older Lucene indexes. Adding to an index with an older format - will cause it to be converted to the newer format. -

- -

Binary and source distributions are - available - here. -

-
- -
- 3 January 2007 - Nightly Source builds available - -

Nightly source builds of the current development version of Lucene - are now available at - http://people.apache.org/builds/lucene/java/nightly/. Files are named lucene-DATE-src.tar.gz where DATE is the date of the build. -

-
- - -
- - +
+ Lucene Java Documentation +
+ + +

+ This is the official documentation for Lucene Java 2.4-dev
+ Please use the menu on the left to access the Javadocs and different documents. +

+

+ Additional documentation is available in the Wiki. +

+ diff --git a/src/site/src/documentation/content/xdocs/javadocs.xml b/src/site/src/documentation/content/xdocs/javadocs.xml deleted file mode 100644 index 7a7433fcd28..00000000000 --- a/src/site/src/documentation/content/xdocs/javadocs.xml +++ /dev/null @@ -1,19 +0,0 @@ - - -
Apache Lucene - Javadocs
- -Grant Ingersoll - - - -
Javadocs for Official Releases -

-

-

-

Javadocs from older (pre 2.x) Lucene releases can be found under the Site Versions - section on the left-hand menu

-
- - diff --git a/src/site/src/documentation/content/xdocs/mailinglists.xml b/src/site/src/documentation/content/xdocs/mailinglists.xml deleted file mode 100644 index aec468ab8b4..00000000000 --- a/src/site/src/documentation/content/xdocs/mailinglists.xml +++ /dev/null @@ -1,56 +0,0 @@ - - -
- - Apache Lucene - Mailing Lists - -
- -
Java User List -

- This list is for users of Java Lucene to ask questions, share knowledge, - and discuss issues. Do send mail to this list with usage and configuration questions and problems. Also, please - send questions to this list to verify your problem before filing issues in JIRA. -

- -
-
Java Developer List -

- This is the list where participating developers of the Java Lucene project meet - and discuss issues concerning Lucene internals, code changes/additions, etc. Do not send mail to this list - with usage questions or configuration questions and problems. -

-

- Discussion list: -


- Commit notifications: - -

-
-
Mail Archives -

The Lucene Wiki maintains a list of searchable mailing list archives at http://wiki.apache.org/lucene-java/MailingListArchives. - No endorsement is implied by the listing of an archive on the Wiki.

-
-
Other Mailing Lists -

Each Lucene project maintains its own mailing lists. Please refer to the project you are interested in for details - on subscribing to its mailing list. For the Lucene TLP General mailing list, go here. -

-
- - - diff --git a/src/site/src/documentation/content/xdocs/releases.xml b/src/site/src/documentation/content/xdocs/releases.xml deleted file mode 100644 index e5b6537a794..00000000000 --- a/src/site/src/documentation/content/xdocs/releases.xml +++ /dev/null @@ -1,29 +0,0 @@ - - -
Apache Lucene - Downloads and Releases
- -Grant Ingersoll - - - -
Downloads and Releases -

Information on Lucene Java Downloads and Releases.

-
Official Release -

Official releases are usually created when the developers feel there are - sufficient changes, improvements and bug fixes to warrant a release. - Due to the voluntary nature of Lucene, no releases are scheduled in advance. System Requirements are detailed - here.

-

Both binary and source releases are available for - download from the Apache Mirrors

-

The lucene-VERSION.zip (where VERSION is the version number of the release, i.e. 2.0.0) file contains the - lucene-core jar file, html documentation, a demo application (see Getting Started) - and various jar files containing contributed code. -
- If all you need is the core jar file you can download that separately. -

-
-
- - - - diff --git a/src/site/src/documentation/content/xdocs/resources.xml b/src/site/src/documentation/content/xdocs/resources.xml deleted file mode 100644 index a9a3fd9c339..00000000000 --- a/src/site/src/documentation/content/xdocs/resources.xml +++ /dev/null @@ -1,21 +0,0 @@ - - -
- - Apache Lucene - Resources - -
- - Doug Cutting - Resources - Apache Lucene - - - -
Page moved - - This page is now part of the Wiki - -
- - - diff --git a/src/site/src/documentation/content/xdocs/site.xml b/src/site/src/documentation/content/xdocs/site.xml index 4704c5fb467..a64271afc01 100755 --- a/src/site/src/documentation/content/xdocs/site.xml +++ b/src/site/src/documentation/content/xdocs/site.xml @@ -30,7 +30,7 @@ This file contains an outline of the site's information content. It is used to: See http://forrest.apache.org/docs/linking.html for more info --> - + - - - - - - - - + + + + + + + + + + + + + + + + + + + + + + + + + @@ -58,42 +77,8 @@ See http://forrest.apache.org/docs/linking.html for more info - - - - - - + - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - + + + + + + + + + + + + + + + + + + + + + + - - - - - - @@ -129,14 +128,11 @@ See http://forrest.apache.org/docs/linking.html for more info - - - - + diff --git a/src/site/src/documentation/content/xdocs/systemrequirements.xml b/src/site/src/documentation/content/xdocs/systemrequirements.xml deleted file mode 100644 index c173aa719ca..00000000000 --- a/src/site/src/documentation/content/xdocs/systemrequirements.xml +++ /dev/null @@ -1,30 +0,0 @@ - - -
Apache Lucene - System Requirements
- -Grant Ingersoll - - - -
System Requirements -

- The latest Lucene release has the following minimum requirements: -

    -
  • Java 1.4.x or greater.
    • -
  • ANT 1.6.5 or greater.
    • -
  • JUnit 3.8.1 if you wish to run the unit tests.
    • -
  • CPU, Disk and Memory requirements are based on the many choices made in implementing Lucene (document size, number of documents, and number of hits retrieved to name a few.) - The benchmarks page has some information related to performance on particular platforms. - Also, the Contrib/benchmark module has code related to benchmarking a standard set of documents.
    • -
-

-

Contrib modules may have other requirements, refer to their documentation and build files for information.

- -
- - - - diff --git a/src/site/src/documentation/content/xdocs/tabs.xml b/src/site/src/documentation/content/xdocs/tabs.xml index 24e6f2d18ad..42bb95fa151 100755 --- a/src/site/src/documentation/content/xdocs/tabs.xml +++ b/src/site/src/documentation/content/xdocs/tabs.xml @@ -37,8 +37,11 @@ --> - + + + +