Ben and Mark,
Mark is correct about the xdocs and jakarta-site2.
Jakarta-site2 contains the template and macros used to generate a
consistent "Look and feel" for all Jakarta projects. The documentation
source file MUST be well formed XML, thus you should use <BR/> instead
of <BR>. The macros will generate the correct HTML tags.
To build docs:
1) Do a "cvs checkout" of jakarta-site2. Make sure the checked out
modules jakarta-jetspeed and jakarta-site2 are in the same directory
(CVS_ROOT), i.e.:
e:\cvs_root
jakarta-jetspeed
jakarta-site2
2) From Jetspeed's build directory, use the command "ant docs" to build
the docs. "build docs" does not work due to an incompatibility in
velocity jar files used by Jetspeed and Jakarta-site2.
To submit documentation patches, post a patch to the developer mailing
list with the subject beginning with [PATCH]. Use the command "cvs diff
-c filename.xml >patch.txt" to generate a patch file, named patch.txt.
Do not send patches to the html files, since they are generated.
Please maintain the same "Look and feel" of the existing Jetspeed
documentation. I use the Portlet Catalog documentation as a guide to the
"Look and Feel".
Feel free to post messages about the documentation section you are
working on. This will serve a couple of purposes:
1) Tell other people what you are working on, thus avoiding
conflicts.
2) Invite comments and suggestions on what to include in
the document.
As you, and many others, have pointed out, the documentation need work.
I have written some of the documentation, and understand some of the
challenges.
Thank you and I look forward to seeing the results!
Paul Spencer
Nutter, Mark wrote:
> I'm about where you are, or maybe one half-step ahead, if you haven't read
> the Jakarta Site2 stuff yet :)
>
> http://jakarta.apache.org/site/jakarta-site2.html
>
> That's where the info is about the xdocs used to build the current site
> docs, so if you want to fill in some of the sections marked "Somebody needs
> to write this section", that's where to start.
>
> Mark
>
>
>>-----Original Message-----
>>From: Benjamin Madsen [mailto:[EMAIL PROTECTED]]
>>Sent: Thursday, February 07, 2002 5:53 PM
>>To: [EMAIL PROTECTED]
>>Subject: How Do I Help
>>
>>
>>Just a quick question to someone in the know...
>>
>>It has been expressed that there is a significant lack of
>>documentation. Where would we go to start helping on this
>>task? I seem to
>>have a need to run Jetspeed, but I haven't bothered to muddle
>>through the
>>installation process. Since I'm fairly good at figuring
>>things out, I
>>figured I may as well document the process and start the
>>documentation part
>>of the project. Any ideas, or should I just start my own
>>tutorial website?
>>
>>Thanks in advance,
>>Ben
>>
>>
>>
>>_________________________________________________________
>>
>>Do You Yahoo!?
>>
>>Get your free @yahoo.com address at http://mail.yahoo.com
>>
>>
>>
>>
>>--
>>To unsubscribe, e-mail:
>><mailto:[EMAIL PROTECTED]>
>>For additional commands, e-mail:
>><mailto:[EMAIL PROTECTED]>
>>
>>
>
>
> This e-mail and any attachments are confidential. If you are not the
> intended recipient, please notify us immediately by reply e-mail and then
> delete this message from your system. Do not copy this e-mail or any
> attachment, use the contents for any purposes, or disclose the contents to
> any other person: to do so could be a breach of confidence.
>
> --
> To unsubscribe, e-mail: <mailto:[EMAIL PROTECTED]>
> For additional commands, e-mail: <mailto:[EMAIL PROTECTED]>
>
>
--
To unsubscribe, e-mail: <mailto:[EMAIL PROTECTED]>
For additional commands, e-mail: <mailto:[EMAIL PROTECTED]>
