You are viewing a plain text version of this content. The canonical link for it is here.
Posted to java-dev@axis.apache.org by Glen Daniels <gl...@thoughtcraft.com> on 2004/12/17 17:43:28 UTC

Re: cvs commit: ws-axis/site/src/documentation/content/xdocs/java install.ihtml

Hi all!

Sorry to be so late replying to this thread, but here's my take.

There should NOT be two places for content that must manually be kept in 
sync.  That's just a recipe for disaster.

I think the solution to this is for the master copy of the content to 
live in the CVS tree in java/docs, and for the web site content to be 
built automatically from that.  I think it's fine if the website content 
reflects the last actual release (i.e. it shouldn't track day-to-day 
changes), and thus each time we do a release we should have a 
script/ant-task on cvs.apache.org which deals with updating the web site 
content from the source tree.

It's been a long time since I've actually edited the web site content, 
so I'd need to dig in there to figure out how it's working these days, 
but what do you think of this idea?

 >   I think it's very nice, if we could use 'ws-site/targets/
 > axis' as the distribution document. It should be Glen's field.
 > Is that right, Glen ?

I'm not sure exactly what you meant by this part, Toshi - could you 
explain more?

Thanks,
--Glen

Toshiyuki Kimura wrote:
> Tom, Glen and dims,
> 
>> Humm..  Shouldn't our web site documentation be generated
>> from the documentation in the CVS tree that gets shipped
>> with the product?
> 
> 
>   Please note that the situation is not something new. :-)
> The 'ws-axis/site/src' has been working as the master source
> of our site over 13 months with the contribution of tetsuya.
>   But, in facts, a number of commits were made to 'ws-axis/
> java/docs' only, hence there're many out of sync. As you may
> know, I tried to be in sync a couple of months ago by hand!
> <http://marc.theaimsgroup.com/?l=axis-dev&m=109845002329453>
> 
>> I must admit, I would be hard pressed to update the Axis
>> web site in anything short of hours these days.
> 
> 
>   Not at all. :):)
>   I think it's very nice, if we could use 'ws-site/targets/
> axis' as the distribution document. It should be Glen's field.
> Is that right, Glen ?
> 
>   If it's acceptable to all of you, I'd like to propose that
> 'ws-axis/java/docs' goes to be a read-only resource. Do you
> have any other good idea ?
> 
> Thanks,
> 
> Toshi
> 
> On Fri, 10 Dec 2004, Tom Jordahl wrote:
> 
>>
>> Humm..  Shouldn't our web site documentation be generated from the
>> documentation in the CVS tree that gets shipped with the product?
>>
>> I must admit, I would be hard pressed to update the Axis web site in
>> anything short of hours these days.
>>
>> -- 
>> Tom Jordahl
>> Macromedia Server Development
>>
>>> -----Original Message-----
>>> From: Davanum Srinivas [mailto:davanum@gmail.com]
>>> Sent: Friday, December 10, 2004 5:50 AM
>>> To: axis-dev@ws.apache.org
>>> Subject: Re: cvs commit: 
>>> ws-axis/site/src/documentation/content/xdocs/java
>>> install.ihtml
>>>
>>> id say do both for now. because ws-axis/java/docs goes into the
>>> distribution zip.
>>>
>>> -- dims
>>>
>>>
>>> On Thu, 9 Dec 2004 22:49:47 -0800 (PST), Toshiyuki Kimura
>>> <to...@apache.org> wrote:
>>>
>>>> Dominik,
>>>>
>>>>    IMO, it's enough to make 'ws-axis/site/src' up-to-date.
>>>> But, there's no consensus at this point. Need to ask dims
>>>> and all of folks.
>>>>
>>>> Thanks,
>>>>
>>>> Toshi <to...@apache.org>
>>>>
>>>>
>>>>
>>>> On Thu, 9 Dec 2004, Dominik Kacprzak wrote:
>>>>
>>>>> Toshi,
>>>>>
>>>>> thanks for pointing out my oversight. A quick follow up
>>>>> question.  Do we try to keep files under ws-axis/site/src
>>>>> and ws-axis/java/docs in sync?  Or we should be only
>>>>> concerned with ws-axis/site/src?
>>>>>
>>>>> thanks,
>>>>>
>>>>> - Dominik
>>>>>
>>>>> On Thu, Dec 09, 2004 at 10:34:15PM -0800, Toshiyuki Kimura wrote:
>>>>>
>>>>>> Hi Tom, Dominik and all,
>>>>>>
>>>>>>   The master sources of our site are in 'ws-axis/site/src' now.
>>>>>> Thus, any document patches will be appreciated better, if the
>>>>>> patch is a diff to 'ws-axis/site/src' not to 'ws-axis/java/docs'
>>>>>> or 'ws-site/targets/axis'.
>>>>>>
>>>>>>   In other words, 'ws-axis/java/docs' is no longer the master
>>>>>> source of the site. Please check it out the instruction below.
>>>>>> <http://ws.apache.org/axis/howtobuild.html>
>>>>>>
>>>>>> Thanks,
>>>>>> Toshi
>>>>>>
>>>>>> On Thu, 10 Dec 2004 toshi@apache.org wrote:
>>>>>>
>>>>>>> toshi       2004/12/09 22:30:04
>>>>>>>
>>>>>>> Modified:    site/src/documentation/content/xdocs/java install.ihtml
>>>>>>> Log:
>>>>>>> Applied the document patch from Dominik Kacprzak to the master.
>>>>>>>
>>>>>>> Revision  Changes    Path
>>>>>>> 1.7       +44 -0
>>>>>>> ws-axis/site/src/documentation/content/xdocs/java/install.ihtml
>>>>>>>
>>>>>>> Index: install.ihtml
>>>>>>> ===================================================================
>>>>>>> RCS file:
>>>>>>> /home/cvs/ws-
>>>
>>> axis/site/src/documentation/content/xdocs/java/install.ihtml,v
>>>
>>>>>>> retrieving revision 1.6
>>>>>>> retrieving revision 1.7
>>>>>>> diff -u -r1.6 -r1.7
>>>>>>> --- install.ihtml   22 Oct 2004 10:49:15 -0000      1.6
>>>>>>> +++ install.ihtml   10 Dec 2004 06:30:04 -0000      1.7
>>>>>>> @@ -241,6 +241,50 @@
>>>>>>>    axis/WEB-INF/lib to CATALINA_HOME/common/lib and restart Tomcat.
>>>>>>>    </P>
>>>>>>>
>>>>>>> +  <H3>WebLogic 8.1</H3>
>>>>>>> +
>>>>>>> +  <P>WebLogic 8.1 ships with <code>webservices.jar</code> that
>>>
>>> conflicts
>>>
>>>>>>> with Axis'
>>>>>>> +   <code>saaj.jar</code> and prevents Axis 1.2 from working right
>>>
>>> out of
>>>
>>>>>>> the box.
>>>>>>> +   This conflict exists because WebLogic uses an older definition
>>>
>>> of
>>>
>>>>>>> +   <code>javax.xml.soap.*</code> package from
>>>>>>> +   <a
>>>
>>> href="http://java.sun.com/webservices/docs/1.0/api/javax/xml/soap">
>>>
>>>>>>> +   Java Web Services Developer Pack Version 1.0</a>, whereas Axis
>>>
>>> uses a
>>>
>>>>>>> newer
>>>>>>> +   revision from J2EE 1.4.
>>>>>>> +  </P>
>>>>>>> +
>>>>>>> +  <P>
>>>>>>> +   However, there are two alternative configuration changes that
>>>
>>> enable
>>>
>>>>>>> Axis based
>>>>>>> +   web services to run on Weblogic 8.1.</P>
>>>>>>> +
>>>>>>> +   <ul>
>>>>>>> +   <li>In a webapp containing Axis, set &lt;prefer-web-inf-
>>>
>>> classes&gt;
>>>
>>>>>>> element in
>>>>>>> +   <code>WEB-INF/weblogic.xml</code> to true.  An example of
>>>>>>> <code>weblogic.xml</code>
>>>>>>> +   is shown below:
>>>>>>> +   <pre>
>>>>>>> +   &lt;weblogic-web-app&gt;
>>>>>>> +    &lt;container-descriptor&gt;
>>>>>>> +     &lt;prefer-web-inf-classes&gt;true&lt;/prefer-web-inf-
>>>
>>> classes&gt;
>>>
>>>>>>> +    &lt;/container-descriptor&gt;
>>>>>>> +   &lt;/weblogic-web-app&gt;</pre>
>>>>>>> +
>>>>>>> +   <P>If set to <code>true</code>, the
>>>>>>> <code>&lt;prefer-web-inf-classes&gt;</code>
>>>>>>> +   element will force WebLogic's classloader to load classes
>>>
>>> located in
>>>
>>>>>>> the
>>>>>>> +   WEB-INF directory of a web application in preference to
>>>
>>> application
>>>
>>>>>>> or system
>>>>>>> +   classes. This is a recommended approach since it only impacts a
>>>>>>> single web module.</P>
>>>>>>> +   </li>
>>>>>>> +
>>>>>>> +   <li>In a script used to start WebLogic server, modify
>>>>>>> <code>CLASSPATH</code>
>>>>>>> +   property by placing Axis's <code>saaj.jar</code> library in
>>>
>>> front of
>>>
>>>>>>> WeLlogic's
>>>>>>> +   <code>webservices.jar</code>.
>>>>>>> +
>>>>>>> +   <P><b>NOTE:</b> This approach impacts all applications deployed
>>>
>>> on a
>>>
>>>>>>> particular
>>>>>>> +   WebLogic instance and may prevent them from using WebLogic's
>>>>>>> webservices.</P></li>
>>>>>>> +   </ul>
>>>>>>> +
>>>>>>> +   <P>For more information on how WebLogic's class loader works,
>>>
>>> see
>>>
>>>>>>> +   <a
>>>>>>> href="http://e-
>>>
>>> docs.bea.com/wls/docs81/programming/classloading.html">
>>>
>>>>>>> +   WebLogic Server Application Classloading</a>.</P>
>>>>>>> +
>>>>>>>    <P><A name="start"></A></P>
>>>>>>>
>>>>>>>    <H2>Step 3: starting the web server</H2>
>>>>>>>
>>>>>>>
>>>>>>>
>>>>>>>
>>>>>
>>>>
>>>
>>>
>>> -- 
>>> Davanum Srinivas - http://webservices.apache.org/~dims/
>>
>>
> 

Re: cvs commit: ws-axis/site/src/documentation/content/xdocs/java install.ihtml

Posted by Toshiyuki Kimura <to...@apache.org>.
Hi Glen and all,

  Thanks, I was eagerly waiting for your comments.

> There should NOT be two places for content that must manually
> be kept in sync.  That's just a recipe for disaster.

  Absolutely. I totally agree with you on this point.

> It's been a long time since I've actually edited the web site
> content, so I'd need to dig in there to figure out how it's
> working these days, but what do you think of this idea?

  You don't need to do the task, because I've already done it. You
can touch it as a link - "HowToBuildSite" on our site;
http://ws.apache.org/axis/howtobuild.html

> >   I think it's very nice, if we could use 'ws-site/targets/
> > axis' as the distribution document. It should be Glen's field.
> > Is that right, Glen ?
>
> I'm not sure exactly what you meant by this part, Toshi -
> could you explain more?

  I meant that you're a release manager of the Axis Java Team.
That is, I believe that you build a release package, thus, you also
can change the document source for the package.

  Up to now, you might use 'ws-axis/java/docs/' for the release. But,
in order to solve the out-of-sync issue, I think that you just pack
'ws-site/targets/axis/' to the future releases, from now on.

  In addition, I hope to make 'ws-axis/java/docs/' as a read-only, so
that nobody adds any changes to the *invalid* contents.

Thanks,
Toshi

On Fri, 17 Dec 2004, Glen Daniels wrote:

> Hi all!
>
> Sorry to be so late replying to this thread, but here's my take.
>
> There should NOT be two places for content that must manually be kept in 
> sync.  That's just a recipe for disaster.
>
> I think the solution to this is for the master copy of the content to 
> live in the CVS tree in java/docs, and for the web site content to be 
> built automatically from that.  I think it's fine if the website content 
> reflects the last actual release (i.e. it shouldn't track day-to-day 
> changes), and thus each time we do a release we should have a 
> script/ant-task on cvs.apache.org which deals with updating the web site 
> content from the source tree.
>
> It's been a long time since I've actually edited the web site content, so 
> I'd need to dig in there to figure out how it's working these days, but 
> what do you think of this idea?
>
>>   I think it's very nice, if we could use 'ws-site/targets/
>> axis' as the distribution document. It should be Glen's field.
>> Is that right, Glen ?
>
> I'm not sure exactly what you meant by this part, Toshi - could you 
> explain more?
>
> Thanks,
> --Glen
>
> Toshiyuki Kimura wrote:
>> Tom, Glen and dims,
>> 
>>> Humm..  Shouldn't our web site documentation be generated
>>> from the documentation in the CVS tree that gets shipped
>>> with the product?
>> 
>> 
>>   Please note that the situation is not something new. :-)
>> The 'ws-axis/site/src' has been working as the master source
>> of our site over 13 months with the contribution of tetsuya.
>>   But, in facts, a number of commits were made to 'ws-axis/
>> java/docs' only, hence there're many out of sync. As you may
>> know, I tried to be in sync a couple of months ago by hand!
>> <http://marc.theaimsgroup.com/?l=axis-dev&m=109845002329453>
>> 
>>> I must admit, I would be hard pressed to update the Axis
>>> web site in anything short of hours these days.
>> 
>> 
>>   Not at all. :):)
>>   I think it's very nice, if we could use 'ws-site/targets/
>> axis' as the distribution document. It should be Glen's field.
>> Is that right, Glen ?
>> 
>>   If it's acceptable to all of you, I'd like to propose that
>> 'ws-axis/java/docs' goes to be a read-only resource. Do you
>> have any other good idea ?
>> 
>> Thanks,
>> 
>> Toshi
>> 
>> On Fri, 10 Dec 2004, Tom Jordahl wrote:
>> 
>>> 
>>> Humm..  Shouldn't our web site documentation be generated from the
>>> documentation in the CVS tree that gets shipped with the product?
>>> 
>>> I must admit, I would be hard pressed to update the Axis web site in
>>> anything short of hours these days.
>>> 
>>> -- 
>>> Tom Jordahl
>>> Macromedia Server Development
>>> 
>>>> -----Original Message-----
>>>> From: Davanum Srinivas [mailto:davanum@gmail.com]
>>>> Sent: Friday, December 10, 2004 5:50 AM
>>>> To: axis-dev@ws.apache.org
>>>> Subject: Re: cvs commit: 
>>>> ws-axis/site/src/documentation/content/xdocs/java
>>>> install.ihtml
>>>> 
>>>> id say do both for now. because ws-axis/java/docs goes into the
>>>> distribution zip.
>>>> 
>>>> -- dims
>>>> 
>>>> 
>>>> On Thu, 9 Dec 2004 22:49:47 -0800 (PST), Toshiyuki Kimura
>>>> <to...@apache.org> wrote:
>>>> 
>>>>> Dominik,
>>>>> 
>>>>>    IMO, it's enough to make 'ws-axis/site/src' up-to-date.
>>>>> But, there's no consensus at this point. Need to ask dims
>>>>> and all of folks.
>>>>> 
>>>>> Thanks,
>>>>> 
>>>>> Toshi <to...@apache.org>
>>>>> 
>>>>> 
>>>>> 
>>>>> On Thu, 9 Dec 2004, Dominik Kacprzak wrote:
>>>>> 
>>>>>> Toshi,
>>>>>> 
>>>>>> thanks for pointing out my oversight. A quick follow up
>>>>>> question.  Do we try to keep files under ws-axis/site/src
>>>>>> and ws-axis/java/docs in sync?  Or we should be only
>>>>>> concerned with ws-axis/site/src?
>>>>>> 
>>>>>> thanks,
>>>>>> 
>>>>>> - Dominik
>>>>>> 
>>>>>> On Thu, Dec 09, 2004 at 10:34:15PM -0800, Toshiyuki Kimura wrote:
>>>>>> 
>>>>>>> Hi Tom, Dominik and all,
>>>>>>> 
>>>>>>>   The master sources of our site are in 'ws-axis/site/src' now.
>>>>>>> Thus, any document patches will be appreciated better, if the
>>>>>>> patch is a diff to 'ws-axis/site/src' not to 'ws-axis/java/docs'
>>>>>>> or 'ws-site/targets/axis'.
>>>>>>> 
>>>>>>>   In other words, 'ws-axis/java/docs' is no longer the master
>>>>>>> source of the site. Please check it out the instruction below.
>>>>>>> <http://ws.apache.org/axis/howtobuild.html>
>>>>>>> 
>>>>>>> Thanks,
>>>>>>> Toshi
>>>>>>> 
>>>>>>> On Thu, 10 Dec 2004 toshi@apache.org wrote:
>>>>>>> 
>>>>>>>> toshi       2004/12/09 22:30:04
>>>>>>>> 
>>>>>>>> Modified:    site/src/documentation/content/xdocs/java 
>>>>>>>> install.ihtml
>>>>>>>> Log:
>>>>>>>> Applied the document patch from Dominik Kacprzak to the master.
>>>>>>>> 
>>>>>>>> Revision  Changes    Path
>>>>>>>> 1.7       +44 -0
>>>>>>>> ws-axis/site/src/documentation/content/xdocs/java/install.ihtml
>>>>>>>> 
>>>>>>>> Index: install.ihtml
>>>>>>>> ===================================================================
>>>>>>>> RCS file:
>>>>>>>> /home/cvs/ws-
>>>> 
>>>> axis/site/src/documentation/content/xdocs/java/install.ihtml,v
>>>> 
>>>>>>>> retrieving revision 1.6
>>>>>>>> retrieving revision 1.7
>>>>>>>> diff -u -r1.6 -r1.7
>>>>>>>> --- install.ihtml   22 Oct 2004 10:49:15 -0000      1.6
>>>>>>>> +++ install.ihtml   10 Dec 2004 06:30:04 -0000      1.7
>>>>>>>> @@ -241,6 +241,50 @@
>>>>>>>>    axis/WEB-INF/lib to CATALINA_HOME/common/lib and restart 
>>>>>>>> Tomcat.
>>>>>>>>    </P>
>>>>>>>> 
>>>>>>>> +  <H3>WebLogic 8.1</H3>
>>>>>>>> +
>>>>>>>> +  <P>WebLogic 8.1 ships with <code>webservices.jar</code> that
>>>> 
>>>> conflicts
>>>> 
>>>>>>>> with Axis'
>>>>>>>> +   <code>saaj.jar</code> and prevents Axis 1.2 from working 
>>>>>>>> right
>>>> 
>>>> out of
>>>> 
>>>>>>>> the box.
>>>>>>>> +   This conflict exists because WebLogic uses an older 
>>>>>>>> definition
>>>> 
>>>> of
>>>> 
>>>>>>>> +   <code>javax.xml.soap.*</code> package from
>>>>>>>> +   <a
>>>> 
>>>> href="http://java.sun.com/webservices/docs/1.0/api/javax/xml/soap">
>>>> 
>>>>>>>> +   Java Web Services Developer Pack Version 1.0</a>, whereas 
>>>>>>>> Axis
>>>> 
>>>> uses a
>>>> 
>>>>>>>> newer
>>>>>>>> +   revision from J2EE 1.4.
>>>>>>>> +  </P>
>>>>>>>> +
>>>>>>>> +  <P>
>>>>>>>> +   However, there are two alternative configuration changes that
>>>> 
>>>> enable
>>>> 
>>>>>>>> Axis based
>>>>>>>> +   web services to run on Weblogic 8.1.</P>
>>>>>>>> +
>>>>>>>> +   <ul>
>>>>>>>> +   <li>In a webapp containing Axis, set &lt;prefer-web-inf-
>>>> 
>>>> classes&gt;
>>>> 
>>>>>>>> element in
>>>>>>>> +   <code>WEB-INF/weblogic.xml</code> to true.  An example of
>>>>>>>> <code>weblogic.xml</code>
>>>>>>>> +   is shown below:
>>>>>>>> +   <pre>
>>>>>>>> +   &lt;weblogic-web-app&gt;
>>>>>>>> +    &lt;container-descriptor&gt;
>>>>>>>> +     &lt;prefer-web-inf-classes&gt;true&lt;/prefer-web-inf-
>>>> 
>>>> classes&gt;
>>>> 
>>>>>>>> +    &lt;/container-descriptor&gt;
>>>>>>>> +   &lt;/weblogic-web-app&gt;</pre>
>>>>>>>> +
>>>>>>>> +   <P>If set to <code>true</code>, the
>>>>>>>> <code>&lt;prefer-web-inf-classes&gt;</code>
>>>>>>>> +   element will force WebLogic's classloader to load classes
>>>> 
>>>> located in
>>>> 
>>>>>>>> the
>>>>>>>> +   WEB-INF directory of a web application in preference to
>>>> 
>>>> application
>>>> 
>>>>>>>> or system
>>>>>>>> +   classes. This is a recommended approach since it only impacts 
>>>>>>>> a
>>>>>>>> single web module.</P>
>>>>>>>> +   </li>
>>>>>>>> +
>>>>>>>> +   <li>In a script used to start WebLogic server, modify
>>>>>>>> <code>CLASSPATH</code>
>>>>>>>> +   property by placing Axis's <code>saaj.jar</code> library in
>>>> 
>>>> front of
>>>> 
>>>>>>>> WeLlogic's
>>>>>>>> +   <code>webservices.jar</code>.
>>>>>>>> +
>>>>>>>> +   <P><b>NOTE:</b> This approach impacts all applications 
>>>>>>>> deployed
>>>> 
>>>> on a
>>>> 
>>>>>>>> particular
>>>>>>>> +   WebLogic instance and may prevent them from using WebLogic's
>>>>>>>> webservices.</P></li>
>>>>>>>> +   </ul>
>>>>>>>> +
>>>>>>>> +   <P>For more information on how WebLogic's class loader works,
>>>> 
>>>> see
>>>> 
>>>>>>>> +   <a
>>>>>>>> href="http://e-
>>>> 
>>>> docs.bea.com/wls/docs81/programming/classloading.html">
>>>> 
>>>>>>>> +   WebLogic Server Application Classloading</a>.</P>
>>>>>>>> +
>>>>>>>>    <P><A name="start"></A></P>
>>>>>>>> 
>>>>>>>>    <H2>Step 3: starting the web server</H2>
>>>>>>>> 
>>>>>>>> 
>>>>>>>> 
>>>>>>>> 
>>>>>> 
>>>>> 
>>>> 
>>>> 
>>>> -- 
>>>> Davanum Srinivas - http://webservices.apache.org/~dims/
>>> 
>>> 
>> 
>