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

Eric Sandall eric at sandall.us
Mon Mar 20 16:13:48 EST 2006


-----BEGIN PGP SIGNED MESSAGE-----
Hash: SHA1

On Wed, 15 Mar 2006, Jason Flatt wrote:
> 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.  :^)

I believe this also includes moving (and translating) much of our
documentation from http://oldwiki.sourcemage.org and http://wiki.sourcemage.org
(documentation, not notes, drafts, etc.) to
http://www.sourcemage.org/docs. So if any of you who don't like to
write up documentation, but don't mind reformatting (from Wiki to
DrupalBook) then here's one way in which you can start contributing to
SMGL. ;)

- -sandalle

- --
Eric Sandall                     |  Source Mage GNU/Linux Developer
eric at sandall.us                  |  http://www.sourcemage.org/
http://eric.sandall.us/          |  SysAdmin @ Inst. Shock Physics @ WSU
http://counter.li.org/  #196285  |  http://www.shock.wsu.edu/
-----BEGIN PGP SIGNATURE-----
Version: GnuPG v1.4.2.1 (GNU/Linux)

iD8DBQFEHxsQHXt9dKjv3WERAtE6AJ4hJ3PrztgjHJk1gb0qKW3Lee1T7gCfUSex
HSZhSqn+HUfDb44AT74AbcY=
=I7U5
-----END PGP SIGNATURE-----



More information about the SM-Discuss mailing list