request for documentation page and location to put it

Joachim Steiger roh at openmoko.org
Sat Aug 2 05:57:22 CEST 2008


Michael Shiloh wrote:
> This also raises the question of historical items. Once things are over 
> and done, removing from the wiki would avoid confusion. On the other 
> hand, history is good. Not sure how best to handle this, but it's lower 
> priority I think.

don't worry. thats what wikis have revisioning for.

when the issue is really solved and will not hit anybody with a half-way
recent image anymore, they should not be cluttering the wiki.

have a known issue list for the images installed on the FR by default
(old 2007.2 snapshot), and the latest state of each other image.
for 'recent' stuff this should be a list to bugs in trac.

means bugs which got solved and nobody will hit when starting with a new
device or the latest image can be resolved.

in the industry such a thing usually is called 'errata' or release notes
(when not seperate) and is usually done only for releases. (of which we
basically have none.. only snapshot releases from underways)
see
http://www.debian.org/releases/etch/i386/release-notes/ and
http://www.freebsd.org/releases/7.0R/relnotes.html as well as
http://www.freebsd.org/releases/7.0R/errata.html for some examples how
that looks

so this list should be kept short to answer stuff which people would
otherwise run into nearly guaranteed.
the longer and more detailed the list is, the more probably is that it
will not get read with enough care or even not updated often enough.
details belong be in the bug tracker. also closed tickets can be linked ;)


kind regards


--

Joachim Steiger
Openmoko Central Services




More information about the documentation mailing list