This is a list of todo items and "nice to haves" to help improve the documentation web site.

General

• cc version number to each page.
• JMX features need expanded documentation.
• Add an explicit statement about the licence.

docs/roles.html

• Add blurb on team members

main/docs/index.html

• "Build Loop" title in menu is not friendly to new users
• Rename "New Features" to "Features", and update with latest features

main/docs/configxml.html

• Each element needs an "Example" section.
• Would be really good if we could generate this from the source.

docs/faq.html

• Update content from wiki (or even point directly at wiki?)

Stick this somewhere

Note from JTF on project lifecycle:

 
  sleeping  <------------------+
     |                         |
  queued to build              |
     |                         |
  building                     |
      \                        |
    reread config.xml          |
       |                       |
    select builder             |
       |                       |
    bootstrap                  |
       |                       |
    modification check   <-----+-------+
       |                       |       |
      modifications found?     |       |
        * if no, go back to sleep      |
                                       |
      in quiet period?                 |
        * if yes, wait till quiet period ends,
          then do modification check again

    build
       |
    merge
       |
    publish
       /
  go back to sleep
    (too lazy to draw the arrow)

Wiki issues

• Add page to wiki describing the design guidelines of website, and a checklist for common change scenarios (e.g. a new config element).
• Think there could be a reorganisation to reduce redunancy and improve consistency among the getting started and tool integration pages.
• Required 3rd Party tools. Couldn't find any documentation. Seems to be: JSDK, Ant, Tomcat, and a version control system. But which versions? I saw references to Tomcat 4.1 but not to Tomcat 5, so went with 4.1. No docs on using Tomcat at all.
• Clearcase info was sparce and very scattered.
• Running CruiseControl as a service. There is a good page at RunningCruiseControlAsaWindowsService which presents two options. I chose the second one, JavaServiceWrapper Recipe, because it seemed simpler, but it did miss a couple of key points (wrapper.ntservice.account and wrapper.working.dir).
• No reporting documentation. After a lot of head scratching along with trail and error, I'm starting to understand the reporting structure, at least enough to increase the width of the JMX applet to get rid of the horizontal scroll bar
• JMX didn't work out of the box for me. It took a while to even figure out that I didn't need to install MX4J. The problem is the hard-coded port number in ControlPanel.jsp requires you to use the "-port 8000" parameter.
• JSCS took a while to figure out, even with good instructions on their site. The key was realizing that after installing your cruisecontrol.war, your "webapps/cruisecontrol" directory is mapped to your WORK_DIR.