Skip to Content.
Sympa Menu

sm-discuss - [SM-Discuss] Documentation Efforts was: Re: Grimoire Team Lead vote

sm-discuss AT lists.ibiblio.org

Subject: Public SourceMage Discussion List

List archive

Chronological Thread  
  • From: Jason Flatt <jflatt AT sourcemage.org>
  • To: SM Discuss <sm-discuss AT lists.ibiblio.org>
  • Subject: [SM-Discuss] Documentation Efforts was: Re: Grimoire Team Lead vote
  • Date: Wed, 15 Mar 2006 08:29:44 -0800

On Tuesday 14 March 2006 11:53 am, Arwed von Merkatz wrote:
>
> Now to the point of further development of the grimoires, I want to
> encourage more standardization and code reuse in our grimoire. We have
> worked towards this for quite a while now, starting with grimoire and
> section FUNCTIONS that helped remove a lot of duplicate code parts. We
> need to continue this, including reorganizing parts of the grimoire for
> easier code reuse, like it was done with php-pear, perl-cpan and
> python-devel. One of the most important requirements for this to happen
> is to have the currently existing infrastructure for code reuse and the
> current standards better documented. While I am not a particularly avid
> doc writer myself, I hope to encourage others to take up that task and
> will help anyone who does so with everything he or she needs.
>

I am willing to help in this regard. I am not good at creating documentation
from scratch about something I don't understand or know about, but I'm sure I
can produce something reasonable from notes and/or outlines that are provided
from someone who does have a clue.

I have been waiting for your initial or updated documentation on the
grimoire,
and what I should have been doing is asking for a start and then finishing it
off myself.

This goes for anyone out there monitoring this list. You can help with this
in one of two ways:
1) If you can produce good documentation from someone else's notes, outlines,
feed back or whatever, let me know (off list is fine) and I'll get
something going.
2) If you have documentation that needs to be written, but aren't good at it,
produce some notes or outlines for it and I or someone else will turn them
into something that is suitable for the Web site or Wiki. :^)

--
Jason Flatt
Source Mage GNU/Linux: Linux so advanced, it may as well be magic.
http://www.sourcemage.org/

Attachment: pgpwctWMzsgZU.pgp
Description: PGP signature




Archive powered by MHonArc 2.6.24.

Top of Page