cocoon-docs mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From David Crossley <>
Subject Re: [VOTE] Use Forrest to build Cocoon docs
Date Mon, 28 Oct 2002 03:17:13 GMT
This is not ready for a "vote" we need to discuss the
"proposal" first.

There are many issues. Some we have discussed on Forrest
and we even have scratchpad builds to help transform the
Cocoon xdocs. However, it needs careful consideration.
(Work with Forrest in general has progressed since then and
the demo transformation now needs to catch up.)

Also, why is this being copied to cocoon-dev. We agreed
that documentation stuff would get discussed only on
cocoon-docs working under the assumption that all Cocoon
developers are subscribed there.

More below ...

Nicola Ken Barozzi wrote:
> It's time we move the Cocoon docs to Forrest.
> There is still a problem to solve though.
> How are we going to generate the documentation?
> Currently Cocoon uses itself to generate the documentation, but now we 
> want to use Forrest, which has an indipendent distribution.
> I would propose that we remove the current "docs" target from Cocoon 
> altogether, and use the Forrest distro for it.

No, not remove docs target. Forrest can remotely build
it as well as Cocoon being able to build its own docs
in place.

As a user, when i download Cocoon via my dial-up 56k modem
(yes i am lucky, lots of Australia has 28.8k and twitchy)
i expect to be able to build the core docs locally via
Cocoon. I expect to just do "build docs" then start
at index.html and become enlightened.

> This way we move the concern of the docs system to Forrest and don't 
> have to cut-n-paste and keep in synch the Forrest build system with the 
> Cocoon one.

I do not know what you mean by "cut-n-paste" - we do
not do that for the Cocoon-docs experiment in Forrest.

> The "docs" target in Cocoon will thus become just a call to the Forrest 
> build process, and the docs will be included in the distributions 
> generated statically.
> I think this will make things simpler to manage and update.
> What do you think?

Discuss a proposal first.

View raw message