[Frugalware-devel] Frugalware's documentation

[Russell Dickenson]

On Fri, Feb 27, 2009 at 10:03 AM, Miklos Vajna <vmiklos at frugalware.org> wrote:
> On Fri, Feb 27, 2009 at 09:30:44AM +1000, Russell Dickenson <russelldickenson at gmail.com> wrote:
>> > I would say first please send the patches to the list, so Michel can
>> > comment them, but after a few good patches of course you can push
>> > directly.
>>
>> I forgot that in fact I don't have authority to push directly to the
>> "current" git repo, so there's no danger there.  :)   I'll send these
>> patches via email to this list so that they can be reviewed.  So
>> things don't get too complicated, I'll send one patch per email
>> message.
>
> Thanks. BTW technically you have write access to all repo, because so
> far it did not make sense to limit access to a given repo.

Oh!  O_O  If i ever push anything to "current" you may change your
policy on access. :P

>> After thinking about working on the Frugalware documentation for more
>> than 12 months, I have decided that my approach is going to be -
>> (1) do minimal editing, correcting grammatical mistakes, rewording
>> phrases which are unclear etc.  Of course there's not much to do
>> there;
>
> Given that you are native, your such corrections are highly appreciated.
>
>> (2) propose a restructuring of the documentation  to form a more
>> complete user's guide, possibly also a separate developer's guide.
>> The user's guide would be a guide to Frugalware, not an introductory
>> guide to Linux for newbies, possibly something like the following:
>>
>> Ubuntu Desktop Guide
>> https://help.ubuntu.com/ubuntu/desktopguide/C/index.html
>>
>> Ubuntu Pocket Guide and Reference
>> http://www.ubuntupocketguide.com/index2.html
>>
>> Please tell me if you have any objections to this approach.
>
> Actually we already have such a split-up, see index-user.txt and
> index-devel.txt. The chapters are individual txt files and they are
> included in the user, devel or both category.

I was not clear in my explanation.  I understand that there are
already a separate user and developer guides.  My aim is going to be
to perhaps restructure the documents - possibly only the user guide -
so that it has an introduction, references etc.

> Of course the parts can be improved and new chapters can be added. I
> guess what you could improve is more the user than the devel part. :)

Definitely.  I know very little about the world of the FW developer.

> I think a good example is that personally I did not really had to help
> Gholafox or Elentir regarding development questions - but that may be
> because they got help on #frugalware.fr, I don't know. ;)


Thankfully they're a LOT smarter than I am!


May you always be Frugal,

Russell Dickenson (AKA phayz)