[General] Wiki for developers

Katie Capps Parlante capps at osafoundation.org
Tue Jun 26 10:17:49 PDT 2007


Mimi Yin wrote:
> *Engineering Area: *http://chandlerproject.org/Projects/EngineeringArea
> + *Open issue: How is what's on this page different from For 
> Developers? *- KATIE / TED / PHILIPPE?
> - http://chandlerproject.org/Journal/ForDevelopers

What is different? Not much. The cosmo side pulled from the same sources 
on both pages.

Here are my current thoughts...

- The purpose of the "engineering" wiki area is for developers: core 
developers working on the project, developers who might contribute a 
patch or two, developers who want to use the server for CalDAV testing, 
developers who want to write desktop plugins, developers who want to 
write applications that pull data from the server using Atom or some 
other protocol, developers writing automated tests, etc.

- The "engineering area" home page is a starting point for any of these 
people. It needs a brief description/overview of the server and destop, 
and needs obvious links to this information:
    * finding core developers (irc, mailing lists, etc.)
    * getting source (and building, etc.)
    * getting more technical info (architecture docs, protocol specs, etc.)
    * logging bugs and getting involved with testing
    * finding information about sub-components or projects

- We could also add a "hacking" link for each project -- info for 
getting started coding that is aimed at someone new to the project. That 
assumes that a "hacking" page includes useful information not redundant 
to the above.

- We could have a "project dashboard" page for both server and desktop, 
focused around release management: bug lists, links to tinderboxes, 
links to planning pages for current release, etc.

- The open source license needs to be clearly identified

I don't think we need an exact equivalent of the original desktop "for 
developers" page -- that was a short term solution for a particular release.

I think the main page for the twisted project is a good example of tone 
and level of information: http://twistedmatrix.com/trac/. (Most people 
interested in twisted are developers).

Also, I wonder if "Engineering" is the wrong term -- perhaps we should 
go with "Developer Area".

Cheers,
Katie



More information about the General mailing list