[
https://issues.apache.org/jira/browse/WHIRR-19?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=12876875#action_12876875
]
Patrick Hunt commented on WHIRR-19:
-----------------------------------
bq. They don't seem to have any documentation in the release artifacts either.
Actually they have the generated javadoc in the bin archive. Given that their
primary audience is programmers this seems reasonable to me. They have some ops
docs on the wiki but afaict they rely mostly on javadoc for developers and wiki
for everything else.
bq. The Java 5 thing is annoying,
I've heard some noise that forrest is working towards a release "rsn", as part
of which the java 5 requirement would be dropped. However even disregarding the
j5 issue I'm still have problems with forrest. It's very hard to debug, the
configuration/filelayout is cryptic, and as you mention the page layout is
nearly impossible to change.
I'm not set on any particular way of handling the site and the docs... just
would be nice to pick something. ;-)
Asciidoc and sphinx both support pdf generation which is good.
Any idea what kind of site we would like? I'm more a function over form person.
Tom if you feel comfortable with asciidoc perhaps we should try that? Here's an
example of the markup: http://www.methods.co.nz/asciidoc/asciidoc.txt
Looks ok to me. From the asciidoc web site if I understand correctly asciidoc
can generate not only single page documents, but also "website" as well. Is
that right? (multiple documents with navigation btw them?)
We can commit the site & doc source to trunk/src/docs/... We'd put the
generated output into trunk/docs (committers responsible for updating as part
of a doc commit) and the whirr website at apache along with new releases. That
sound reasonable for a first pass? Or should we not have the generated docs in
trunk? (I find it useful for ppl checking out the source, but it does add
additional small burden to commiter).
> Create project website
> ----------------------
>
> Key: WHIRR-19
> URL: https://issues.apache.org/jira/browse/WHIRR-19
> Project: Whirr
> Issue Type: Task
> Components: documentation
> Reporter: Tom White
> Priority: Blocker
> Fix For: 0.1.0
>
>
> Whirr needs a website at http://incubator.apache.org/whirr.
--
This message is automatically generated by JIRA.
-
You can reply to this email to add a comment to the issue online.
