Please provide at least one page for your ocaml projects

Please provide at least one page for your ocaml projects

[Maxence Guesdon]

Hello,

For those who don't know, I'm the maintainer of the Caml Hump.

For this reason, I have a look at every project announced on the caml-list
and it seems to me that there are more and more projects providing only
links to tarballs or git repositories.

I think these projects would take advantage of having at least one web page
giving all basic information: description, status, license, author(d),
download links.

Indeed, having to look for this information in a tarball of a git repos
(with gitweb) is not very convenient. Even the project page on a forge is
not the best way to get the information quickly. It's more a view for a
developer/contributor, not for a potential user.

Even if this main web page should point to the developer ressources
(repository, forge project, ...), the main access to the project should
be a web page with hand-written text, even a simple one.

Regards,

-- 
Maxence Guesdon

Re: Please provide at least one page for your ocaml projects

[Sylvain Le Gall]

Hello,

On 25-08-2010, Maxence Guesdon <Maxence.Guesdon@inria.fr> wrote:
>
> For this reason, I have a look at every project announced on the caml-list
> and it seems to me that there are more and more projects providing only
> links to tarballs or git repositories.
>
> I think these projects would take advantage of having at least one web page
> giving all basic information: description, status, license, author(d),
> download links.
>

I am working on OASIS and OASIS-DB. The latter aims to translate _oasis
file into simple web pages (including markdown translation).

Have a look at:
http://oasis.ocamlcore.org/dev/browse?ver=0.2.0~alpha1&pkg=oasis

This web page has been translated from:
http://darcs.ocamlcore.org/cgi-bin/darcsweb.cgi?r=oasis;a=headblob;f=/_oasis

(this package is pretty complex, so there is a lot a library/exec/tests
but what is translated is basically Synopsis + Description).

If you add an _oasis file to your project and upload it to
oasis.ocamlcore.org it will generate this kind of pages.

Maxence, does it fit your requirement?

(the project is still at an early stage, but the upload is working)

> Indeed, having to look for this information in a tarball of a git repos
> (with gitweb) is not very convenient. Even the project page on a forge is
> not the best way to get the information quickly. It's more a view for a
> developer/contributor, not for a potential user.
>

Every project on forge.ocamlcore.org can upload a simple webpage and it
will be displayed on http://PROJECT.forge.ocamlcore.org. Just add html
files to /home/groups/PROJECT/htdocs on ssh.ocamlcore.org, same ssh key
as git/darcs/svn login. You can use rsync, scp or unison.

Feel free to contact me if you need further utilities for your project.

Regards,
Sylvain Le Gall

Re: Please provide at least one page for your ocaml projects

[Sylvain Le Gall]

On 25-08-2010, Sylvain Le Gall <sylvain@le-gall.net> wrote:
> On 25-08-2010, Maxence Guesdon <Maxence.Guesdon@inria.fr> wrote:
>>
>> Indeed, having to look for this information in a tarball of a git repos
>> (with gitweb) is not very convenient. Even the project page on a forge is
>> not the best way to get the information quickly. It's more a view for a
>> developer/contributor, not for a potential user.
>>
>
> Every project on forge.ocamlcore.org can upload a simple webpage and it
> will be displayed on http://PROJECT.forge.ocamlcore.org. Just add html
> files to /home/groups/PROJECT/htdocs on ssh.ocamlcore.org, same ssh key
> as git/darcs/svn login. You can use rsync, scp or unison.
>
> Feel free to contact me if you need further utilities for your project.
>

Examples of web pages:
http://oasis.forge.ocamlcore.org/
http://ocaml-lua.forge.ocamlcore.org/
http://ounit.forge.ocamlcore.org/
http://pa-do.forge.ocamlcore.org/
http://ocamlviz.forge.ocamlcore.org/
http://cmdline-args.forge.ocamlcore.org/
http://camlbz2.forge.ocamlcore.org/
http://ocaml-autoconf.forge.ocamlcore.org/

If you lack inspiration, just copy/adapt these webpages. They are all
accessible on /home/groups/PROJECT/htdocs/.

Regards,
Sylvain Le Gall

Re: [Caml-list] Re: Please provide at least one page for your ocaml projects

[Maxence Guesdon]

On Wed, 25 Aug 2010 15:46:08 +0000 (UTC)
Sylvain Le Gall <sylvain@le-gall.net> wrote:

> Hello,
> 
> On 25-08-2010, Maxence Guesdon <Maxence.Guesdon@inria.fr> wrote:
> >
> > For this reason, I have a look at every project announced on the caml-list
> > and it seems to me that there are more and more projects providing only
> > links to tarballs or git repositories.
> >
> > I think these projects would take advantage of having at least one web page
> > giving all basic information: description, status, license, author(d),
> > download links.
> >
> 
> I am working on OASIS and OASIS-DB. The latter aims to translate _oasis
> file into simple web pages (including markdown translation).
> 
> Have a look at:
> http://oasis.ocamlcore.org/dev/browse?ver=0.2.0~alpha1&pkg=oasis
> 
> This web page has been translated from:
> http://darcs.ocamlcore.org/cgi-bin/darcsweb.cgi?r=oasis;a=headblob;f=/_oasis
> 
> (this package is pretty complex, so there is a lot a library/exec/tests
> but what is translated is basically Synopsis + Description).
> 
> If you add an _oasis file to your project and upload it to
> oasis.ocamlcore.org it will generate this kind of pages.
> 
> Maxence, does it fit your requirement?

The page at your first url seems to contain the minimal information, indeed.

-- 
Maxence Guesdon

Re: [Caml-list] Please provide at least one page for your ocaml projects

[David MENTRE]

Hello,

2010/8/25 Maxence Guesdon <Maxence.Guesdon@inria.fr>:
> I think these projects would take advantage of having at least one web page
> giving all basic information: description, status, license, author(d),
> download links.

As a simple OCaml user, I agree with Maxence. If an announcement is
not provided without those minimal information, I skip it. Available
time is so constrained.

Sylvain, your OASIS project and the generated web page is very
interesting in that regard.

Regards,
david

Re: [Caml-list] Please provide at least one page for your ocaml projects

[Grant Rettke]

On Thu, Aug 26, 2010 at 2:18 AM, David MENTRE <dmentre@linux-france.org> wrote:
> Sylvain, your OASIS project and the generated web page is very
> interesting in that regard.

OASIS looks *very* nice.

Re: [Caml-list] Please provide at least one page for your ocaml projects

[Florent Monnier]

Le mercredi 25 août 2010 11:26:05, Maxence Guesdon a écrit :
> Hello,
> 
> For those who don't know, I'm the maintainer of the Caml Hump.
> 
> For this reason, I have a look at every project announced on the caml-list
> and it seems to me that there are more and more projects providing only
> links to tarballs or git repositories.
> 
> I think these projects would take advantage of having at least one web page
> giving all basic information: description, status, license, author(d),
> download links.
> 
> Indeed, having to look for this information in a tarball of a git repos
> (with gitweb) is not very convenient. Even the project page on a forge is
> not the best way to get the information quickly. It's more a view for a
> developer/contributor, not for a potential user.
> 
> Even if this main web page should point to the developer ressources
> (repository, forge project, ...), the main access to the project should
> be a web page with hand-written text, even a simple one.
> 
> Regards,

I would say that when packagers write patches that add new features it would 
be nice if they set up such a basic web-page too.

-- 
Regards
Florent

Re: [Caml-list] Please provide at least one page for your ocaml projects

[Mehdi Dogguy]

On 08/26/2010 10:10 PM, Florent Monnier wrote:
> 
> I would say that when packagers write patches that add new features it would 
> be nice if they set up such a basic web-page too.
> 

FWIW, in Debian, we have:

	http://patch-tracker.debian.org/

which lists and shows applied patches to any Debian package.

Regards,

-- 
Mehdi Dogguy مهدي الدڤي
http://www.pps.jussieu.fr/~dogguy
Tel.: (+33).1.44.27.28.38

Re: [Caml-list] Please provide at least one page for your ocaml projects

[Florent Monnier]

Le vendredi 27 août 2010 12:29:40, vous avez écrit :
> On 08/26/2010 10:10 PM, Florent Monnier wrote:
> > I would say that when packagers write patches that add new features it
> > would be nice if they set up such a basic web-page too.
> 
> FWIW, in Debian, we have:
> 
> 	http://patch-tracker.debian.org/
> 
> which lists and shows applied patches to any Debian package.

I don't see any way to display the added features
I don't see any description either

it is only a basic listing

-- 
Regards
Florent

Re: [Caml-list] Please provide at least one page for your ocaml projects

[Mehdi Dogguy]

On 08/28/2010 12:43 PM, Florent Monnier wrote:
> Le vendredi 27 août 2010 12:29:40, vous avez écrit :
>> On 08/26/2010 10:10 PM, Florent Monnier wrote:
>>> I would say that when packagers write patches that add new 
>>> features it would be nice if they set up such a basic web-page 
>>> too.
>> 
>> FWIW, in Debian, we have:
>> 
>> http://patch-tracker.debian.org/
>> 
>> which lists and shows applied patches to any Debian package.
> 
> I don't see any way to display the added features. I don't see any 
> description either
> 
> it is only a basic listing
> 

Well, we really don't need more than that. Distributed packages aren't
supposed to be a forked version of the original one. We write patches to
fix problems. Some of the written patches introduce minor features (in
which case, it should be very easy to understand by simply looking at
the patch). But, that's all… If you want more than that (detailed
descriptions of each patch), it's not going to happen because it's a lot
of work. Besides, we try to send to our upstreams each written patch…
So, in an ideal world, those patches are there only for a limited amount
of time.

Regards,

-- 
Mehdi Dogguy مهدي الدڤي
http://www.pps.jussieu.fr/~dogguy
Tel.: (+33).1.44.27.28.38

Re: [Caml-list] Please provide at least one page for your ocaml projects

[bluestorm]

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

On Sat, Aug 28, 2010 at 12:43 PM, Florent Monnier <monnier.florent@gmail.com
> wrote:

> > FWIW, in Debian, we have:
> >
> >       http://patch-tracker.debian.org/
> >
> > which lists and shows applied patches to any Debian package.
>
> I don't see any way to display the added features
> I don't see any description either
>
> it is only a basic listing
>

Well, there is a (concise) description of patches. For example, from
http://patch-tracker.debian.org/package/ocaml/3.11.2-1 (the list of patches
for the 3.11.2 version), if you click on the "View" link of one of those
patches, you'll get the patch and possibly a description. For example, with
http://patch-tracker.debian.org/patch/series/view/ocaml/3.11.2-1/0002-Call-ld-with-proper-flags.patch
 :

> Filter linkflags passed to ld by ocamlopt -pack and -output-obj
> to remove the "-Wl," parts, which are only used when ocamlopt calls
> gcc.

[-- Attachment #2: Type: text/html, Size: 1556 bytes --]

Re: [Caml-list] Please provide at least one page for your ocaml projects

[Mehdi Dogguy]

On 08/28/2010 12:56 PM, Mehdi Dogguy wrote:
> 
> If you want more than that (detailed descriptions of each patch), 
> it's not going to happen because it's a lot of work.
> 

Hrm… I forgot about one point: Actually, some of it is going to happen :)

There is an ongoing DEP (Debian Enhancement Proposals) named "Patch
Tagging Guidelines" [1]. It's a proposal about how we should document a
patch. And, as Gabriel pointed out, each patch can have a comment
to describe what it is about. But, some patches don't include this
information.

[1] http://dep.debian.net/deps/dep3/

Regards,

-- 
Mehdi Dogguy مهدي الدڤي
http://www.pps.jussieu.fr/~dogguy
Tel.: (+33).1.44.27.28.38

Re: [Caml-list] Please provide at least one page for your ocaml projects

[Florent Monnier]

Le vendredi 27 août 2010 12:29:40, vous avez écrit :
> On 08/26/2010 10:10 PM, Florent Monnier wrote:
> > I would say that when packagers write patches that add new features it
> > would be nice if they set up such a basic web-page too.
> 
> FWIW, in Debian, we have:
> 
> 	http://patch-tracker.debian.org/
> 
> which lists and shows applied patches to any Debian package.

ha yes indeed sorry!

but one question, I see now on this page that there this related link
  http://packages.debian.org/lenny/advi
but not one this one:
  http://packages.debian.org/sid/advi
why?
(indeed when I watch at package information I watch at sid)

-- 
Regards
Florent

Re: [Caml-list] Please provide at least one page for your ocaml projects

[Florent Monnier]

Le samedi 28 août 2010 13:06:45, vous avez écrit :
> On 08/28/2010 12:56 PM, Mehdi Dogguy wrote:
> > If you want more than that (detailed descriptions of each patch),
> > it's not going to happen because it's a lot of work.
> 
> Hrm… I forgot about one point: Actually, some of it is going to happen :)

So I guess this was a legitimate / justified claim :)

I hope there will be some categories like
- added features
- build fix
- bug fix

-- 
Regards
Florent

Re: [Caml-list] Please provide at least one page for your ocaml projects

[Mehdi Dogguy]

On 08/28/2010 01:58 PM, Florent Monnier wrote:
> Le vendredi 27 août 2010 12:29:40, vous avez écrit :
>> On 08/26/2010 10:10 PM, Florent Monnier wrote:
>>> I would say that when packagers write patches that add new features it
>>> would be nice if they set up such a basic web-page too.
>>
>> FWIW, in Debian, we have:
>>
>> 	http://patch-tracker.debian.org/
>>
>> which lists and shows applied patches to any Debian package.
> 
> ha yes indeed sorry!
> 
> but one question, I see now on this page that there this related link
>   http://packages.debian.org/lenny/advi
> but not one this one:
>   http://packages.debian.org/sid/advi
> why?

That's called a "bug" :)

-- 
Mehdi Dogguy مهدي الدڤي
http://www.pps.jussieu.fr/~dogguy
Tel.: (+33).1.44.27.28.38