emacs-orgmode@gnu.org archives
 help / color / mirror / code / Atom feed
* [wish] also provide documentation for contrib
@ 2012-10-07 17:01 Thomas Koch
  2012-10-07 18:06 ` cberry
  0 siblings, 1 reply; 6+ messages in thread
From: Thomas Koch @ 2012-10-07 17:01 UTC (permalink / raw)
  To: emacs-orgmode

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

^ permalink raw reply	[flat|nested] 6+ messages in thread

* Re: [wish] also provide documentation for contrib
  2012-10-07 17:01 [wish] also provide documentation for contrib Thomas Koch
@ 2012-10-07 18:06 ` cberry
  2012-10-12  9:03   ` Thomas Koch
  0 siblings, 1 reply; 6+ messages in thread
From: cberry @ 2012-10-07 18:06 UTC (permalink / raw)
  To: emacs-orgmode

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
>
>

^ permalink raw reply	[flat|nested] 6+ messages in thread

* Re: [wish] also provide documentation for contrib
  2012-10-07 18:06 ` cberry
@ 2012-10-12  9:03   ` Thomas Koch
  2012-10-18  8:11     ` Sébastien Delafond
  0 siblings, 1 reply; 6+ messages in thread
From: Thomas Koch @ 2012-10-12  9:03 UTC (permalink / raw)
  To: emacs-orgmode; +Cc: cberry

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

^ permalink raw reply	[flat|nested] 6+ messages in thread

* Re: [wish] also provide documentation for contrib
  2012-10-12  9:03   ` Thomas Koch
@ 2012-10-18  8:11     ` Sébastien Delafond
  2012-10-27  8:54       ` Bastien
  0 siblings, 1 reply; 6+ messages in thread
From: Sébastien Delafond @ 2012-10-18  8:11 UTC (permalink / raw)
  To: emacs-orgmode

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

^ permalink raw reply	[flat|nested] 6+ messages in thread

* Re: [wish] also provide documentation for contrib
  2012-10-18  8:11     ` Sébastien Delafond
@ 2012-10-27  8:54       ` Bastien
  2012-10-29 14:14         ` Sébastien Delafond
  0 siblings, 1 reply; 6+ messages in thread
From: Bastien @ 2012-10-27  8:54 UTC (permalink / raw)
  To: Sébastien Delafond; +Cc: emacs-orgmode

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

^ permalink raw reply	[flat|nested] 6+ messages in thread

* Re: [wish] also provide documentation for contrib
  2012-10-27  8:54       ` Bastien
@ 2012-10-29 14:14         ` Sébastien Delafond
  0 siblings, 0 replies; 6+ messages in thread
From: Sébastien Delafond @ 2012-10-29 14:14 UTC (permalink / raw)
  To: emacs-orgmode

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

^ permalink raw reply	[flat|nested] 6+ messages in thread

end of thread, other threads:[~2012-10-29 14:14 UTC | newest]

Thread overview: 6+ messages (download: mbox.gz / follow: Atom feed)
-- links below jump to the message on this page --
2012-10-07 17:01 [wish] also provide documentation for contrib Thomas Koch
2012-10-07 18:06 ` cberry
2012-10-12  9:03   ` Thomas Koch
2012-10-18  8:11     ` Sébastien Delafond
2012-10-27  8:54       ` Bastien
2012-10-29 14:14         ` Sébastien Delafond

Code repositories for project(s) associated with this public inbox

	https://git.savannah.gnu.org/cgit/emacs/org-mode.git

This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).