You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@cocoon.apache.org by K Bertram <k....@kbsm.de> on 2005/10/19 15:35:24 UTC

Broken links from samples to doc

Hi all,

here are broken links from the samples to the (old xdocs) documentation
and wiki references. It seems to me that these links should work by
release 2.1.8 with new downloadable Docs. Or I'm wrong?
At forrest the html files are with numbers so the ref to the new one
couldn't work anymore.

Klaus

Here are the list:

/samples/
_Core Documentation_
http://localhost:8888/docs/

*Input Modules*
_Input Modules Docs _
  http://localhost:8888/docs/userdocs/concepts/modules.html
_API Docs_
http://localhost:8888/api/java/org/apache/cocoon/components/modules/input/package-summary.html

*Charpeon Block*
http://localhost:8888/samples/blocks/chaperon/welcome

*Database Block*
_SQL Transformer_
_XSP_
_Modular Database Actions_
_Original Data_

*Midi Block*
_MIDI Documentation_
http://wiki.cocoondev.org/Wiki.jsp?page=MIDI

*Web3*
_Documentation_

*Apples*
_Documentation_
http://wiki.cocoondev.org/Wiki.jsp?page=Apples

*Mail Block*
_Action Documentation_
_Logicsheet documentation_

*Cron*
_Doumentation_


Re: Broken links from samples to doc

Posted by Ross Gardler <rg...@apache.org>.
K Bertram wrote:
> Hi Ross,
> 
> the broken links come out of the svn area in the samples from the blocks.
> 
> It seems to me that the broken-links list are from the documentation 
> itself and not from the block samples at svn.
> 

Ooops, sorry. It didn't register that yours were from samples. You are 
correct, the list generated by Forrestbot are for the docs.

Ross


Re: Broken links from samples to doc

Posted by K Bertram <k....@kbsm.de>.
Hi Ross,

the broken links come out of the svn area in the samples from the blocks.

It seems to me that the broken-links list are from the documentation 
itself and not from the block samples at svn.

Klaus

Ross Gardler wrote:
> K Bertram wrote:
> 
>> Hi all,
>>
>> here are broken links from the samples to the (old xdocs) documentation
>> and wiki references.
> 
> 
> Thanks
> 
>> It seems to me that these links should work by
>> release 2.1.8 with new downloadable Docs. Or I'm wrong?
> 
> 
> I agree there should be no broken links in the release.
> 
> I just committed a patch to Forrest that will put am XML file of broken 
> links in the root directory of the site after each hourly build. The 
> next build is due in about 10 minutes so you will soon be able to see it 
> at:
> 
> http://forrest.zones.apache.org/ft/build/cocoon-docs/broken-links.xml
> 
> This not only lists the target of the link, but also the source of the 
> link too. So make fixing these things much easier :-)
> 
> Ross
> 


Re: Broken links from samples to doc

Posted by Ross Gardler <rg...@apache.org>.
K Bertram wrote:
> Hi all,
> 
> here are broken links from the samples to the (old xdocs) documentation
> and wiki references.

Thanks

> It seems to me that these links should work by
> release 2.1.8 with new downloadable Docs. Or I'm wrong?

I agree there should be no broken links in the release.

I just committed a patch to Forrest that will put am XML file of broken 
links in the root directory of the site after each hourly build. The 
next build is due in about 10 minutes so you will soon be able to see it at:

http://forrest.zones.apache.org/ft/build/cocoon-docs/broken-links.xml

This not only lists the target of the link, but also the source of the 
link too. So make fixing these things much easier :-)

Ross

Re: Broken links from samples to doc

Posted by Upayavira <uv...@odoko.co.uk>.
K Bertram wrote:
> ups sorry
> ok then to cocoon.apache.org/2.1/ when the new docu is online ;)

Exactly :-)

Upayavira

> Ross Gardler wrote:
> 
>> K Bertram wrote:
>>
>>> the local docs are there. If not redirect to the
>>> http://forrest.zones.apache.org/ft/build/cocoon-docs/ ..
>>
>>
>>
>> Please do not point any references here. This is a staging area only,
>> it is not published docs.
>>
>> The idea is to take these docs, once they build without errors and
>> package them for the release and (optionally) put them on Cocoons own
>> site.
>>
>> Ross
>>
>>
> 
> 


Re: Broken links from samples to doc

Posted by K Bertram <k....@kbsm.de>.
ups sorry
ok then to cocoon.apache.org/2.1/ when the new docu is online ;)


Ross Gardler wrote:
> K Bertram wrote:
> 
>> the local docs are there. If not redirect to the
>> http://forrest.zones.apache.org/ft/build/cocoon-docs/ ..
> 
> 
> Please do not point any references here. This is a staging area only, it 
> is not published docs.
> 
> The idea is to take these docs, once they build without errors and 
> package them for the release and (optionally) put them on Cocoons own site.
> 
> Ross
> 
> 


Re: Broken links from samples to doc

Posted by Ross Gardler <rg...@apache.org>.
K Bertram wrote:
> the local docs are there. If not redirect to the
> http://forrest.zones.apache.org/ft/build/cocoon-docs/ ..

Please do not point any references here. This is a staging area only, it 
is not published docs.

The idea is to take these docs, once they build without errors and 
package them for the release and (optionally) put them on Cocoons own site.

Ross


Re: Broken links from samples to doc

Posted by K Bertram <k....@kbsm.de>.
Yes I try,

but why to c.a.o/2.1/
Should this not be teh local docs which comes sooner or later?
By the way:
The local reference to docs/ are blown OK
At the main page we could tell the user where he can download the 
external docs. Also we could add a folder with a sidemap that checks if 
the local docs are there. If not redirect to the
http://forrest.zones.apache.org/ft/build/cocoon-docs/ ..
side.
Only an idea ;)


Upayavira wrote:
> K Bertram wrote:
> 
>>Hi all,
>>
>>here are broken links from the samples to the (old xdocs) documentation
>>and wiki references. It seems to me that these links should work by
>>release 2.1.8 with new downloadable Docs. Or I'm wrong?
>>At forrest the html files are with numbers so the ref to the new one
>>couldn't work anymore.
> 
> 
> Do you think you could provide a patch to correct these broken links?
> Point to wiki.apache.org/cocoon and, I guess, to cocoon.apache.org/2.1/ too?
> 
> This would be very helpful.
> 
> Regards, Upayavira
> 

Re: Broken links from samples to doc

Posted by Upayavira <uv...@odoko.co.uk>.
K Bertram wrote:
> Hi all,
> 
> here are broken links from the samples to the (old xdocs) documentation
> and wiki references. It seems to me that these links should work by
> release 2.1.8 with new downloadable Docs. Or I'm wrong?
> At forrest the html files are with numbers so the ref to the new one
> couldn't work anymore.

Do you think you could provide a patch to correct these broken links?
Point to wiki.apache.org/cocoon and, I guess, to cocoon.apache.org/2.1/ too?

This would be very helpful.

Regards, Upayavira

> Here are the list:
> 
> /samples/
> _Core Documentation_
> http://localhost:8888/docs/
> 
> *Input Modules*
> _Input Modules Docs _
>  http://localhost:8888/docs/userdocs/concepts/modules.html
> _API Docs_
> http://localhost:8888/api/java/org/apache/cocoon/components/modules/input/package-summary.html
> 
> 
> *Charpeon Block*
> http://localhost:8888/samples/blocks/chaperon/welcome
> 
> *Database Block*
> _SQL Transformer_
> _XSP_
> _Modular Database Actions_
> _Original Data_
> 
> *Midi Block*
> _MIDI Documentation_
> http://wiki.cocoondev.org/Wiki.jsp?page=MIDI
> 
> *Web3*
> _Documentation_
> 
> *Apples*
> _Documentation_
> http://wiki.cocoondev.org/Wiki.jsp?page=Apples
> 
> *Mail Block*
> _Action Documentation_
> _Logicsheet documentation_
> 
> *Cron*
> _Doumentation_
> 
>