[ 
https://issues.apache.org/jira/browse/WHIRR-19?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=12876503#action_12876503
 ] 

Patrick Hunt commented on WHIRR-19:
-----------------------------------

Here's the incubator's podling site guidelines for explicit requirements:
http://incubator.apache.org/guides/sites.html

"Regardless of which tool you use, the web site should be maintained in the svn 
repository, and include the site generation tool as a binary file. This 
simplifies the process of site generation and enables changes to the site to be 
made by any committer. The generated site should also be checked into svn. This 
allows the generated site to be relocated to any part of the Apache site after 
incubation is complete."

"Using A Wiki To Create Documentation

Podlings may use a wiki to create documentation (including the website) 
providing that follow the guidelines. In particular, care must be taken to 
ensure that access to the wiki used to create documentation is restricted to 
only those with filed CLAs. The PPMC MUST review all changes and ensure that 
trust is not abused."

I'm not sure how access could be restricted - does anyone know? (cwiki/wiki 
support this?) Sounds like this might be painful vs contributors submitting doc 
patches through jira. Cassandra is recently out of incubation, they seem to 
have 2 static pages (home & download) and the rest of their docs are all 
wiki/javadoc based.

I'm not particularly fond of forrest after using it for hadoop/zookeeper. Any 
interest in using sphinx? (used to generate the docs for python). 
http://sphinx.pocoo.org/ (their site is itself generated with sphinx)

Thoughts?

> 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.

Reply via email to