New xindice site and documentation for 1.1 (Forrest)

[Kevin Ross <Ke...@iVerticalLeap.com>]

The initial port of the site documentation has been done and is commited 
to CVS.  This is buildable with the latest forrest shbat, you can give 
it a shot if you like. :)

WE NEED HELP.  The site docs are simply ported.  They are by no means 
accurate, but actually outdated.  Content not only needs to be 
reorganized for readability, but rewritten based on the 1.1 architecture.

Let me say this: Contributing documentation is not only VERY easy, but 
necessary.  IMHO, everyone actively using xindice (or any open source), 
has an obligation to contribute in some way.  Editing an xml document 
and adding your experiences is a simple way for you to help out the masses.

To author documentation:
1.  Get the latest forrest code
2.  Copy the contents of both directories:
    -%FORREST_HOME%\src\resources\schema\dtd
    -%FORREST_HOME%\src\resources\schema\entity
into a location where the documents can be validated by the dtds at: 
http://localhost/forrest/dtd/*

If you are using an editor such as XMLSpy, you will find it quite easy 
to write docs because of the code (tag) completion feature.  Make sure 
you validate your documents before contributing.

Thanks everyone.  By the way, shouldn't we think about publishing a 1.1 
site 'preview' as a link off of the current site?

--Kevin Ross

RE: New xindice site and documentation for 1.1 (Forrest)

[Dave Viner <dv...@yahoo-inc.com>]

Hi,
	I'm trying to prepare my dev environment to help with the documentation
effort.  (Or at least be able to help when I have free cycles.)  I've
downloaded forrest, compiled it, and built the new docs locally.  I now have
2 questions:
	1. location of dtd/* and entity/*.  You mention that I should make them
available at http://localhost/forrest/dtd/*  I use Apache 1.3.x.  So here's
a short file you can add to your configuration for apache 1.3.x to make
these requests work.  You could Include this file, or just append it to
httpd.conf or other configuration file for Apache.

	2. I noticed that there are several overlapping files.  For example,
there's
src/documentation/content/xdocs/guide-{administrator,developer,tools,user}.x
ml and then
src/documentation/content/xdocs/dev/guide-{administrator,commandline,develop
er,user}.xml.

Is that intentional?  Or which one is the definitive and future home of the
information?

thanks
dave




-----Original Message-----
From: Kevin Ross [mailto:Kevin.Ross@iVerticalLeap.com]
Sent: Friday, November 01, 2002 2:09 PM
To: xindice-dev@xml.apache.org
Subject: New xindice site and documentation for 1.1 (Forrest)


The initial port of the site documentation has been done and is commited
to CVS.  This is buildable with the latest forrest shbat, you can give
it a shot if you like. :)

WE NEED HELP.  The site docs are simply ported.  They are by no means
accurate, but actually outdated.  Content not only needs to be
reorganized for readability, but rewritten based on the 1.1 architecture.

Let me say this: Contributing documentation is not only VERY easy, but
necessary.  IMHO, everyone actively using xindice (or any open source),
has an obligation to contribute in some way.  Editing an xml document
and adding your experiences is a simple way for you to help out the masses.

To author documentation:
1.  Get the latest forrest code
2.  Copy the contents of both directories:
    -%FORREST_HOME%\src\resources\schema\dtd
    -%FORREST_HOME%\src\resources\schema\entity
into a location where the documents can be validated by the dtds at:
http://localhost/forrest/dtd/*

If you are using an editor such as XMLSpy, you will find it quite easy
to write docs because of the code (tag) completion feature.  Make sure
you validate your documents before contributing.

Thanks everyone.  By the way, shouldn't we think about publishing a 1.1
site 'preview' as a link off of the current site?

--Kevin Ross