[wish] also provide documentation for contrib

[wish] also provide documentation for contrib

[Thomas Koch]

Hi,

I was about to fill a bug about debians org-mode package because it does not 
come with documentation for the org-mode contrib org-drill. However I believe 
that this issue should rather be raised to you as the upstream.

I'd like to encourage you to consider any org-mode contrib in your 
distribution without accompanying documentation a bug. I don't know enough 
about the info system or your build system so I'll refrain from any 
suggestion.

Thank you,

Thomas Koch, http://www.koch.ro

Re: [wish] also provide documentation for contrib

[cberry]

Thomas Koch <thomas@koch.ro> writes:

> Hi,
>
> I was about to fill a bug about debians org-mode package because it does not 
> come with documentation for the org-mode contrib org-drill. However I believe 
> that this issue should rather be raised to you as the upstream.
>

,----[from contrib/README]
| These contributions are not part of GNU Emacs or of the official
| Org-mode package.  But the git repository for Org-mode is glad to
| provide useful way to distribute and develop them as long as they are
| distributed under a free software license.
`----

Maybe

        http://orgmode.org/worg/org-contrib/org-drill.html

is what you need?

HTH,

Chuck

> I'd like to encourage you to consider any org-mode contrib in your 
> distribution without accompanying documentation a bug. I don't know enough 
> about the info system or your build system so I'll refrain from any 
> suggestion.
>
> Thank you,
>
> Thomas Koch, http://www.koch.ro
>
>

Re: [wish] also provide documentation for contrib

[Thomas Koch]

cberry@tajo.ucsd.edu:
> ,----[from contrib/README]
> 
> | These contributions are not part of GNU Emacs or of the official
> | Org-mode package.  But the git repository for Org-mode is glad to
> | provide useful way to distribute and develop them as long as they are
> | distributed under a free software license.
> 
> Maybe
>          http://orgmode.org/worg/org-contrib/org-drill.html 
> is what you need?

Hi Chuck,

I know that org-drill has its own webpage with good documentation. The point 
is, that the Debian maintainer (or Fedora, Gentoo, ...) just takes the org-
mode tarball and packages everything found in there. It would be an extra 
burden for the maintainer to go out to every single contrib site and somehow 
add the documentation in the package.

It would be much easier IMHO, if the org-mode developers would not only 
distribute the code of contribs but also their documentation. I would even say 
that distributing code without documentation is kind of a bug.

It would even be an extra advantage, if you could encourage the contrib 
developers to provide documentation in info format.

Best regards,

Thomas Koch, http://www.koch.ro

Re: [wish] also provide documentation for contrib

[Sébastien Delafond]

On 2012-10-12, Thomas Koch <thomas@koch.ro> wrote:
> I know that org-drill has its own webpage with good
> documentation. The point is, that the Debian maintainer (or Fedora,
> Gentoo, ...) just takes the org- mode tarball and packages
> everything found in there. It would be an extra burden for the
> maintainer to go out to every single contrib site and somehow add
> the documentation in the package.
>
> It would be much easier IMHO, if the org-mode developers would not
> only distribute the code of contribs but also their documentation. I
> would even say that distributing code without documentation is kind
> of a bug.
>
> It would even be an extra advantage, if you could encourage the
> contrib developers to provide documentation in info format.

As the Debian maintainer for org-mode, I cannot agree more with
Thomas: since contrib is *distributed* in the regular org-mode
tarball, its documentation should be found in there as well.

Cheers,

--SD

Re: [wish] also provide documentation for contrib

[Bastien]

Hi Sébastien and Thomas,

Sébastien Delafond <sdelafond@gmail.com> writes:

> As the Debian maintainer for org-mode, I cannot agree more with
> Thomas: since contrib is *distributed* in the regular org-mode
> tarball, its documentation should be found in there as well.

I agree.  Let's start by patching README_contribute with a new
section containing short documentation for contributions.

Can you help about this?

Thanks,

-- 
 Bastien

Re: [wish] also provide documentation for contrib

[Sébastien Delafond]

On 2012-10-27, Bastien <bzg@altern.org> wrote:
> I agree.  Let's start by patching README_contribute with a new
> section containing short documentation for contributions.

Hi Bastien,

I unfortunately have very little time these days to take on this task
:\ Hopefully this will change in the not-too-distant future...

Cordialement,

--SD