You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@avalon.apache.org by J Aaron Farr <fa...@apache.org> on 2003/12/09 21:50:49 UTC
Re: Mailing list subscription bad on the site
On Wed, 2003-12-10 at 01:33, Niclas Hedhman wrote:
> On Wednesday 10 December 2003 04:06, Daniel Dekany wrote:
> > On http://avalon.apache.org/merlin/mail-lists.html the (un)subsciprion
> > mailto-s seems to me bad, mail bunches:
> >
> > avalon-users-subscribe@avalon.apache.org
> >
> > (I have figured out that it meant to be
> > users-subscribe@avalon.apache.org, so I'm here. Maybe it is a deliberate
> > mistake to filter users who is not very inventive? :))
>
> Yeah, survival of the fittest ;o)
> Thanks for pointing it out.
>
> Gang,
> There is a mailing-list.xml in avalon-site that correctly points to the right
> mailing list subscription services, but not used from the left-hand
> navigation bar.
>
> But the site/*/mail-lists.html is incorrectly, not only for "merlin", but for
> "components" and "excalibur" as well. I suspect they are generated from Maven
> project descriptors.
Yep.
The mailing-list.xml version is in the avalon-site CVS module and is
linked to from those pages via the navigation.xml sidebar. All the
other mailing list pages you see are those auto-generated by Maven (ie-
the info is incorrect in the project specific project.xml pages).
> What else is needed to be changed?
> How to regenerate site? Automatic?
Note to self: Need to add this to the wiki somewhere.
Leo has a cron job that runs every couple of hours which checks out
(does a cvs update actually) everything in the avalon-site/site module.
This is what you see on the website. So in order to do an update you
must:
1. Change the XML or HTML source
2. Generate the html site (via maven usually)
3. Replace the old HTML files in avalon-site/site with the newly
generated ones via import or copy
4. Commit both changes to the source and the newly generated pages to
CVS (only commit what you need. No need to regenerate the whole site if
it's not necessary)
5. Wait a couple hours to see what you messed up. :)
--
jaaron <http://jadetower.org>
---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@avalon.apache.org
For additional commands, e-mail: dev-help@avalon.apache.org
Re: Mailing list subscription bad on the site
Posted by J Aaron Farr <fa...@apache.org>.
On Tue, 2003-12-09 at 20:50, J Aaron Farr wrote:
> > What else is needed to be changed?
> > How to regenerate site? Automatic?
>
> Note to self: Need to add this to the wiki somewhere.
done. see http://wiki.apache.org/avalon/SiteUpdateProcess
--
jaaron <http://jadetower.org>
---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@avalon.apache.org
For additional commands, e-mail: dev-help@avalon.apache.org
Re: Mailing list subscription bad on the site
Posted by J Aaron Farr <fa...@apache.org>.
On Wed, 2003-12-10 at 02:56, Niclas Hedhman wrote:
> Is this really optimal?
> The phrase "[manually] replace the old HTML files ... with the newly
> generated...", sounds like a perfect candidate of MLMU(tm) (manual labour
> mess-up)...
> Wouldn't it be better that the cron job does all of the above, and if that
> takes too much CPU, make it happen less frequently?
Well, the trick is setting where the various tools output the results.
For example, we could set up the avalon-site module so that the command
"maven site" placed the output in "site" instead of "target/site".
But it's tricker for project specific documentation since that would
require sending the generated results to a directory outside of the
project root space, ie- generating docs for merlin would be maven would
have to output the generated HTML also to "avalon-site/site" which is
outside of the maven project directories.
An alternative would be to place ALL documentation into avalon-site but
I don't think anyone wants to do that.
Finally, having the actual generated HTML all in one location separate
from targets and build directories helps ensure that no one accidentally
overwrites the site. It means you need to be a little more careful and
a little more intentional about releasing anything. And intentionality
isn't necessarily a bad thing.
If you want to try to come up with a better process and more automation,
I don't think anyone will object too loudly. One solution would be to
create an custom avalon-site plugin for maven. Or perhaps at least
something that would automatically do the CVS import into
avalon-site/site, maybe something like "maven site:avalon-deploy". That
could at least make it easier for the subprojects to release
documentation. Yeah, that might be worth working on.
--
jaaron <http://jadetower.org>
---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@avalon.apache.org
For additional commands, e-mail: dev-help@avalon.apache.org
Re: Mailing list subscription bad on the site
Posted by Niclas Hedhman <ni...@hedhman.org>.
On Wednesday 10 December 2003 04:50, J Aaron Farr wrote:
> Leo has a cron job that runs every couple of hours which checks out
> (does a cvs update actually) everything in the avalon-site/site module.
> This is what you see on the website. So in order to do an update you
> must:
>
> 1. Change the XML or HTML source
> 2. Generate the html site (via maven usually)
> 3. Replace the old HTML files in avalon-site/site with the newly
> generated ones via import or copy
> 4. Commit both changes to the source and the newly generated pages to
> CVS (only commit what you need. No need to regenerate the whole site if
> it's not necessary)
> 5. Wait a couple hours to see what you messed up. :)
Is this really optimal?
The phrase "[manually] replace the old HTML files ... with the newly
generated...", sounds like a perfect candidate of MLMU(tm) (manual labour
mess-up)...
Wouldn't it be better that the cron job does all of the above, and if that
takes too much CPU, make it happen less frequently?
Niclas
---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@avalon.apache.org
For additional commands, e-mail: dev-help@avalon.apache.org