Documentation links updated

[Kevin Meyer - KMZ <ke...@kmz.co.za>]

Dear all,

Don't be surprised when you next "svn up" - there are a lot of changes 
to get the documentation sorted.

Now, however, webcheck has the following "bad links" report:

"These links could not be retrieved during the crawling of the website.

    file:///LICENSE.txt
        [Errno 2] No such file or directory: '/LICENSE.txt'
    referenced from:
        Default Runtime NOSQL ObjectStore - Project Dependencies"

And this results from a faulty apache commons-configuration pom.

This is when the full site is built using:
mvn3 -T 4 clean site-deploy -D modules=site -D deploy=local -D site=full -o

I'm using Maven 3 (with 4 threads) - total build takes about 10 minutes.
A webcheck:
time webcheck -a /tmp/m2-sites/isis/index.html -x /apidocs

Takes 4 minutes to complete.

As you can see, I'm ignoring the .../apidocs/.. links which are not built 
yet.


I have not committed the changes to the framework pom.xml to work 
with Maven 3. Mostly it was just changing the site maven-site-plugin to 
3.0-beta-3.

Now, to run msdf.o for apidoc generation, too!

Regards,
Kevin

Re: Documentation links updated

[Dan Haywood <dk...@gmail.com>]

Per other thread also, I've created ISIS-107 as an umbrella for any 
miscellaneous messing about with site documentation.

Cheers
Dan


On 17/07/2011 19:55, Kevin Meyer - KMZ wrote:
> On 17 Jul 2011 at 17:38, Dan Haywood wrote:
>
>> On 17/07/2011 17:26, Kevin Meyer - KMZ wrote:
>>> Don't be surprised when you next "svn up" - there are a lot of changes
>>> to get the documentation sorted.
>> Yes, just noticed that.  A small suggestion ... could you check before
>> moving modules around that there no-one is working in these areas,
>> otherwise they'll get a tree conflict.  I know that Rob occasionally has
>> enhancements for the Scimpi viewer, and I saw that you moved
>> scimpi/servlet ->  scimpi/scimpi-servlet and scimpi/dispatcher ->
>> scimpi/scimpi-dispatcher.
> Indeed! You're quite right - I most certainly should have let everyone
> know what I was up to! Got caught up with getting all the doc links
> working. :)
>
> I sincerely hope there are no issues - at least we're still a very small
> group at the moment - but your suggestion will become more
> important as the Isis dev community grows.
>
> What I have learned, though, is for the documentation (and generated
> reports, e.g. modules report) to correctly sync up, the maven artifact Id
> *must* match the module name (and hence the module subdirectory) -
> thus renaming scimpi/servlet to scimpi/scimpi-servlet, etc.
>
> Anyway - I'm most likely going to take a break for a bit - but I will put
> the webcheck report somewhere (it took about 49 mins for msdf.sh set
> to use maven3 with 4 threads to generate the full doc build on my
> machine).
>
> Regards,
> Kevin
>
>
>
>

Re: Documentation links updated

[Kevin Meyer - KMZ <ke...@kmz.co.za>]

On 17 Jul 2011 at 17:38, Dan Haywood wrote:

> On 17/07/2011 17:26, Kevin Meyer - KMZ wrote:
> >
> > Don't be surprised when you next "svn up" - there are a lot of changes
> > to get the documentation sorted.
> Yes, just noticed that.  A small suggestion ... could you check before 
> moving modules around that there no-one is working in these areas, 
> otherwise they'll get a tree conflict.  I know that Rob occasionally has 
> enhancements for the Scimpi viewer, and I saw that you moved 
> scimpi/servlet -> scimpi/scimpi-servlet and scimpi/dispatcher -> 
> scimpi/scimpi-dispatcher.

Indeed! You're quite right - I most certainly should have let everyone 
know what I was up to! Got caught up with getting all the doc links 
working. :)

I sincerely hope there are no issues - at least we're still a very small 
group at the moment - but your suggestion will become more 
important as the Isis dev community grows.

What I have learned, though, is for the documentation (and generated 
reports, e.g. modules report) to correctly sync up, the maven artifact Id 
*must* match the module name (and hence the module subdirectory) - 
thus renaming scimpi/servlet to scimpi/scimpi-servlet, etc.

Anyway - I'm most likely going to take a break for a bit - but I will put 
the webcheck report somewhere (it took about 49 mins for msdf.sh set 
to use maven3 with 4 threads to generate the full doc build on my 
machine).

Regards,
Kevin

Re: Documentation links updated

[Dan Haywood <dk...@gmail.com>]

On 17/07/2011 17:26, Kevin Meyer - KMZ wrote:
> Dear all,
>
> Don't be surprised when you next "svn up" - there are a lot of changes
> to get the documentation sorted.
Yes, just noticed that.  A small suggestion ... could you check before 
moving modules around that there no-one is working in these areas, 
otherwise they'll get a tree conflict.  I know that Rob occasionally has 
enhancements for the Scimpi viewer, and I saw that you moved 
scimpi/servlet -> scimpi/scimpi-servlet and scimpi/dispatcher -> 
scimpi/scimpi-dispatcher.


>
> I have not committed the changes to the framework pom.xml to work
> with Maven 3. Mostly it was just changing the site maven-site-plugin to
> 3.0-beta-3.
>
> Now, to run msdf.o for apidoc generation, too!
Keep up the good work!

Cheers
Dan

> Regards,
> Kevin
>
>