Volunteering for Emacs documentation

Volunteering for Emacs documentation

[Gian Uberto Lauri]

There was a discussion on emacs-devel@gnu.org were it was said that
volunteers were velcomed to work on Emacs manual and doc strings.
(http://lists.gnu.org/archive/html/help-gnu-emacs/2015-04/msg00216.html).

What should one of these volunteers do to be useful?

-- 
 /\           ___                                    Ubuntu: ancient
/___/\_|_|\_|__|___Gian Uberto Lauri_____               African word
  //--\| | \|  |   Integralista GNUslamico            meaning "I can
\/                 coltivatore diretto di software       not install
     già sistemista a tempo (altrui) perso...                Debian"

Warning: gnome-config-daemon considered more dangerous than GOTO

Re: Volunteering for Emacs documentation

[Eli Zaretskii]

> Date: Fri, 17 Apr 2015 09:15:01 +0200
> From: "Gian Uberto Lauri" <saint@eng.it> 
> 
> There was a discussion on emacs-devel@gnu.org were it was said that
> volunteers were velcomed to work on Emacs manual and doc strings.
> (http://lists.gnu.org/archive/html/help-gnu-emacs/2015-04/msg00216.html).
> 
> What should one of these volunteers do to be useful?

One way of contributing to the documentation is to search the Emacs
bug tracker for bugs related to documentation, like errors or
inaccuracies in the manuals, and fix them.

Another way is to add documentation for new features in the repository
mentioned in NEWS without either a "+++" or "---" marker.

Yet another way is to read the discussions which indicate that some
piece of documentation needs to be improved, and do that.

Thanks.

Re: Volunteering for Emacs documentation

[Gian Uberto Lauri]

Eli Zaretskii writes:
 > > Date: Fri, 17 Apr 2015 09:15:01 +0200
 > > From: "Gian Uberto Lauri" <saint@eng.it> 
 > > 
 > > There was a discussion on emacs-devel@gnu.org were it was said that
 > > volunteers were velcomed to work on Emacs manual and doc strings.
 > > (http://lists.gnu.org/archive/html/help-gnu-emacs/2015-04/msg00216.html).
 > > 
 > > What should one of these volunteers do to be useful?
 > 
 > One way of contributing to the documentation is to search the Emacs
 > bug tracker for bugs related to documentation, like errors or
 > inaccuracies in the manuals, and fix them.
 > 
 > Another way is to add documentation for new features in the repository
 > mentioned in NEWS without either a "+++" or "---" marker.
 > 
 > Yet another way is to read the discussions which indicate that some
 > piece of documentation needs to be improved, and do that.

Aye!

-- 
 /\           ___                                    Ubuntu: ancient
/___/\_|_|\_|__|___Gian Uberto Lauri_____               African word
  //--\| | \|  |   Integralista GNUslamico            meaning "I can
\/                 coltivatore diretto di software       not install
     già sistemista a tempo (altrui) perso...                Debian"

Warning: gnome-config-daemon considered more dangerous than GOTO

Re: Volunteering for Emacs documentation

[Daniel Pimentel]

On 2015-04-17 05:20, Gian Uberto Lauri wrote:
> Eli Zaretskii writes:
>  > > Date: Fri, 17 Apr 2015 09:15:01 +0200
>  > > From: "Gian Uberto Lauri" <saint@eng.it>
>  > >
>  > > There was a discussion on emacs-devel@gnu.org were it was said 
> that
>  > > volunteers were velcomed to work on Emacs manual and doc strings.
>  > > 
> (http://lists.gnu.org/archive/html/help-gnu-emacs/2015-04/msg00216.html).
>  > >
>  > > What should one of these volunteers do to be useful?
>  >
>  > One way of contributing to the documentation is to search the Emacs
>  > bug tracker for bugs related to documentation, like errors or
>  > inaccuracies in the manuals, and fix them.
>  >
>  > Another way is to add documentation for new features in the 
> repository
>  > mentioned in NEWS without either a "+++" or "---" marker.
>  >
>  > Yet another way is to read the discussions which indicate that some
>  > piece of documentation needs to be improved, and do that.
> 
> Aye!
I'd like to help it.

What's next step?

Thanks.
-- 
Daniel Pimentel (d4n1)

Re: Volunteering for Emacs documentation

[Eli Zaretskii]

> Date: Fri, 17 Apr 2015 08:07:09 -0300
> From: Daniel Pimentel <d4n1@openmailbox.org>
> Cc: Eli Zaretskii <eliz@gnu.org>, emacs-devel@gnu.org,
>  emacs-devel-bounces+d4n1=opmbx.org@gnu.org
> 
> I'd like to help it.
> 
> What's next step?

Submit patches to bug-gnu-emacs@gnu.org, I guess.  If you envision
doing this more than just a handful, I suggest to start your copyright
assignment paperwork, so that when your submissions exceed what we can
admit without an assignment, there will be no problem to accept more.

Thanks.

Re: Volunteering for Emacs documentation

[Thien-Thi Nguyen]

[-- Attachment #1: Type: text/plain, Size: 1076 bytes --]

() Eli Zaretskii <eliz@gnu.org>
() Fri, 17 Apr 2015 10:30:23 +0300

   Yet another way is to read the discussions which indicate
   that some piece of documentation needs to be improved, and do
   that.

Very true!  Don't forget that for many people, an important
piece of the document is its index.  IMHO improving a document's
index is qualitatively different enough to warrant mentioning as
a task on its own.  Bonus: it's easy to do and often does not
trigger copyright assignment hair at the onset...

(I have recently begun reading a lot of non-GNU documentation
and appreciate all the more Emacs' well-indexed manuals -- some
of the stuff i'm reading has no index at all!  [Insert grumbling
about blithe abdication of control to the panopticon here.])

-- 
Thien-Thi Nguyen -----------------------------------------------
  (if you're human and you know it) read my lisp:
    (defun responsep (type via)
      (case type
        (technical (eq 'mailing-list via))
        ...))
---------------------------------------------- GPG key: 4C807502

[-- Attachment #2: signature.asc --]
[-- Type: application/pgp-signature, Size: 197 bytes --]