[Frugalware-devel] Frugalware's documentation

[Russell Dickenson]

On Fri, Feb 27, 2009 at 8:49 AM, Miklos Vajna <vmiklos at frugalware.org> wrote:
> On Thu, Feb 26, 2009 at 09:19:05PM +1000, Russell Dickenson <russelldickenson at gmail.com> wrote:
>> I'd like to have perhaps the web site and documentation "tidied up" so
>> that there is as little overlap as possible.  One option would be to
>> have the web site's "Donations" menu option directed to the
>> appropriate section of the documentation, instead of another page
>> altogether.
>
> Normally probably it's better to just point to the documentation on the
> homepage, however probably if someone wants to donate, we don't want to
> do many redirects, it would be bad if she would end up with not donating
> because of this. ;)
>
> But for example docs/about.txt could be just linked from
> frugalware.org/about (after merging the contents of the two pages).

I understand.  For topics which are of common interest - "donations"
and "about" for example, linking to the matching page of the
documentation makes sense.

>> Should I push to the current repo each section of the documentation,
>> once I'm happy with it, or wait until it can be reviewed before it's
>> pushed?
>
> 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.

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;
(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.


May you always be Frugal,

Russell Dickenson (AKA phayz)