Changeset 8479 in project


Ignore:
Timestamp:
02/14/08 20:41:56 (12 years ago)
Author:
mfredrickson
Message:

Changes applied for mfredrickson (216.250.178.58) through svnwiki:

Adding some guidelines for documentation. Adding some additional tasks for the Hackathon

File:
1 edited

Legend:

Unmodified
Added
Removed
  • wiki/Hackathon1

    r8412 r8479  
    55Here are some suggestions on what to do.  During the hackathon, please mark something with your name to indicate you want to work on it, so no unnecessary duplicate work gets done.
    66
    7 * Convert all egg documentation to a single format (wiki?)
     7*  Update existing documentation
    88  - Please do not touch the documentation of any of the eggs maintained by [[ivan raikov|me]]. It is already annoying enough to deal with eggs that have documentation on the wiki but not in their directory in the SVN tree. -Ivan
    99   
    1010* Document core Chicken stuff (needs to be broken up into more specific chunks, core committers, please indicate what's not documented yet)
     11
     12* Improve pre/post egg commit hooks
     13** RSS feed(s)
     14** general cleaning and refactoring
     15
     16* Improve the Chicken performance on [[http://shootout.alioth.debian.org/|The Computer Language Benchmarks Game]]
    1117
    1218=== Documentation on wiki, docs in eggs
     
    1622Perhaps for eggs that have local documentation, we could write something to copy the current local docs into the wiki (with a preamble, warning that the wiki docs may be overridden). A 'comments' section at the bottom of the wiki page could be preserved across updates from the local docs.
    1723
    18 The trick is that there are multiple local-doc formats: eggdoc, HTML file, etc. It may be a tough or intractable problem if we don't reduce the number of variations.
     24The trick is that there are multiple local-doc formats: eggdoc, HTML file, etc. It may be a tough or intractable problem if we don't reduce the number of variations. However, documentation preferences are hard to unify, so [[Mark Fredrickson]] proposed the following guidelines and priorities to avoid a [[http://en.wikipedia.org/wiki/Color_of_the_bikeshed|bikeshed]]:
     25
     26# Our primary focus is on updating documentation where it currently resides (wiki, svn, etc) in the format it currently uses. Getting the documentation that exists current is a big task as it is. Let's not worry about moving documentation just yet.
     27# Where documentation is non-existent, give the person(s) working on the new documentation the right to choose the format.
     28# Let's put any new functionality on the back burner, at least when talking about the Hackathon. -)
     29# Let's try to dedicate some time to infrastructure improvements: Mario suggested expanding SVN wiki tags, it sounds like the *-commit hooks could use a refactoring, etc. As Zbigniew said, infrastructure lasts.
     30
Note: See TracChangeset for help on using the changeset viewer.