GRUB 2 documentation

GRUB 2 documentation

[shirish]

Hi all,
      I see this bug
http://bugs.debian.org/cgi-bin/bugreport.cgi?bug=333516 about
documentation , what is the status of that, we are waiting for grub 2
to hit stable before the documentation is written or what?

Cheers!
-- 
          Shirish Agarwal
  This email is licensed under http://creativecommons.org/licenses/by-nc/3.0/

065C 6D79 A68C E7EA 52B3  8D70 950D 53FB 729A 8B17

Re: GRUB 2 documentation

[Marco Gerards]

shirish <shirishag75@gmail.com> writes:

Hi,

>      I see this bug
> http://bugs.debian.org/cgi-bin/bugreport.cgi?bug=333516 about
> documentation , what is the status of that, we are waiting for grub 2
> to hit stable before the documentation is written or what?

Well, you can't write 100% accurate documentation now, but GRUB 2 will
never be finished (as in: software is never finished), so you do not
have to wait.  Better start now and improve as we go along.

Did you read the texinfo documentation from GRUB Legacy?  This is the
quality I am hoping for.  So not a manpage, but good documentation
that explains all features, etc.

Really, documentation is as important as the code itself.  I would
become really happy if you would be willing to work on this.  You
don't need many technical skills and there are enough people around
who are willing to help you, when questions arise.

Do you want to work on this?  It is a big job, but you can learn a lot
from this.

--
Marco

Re: GRUB 2 documentation

[Khaled Hosny]

On 6/26/07, Marco Gerards <mgerards@xs4all.nl> wrote:
> shirish <shirishag75@gmail.com> writes:
>
> Hi,
>
> >      I see this bug
> > http://bugs.debian.org/cgi-bin/bugreport.cgi?bug=333516 about
> > documentation , what is the status of that, we are waiting for grub 2
> > to hit stable before the documentation is written or what?
>
> Well, you can't write 100% accurate documentation now, but GRUB 2 will
> never be finished (as in: software is never finished), so you do not
> have to wait.  Better start now and improve as we go along.
>
> Did you read the texinfo documentation from GRUB Legacy?  This is the
> quality I am hoping for.  So not a manpage, but good documentation
> that explains all features, etc.
>
> Really, documentation is as important as the code itself.  I would
> become really happy if you would be willing to work on this.  You
> don't need many technical skills and there are enough people around
> who are willing to help you, when questions arise.
>
> Do you want to work on this?  It is a big job, but you can learn a lot
> from this.
>
> --
> Marco

I'd like to work on this, any idea where to begin? should I start with
grub legacy documentation and update/remove/add information to match
that of grub2 or should I start from scratch?

-- 
Khaled Hosny

Egyptian GNU/Linux user
Member of Arabeyes team [www.arabeyes.org]
My Blog: [www.khaledhosny.org]

Support Free Knowledge [ar.wikipedia.org]

Re: GRUB 2 documentation

[adrian15]

Khaled Hosny escribió:
> I'd like to work on this, any idea where to begin? should I start with
> grub legacy documentation and update/remove/add information to match
> that of grub2 or should I start from scratch?
> 

In my opinnion there are three ways to elaborate documentation.
1) From grub2 developer point of view.
2) From grub2 architecture.
3) From a grub2 user.


	As long as scripting is not well defined I think you can begin with the
grub2 architecture. I think knowing yourself the grub2 architecture can
make things easier when elaborating documentation from a grub2 user
point of view.

	I mean one of the first thing a grub2 documentation from a grub2 user
point of view should have is an introduction on how does grub2 work overall.

adrian15

Re: GRUB 2 documentation

[Marco Gerards]

"Khaled Hosny" <khaledhosny@eglug.org> writes:

>> >      I see this bug
>> > http://bugs.debian.org/cgi-bin/bugreport.cgi?bug=333516 about
>> > documentation , what is the status of that, we are waiting for grub 2
>> > to hit stable before the documentation is written or what?
>>
>> Well, you can't write 100% accurate documentation now, but GRUB 2 will
>> never be finished (as in: software is never finished), so you do not
>> have to wait.  Better start now and improve as we go along.
>>
>> Did you read the texinfo documentation from GRUB Legacy?  This is the
>> quality I am hoping for.  So not a manpage, but good documentation
>> that explains all features, etc.
>>
>> Really, documentation is as important as the code itself.  I would
>> become really happy if you would be willing to work on this.  You
>> don't need many technical skills and there are enough people around
>> who are willing to help you, when questions arise.
>>
>> Do you want to work on this?  It is a big job, but you can learn a lot
>> from this.
>
> I'd like to work on this, any idea where to begin? should I start with
> grub legacy documentation and update/remove/add information to match
> that of grub2 or should I start from scratch?

You would have to start from scratch.  GRUB 2 is a rewrite and
unrelated to GRUB Legacy.  Only the style of the documentation should
be matched, nothing else.  so the verbosity and quality.

--
Marco