You are viewing a plain text version of this content. The canonical link for it is here.
Posted to general@incubator.apache.org by David Crossley <cr...@apache.org> on 2005/11/04 07:31:58 UTC
simplifying the generation of Incubator website
I would like to try again to make it easier to build the
Incubator website.
Next week i will ugrade the configuration to use the current
release of Forrest (Incubator is one behind). Along with
creating a better procedure document, might make it easier.
I also want to have a discussion about why we are using
Forrest and whether something else might be more relevant,
or if continuing with Forrest then how to improve.
First a digression about the content ...
The website could use a lot more instructions. Some
procedural documentation is incorrect, out-of-date,
misleading, non-existent. The current pages could also be
enhanced and corrected.
The source content is in html format at "site-author"
directory. Please edit it and view the html document directly
in your web browser. Looks okay? Then do your normal svn
procedure 'svn diff, svn commit' etc. Done.
Later someone will build the documents with Forrest.
That is probably me, but can be any other committer with
Forrest installed.
Yes we would all love to have the better infrastructure
for generating, staging, and publishing all project sites
using whatever software they like. However that is not
happening yet. See the site-dev list.
---oOo---
Now on to the issues with using Forrest.
Yes we know that it is a little cumbersome and needs to be
installed. I am concerned that this might be contributing
to the hold-up with editing the docs.
Not trying to make excuses, but Forrest is pre-1.0 so it
should be expected to be a little difficult. Anyway, lets
try to either find out what can be improved or look at using
something else.
Incubator started before i joined, so can someone tell what
was the reason for choosing Forrest. It is a publishing
framework, and perhaps the simple needs of Incubator do not
warrant its use.
One beauty is that the content can be edited as simple html
docs, rather than an xml format.
My guess about the stumbling block for some people is the
need to check the final result into svn. Also the need to
copy files from build/site into site-publish and then do
svn add or svn remove files. I think that we can get
Cocoon to generate the files directly into site-publish
directory if that helps.
Another trouble is that for just changing one little document,
then Cocoon needs to generate everything. Sorry not much we
can do about that at this stage. There is a trick which i will
document. There is also "local forrestbot" which i will
explain after the upgrade.
Can people define any other issues? Probably best to keep
specific stuff until i have upgraded to 0.7 next week.
-David
---------------------------------------------------------------------
To unsubscribe, e-mail: general-unsubscribe@incubator.apache.org
For additional commands, e-mail: general-help@incubator.apache.org
Re: simplifying the generation of Incubator website
Posted by David Crossley <cr...@apache.org>.
Okay, i was successful with enabling the content to be
generated directly into the site-publish directory.
Please see the new documentation at
http://incubator.apache.org/guides/website.html
If anyone is updating from the previous release of
Forrest, then remove the incubator/build/ directory.
There are a few more enhancements that i want to do,
but the new system can be used now.
-David
David Crossley wrote:
> Henri Yandell wrote:
> > I did a bit of Incubator generation a week or so ago.
> >
> > Forrest was a problem, but only in that it was a bump I had to get
> > over and so I put it off for a week. When I actually attacked the
> > problem with momentum, the Forrest part was quite enjoyable. Only
> > problem is that you have to know to go look in the archives to
> > download the older version.
>
> I am updating things as we speak and i expect it to be much
> easier.
>
> > The weirdest bit for me was that we don't generate straight onto the
> > svn version of the target documents. Instead we generate, use diff and
> > then copy. It seems much simpler to generate onto the target and use
> > svn diff to confirm each difference.
>
> Thanks Henri. That is one aspect that i already referred to:
>
> > > Also the need to
> > > copy files from build/site into site-publish and then do
> > > svn add or svn remove files. I think that we can get
> > > Cocoon to generate the files directly into site-publish
> > > directory if that helps.
>
> The only trouble that i see with that approach is that
> one needs to remember to 'svn delete' any removed files,
> not only documents but also any CSS and images that Forrest
> might change with a future release. We will deal with
> that cleanup issue separately.
>
> Thanks so much for the feedback Henri. I reckon that
> you have found the main impediment.
>
> -David
---------------------------------------------------------------------
To unsubscribe, e-mail: general-unsubscribe@incubator.apache.org
For additional commands, e-mail: general-help@incubator.apache.org
Re: simplifying the generation of Incubator website
Posted by David Crossley <cr...@apache.org>.
Henri Yandell wrote:
> I did a bit of Incubator generation a week or so ago.
>
> Forrest was a problem, but only in that it was a bump I had to get
> over and so I put it off for a week. When I actually attacked the
> problem with momentum, the Forrest part was quite enjoyable. Only
> problem is that you have to know to go look in the archives to
> download the older version.
I am updating things as we speak and i expect it to be much
easier.
> The weirdest bit for me was that we don't generate straight onto the
> svn version of the target documents. Instead we generate, use diff and
> then copy. It seems much simpler to generate onto the target and use
> svn diff to confirm each difference.
Thanks Henri. That is one aspect that i already referred to:
> > Also the need to
> > copy files from build/site into site-publish and then do
> > svn add or svn remove files. I think that we can get
> > Cocoon to generate the files directly into site-publish
> > directory if that helps.
The only trouble that i see with that approach is that
one needs to remember to 'svn delete' any removed files,
not only documents but also any CSS and images that Forrest
might change with a future release. We will deal with
that cleanup issue separately.
Thanks so much for the feedback Henri. I reckon that
you have found the main impediment.
-David
---------------------------------------------------------------------
To unsubscribe, e-mail: general-unsubscribe@incubator.apache.org
For additional commands, e-mail: general-help@incubator.apache.org
Re: simplifying the generation of Incubator website
Posted by Henri Yandell <fl...@gmail.com>.
I did a bit of Incubator generation a week or so ago.
Forrest was a problem, but only in that it was a bump I had to get
over and so I put it off for a week. When I actually attacked the
problem with momentum, the Forrest part was quite enjoyable. Only
problem is that you have to know to go look in the archives to
download the older version.
The weirdest bit for me was that we don't generate straight onto the
svn version of the target documents. Instead we generate, use diff and
then copy. It seems much simpler to generate onto the target and use
svn diff to confirm each difference.
Hen
On 11/4/05, David Crossley <cr...@apache.org> wrote:
> I would like to try again to make it easier to build the
> Incubator website.
--- snip ---
> Can people define any other issues? Probably best to keep
> specific stuff until i have upgraded to 0.7 next week.
---------------------------------------------------------------------
To unsubscribe, e-mail: general-unsubscribe@incubator.apache.org
For additional commands, e-mail: general-help@incubator.apache.org