Thread: Comment forms in interactive docs

Comment forms in interactive docs

From
Devrim GUNDUZ
Date:
Hi,

There are comments forms interactive docs. I think we should remove them.
Who follows the user comments in there? I'm sure, noone!

Even though there is a warning that they are not support forums, I'm
pretty sure that there are some ppl who will request for support -- and
won't get a support.

Comments?
--
Devrim GUNDUZ
devrim~gunduz.org                devrim.gunduz~linux.org.tr
             http://www.tdmsoft.com
             http://www.gunduz.org

Re: Comment forms in interactive docs

From
Tom Lane
Date:
Devrim GUNDUZ <devrim@gunduz.org> writes:
> There are comments forms interactive docs. I think we should remove them.
> Who follows the user comments in there? I'm sure, noone!

Actually, we've made a practice of scavenging for useful comments at
least once a release cycle.  There's a lot of crud in there, I agree,
but some good ideas about missing material too.  Anyway, what is your
idea of "interactive" docs if not ones that people can comment on?

> Even though there is a warning that they are not support forums, I'm
> pretty sure that there are some ppl who will request for support -- and
> won't get a support.

Yup, that happens.

            regards, tom lane

Re: Comment forms in interactive docs

From
"Marc G. Fournier"
Date:
On Thu, 2 Sep 2004, Tom Lane wrote:

> Devrim GUNDUZ <devrim@gunduz.org> writes:
>> There are comments forms interactive docs. I think we should remove them.
>> Who follows the user comments in there? I'm sure, noone!
>
> Actually, we've made a practice of scavenging for useful comments at
> least once a release cycle.  There's a lot of crud in there, I agree,
> but some good ideas about missing material too.  Anyway, what is your
> idea of "interactive" docs if not ones that people can comment on?

I know that I tend to make extensive use of the user 'comments' when I'm
looking at similar in the PHP docs ... you usually get some valuable
examples that the docs are seriously lacking ...

----
Marc G. Fournier           Hub.Org Networking Services (http://www.hub.org)
Email: scrappy@hub.org           Yahoo!: yscrappy              ICQ: 7615664

Re: Comment forms in interactive docs

From
Devrim GUNDUZ
Date:
-----BEGIN PGP SIGNED MESSAGE-----
Hash: SHA1


Hi,

On Fri, 3 Sep 2004, Robert Treat wrote:

>> Even though there is a warning that they are not support forums, I'm
>> pretty sure that there are some ppl who will request for support -- and
>> won't get a support.
>>
>> Comments?
>
> FWIW I believe we have some better tools for pruning the idocs in the new
> website code...

Agreed. Recalling Marc's comments on my e-mail: The docs page of PHP is
very attractive to a user : The page is colorful (:-) Yes, it's
attractive... )  and people can see many examples over there.

Look: http://tr2.php.net/manual/en/function.pg-connect.php (Hey Robert,
I've seen you there :) ) It's more than a pg_connect manual; one can learn
many things by reading that page...

...that's what we are lacking in our interactive docs.

Regards,
  --
Devrim GUNDUZ
devrim~gunduz.org                devrim.gunduz~linux.org.tr
             http://www.tdmsoft.com
             http://www.gunduz.org
-----BEGIN PGP SIGNATURE-----
Version: GnuPG v1.2.1 (GNU/Linux)

iD8DBQFBOAUetl86P3SPfQ4RAqDzAKDrT4zmmf5DdktPiMTN5ILShlHeSwCg3KTm
a1HpndIdoWawKh8zthF65m0=
=XIvn
-----END PGP SIGNATURE-----

Re: Comment forms in interactive docs

From
Devrim GUNDUZ
Date:
-----BEGIN PGP SIGNED MESSAGE-----
Hash: SHA1


Hi,

On Thu, 2 Sep 2004, Tom Lane wrote:

>> There are comments forms interactive docs. I think we should remove them.
>> Who follows the user comments in there? I'm sure, noone!
>
> Actually, we've made a practice of scavenging for useful comments at
> least once a release cycle.  There's a lot of crud in there, I agree,
> but some good ideas about missing material too.  Anyway, what is your
> idea of "interactive" docs if not ones that people can comment on?

IMHO, the difference between static and interactive docs 'should' be that
interactive one is searchable.

Anyway, I don't like forums, I prefer mailing lists but if we could set up
a forum, ppl who are not a member of MLs would be a member of it -- since
they would just read the messages they want.

Regards,
- --
Devrim GUNDUZ
devrim~gunduz.org                devrim.gunduz~linux.org.tr
             http://www.tdmsoft.com
             http://www.gunduz.org
-----BEGIN PGP SIGNATURE-----
Version: GnuPG v1.2.1 (GNU/Linux)

iD8DBQFBOALstl86P3SPfQ4RApNaAJ9UJUMRz7l05dneC9VjGlXiEeRtFACfSs2o
sQAd2ZFO0fjuyFW+RyUJwIg=
=GSqv
-----END PGP SIGNATURE-----

Re: Comment forms in interactive docs

From
Devrim GUNDUZ
Date:
-----BEGIN PGP SIGNED MESSAGE-----
Hash: SHA1


Hi,
On Thu, 2 Sep 2004, Marc G. Fournier wrote:

>> There are comments forms interactive docs. I think we should remove them.
>> Who follows the user comments in there? I'm sure, noone!
>
> I know that I tend to make extensive use of the user 'comments' when I'm
> looking at similar in the PHP docs ... you usually get some valuable examples
> that the docs are seriously lacking ...

I don't think(and see) that our interactive docs are the same as PHP docs:
PHP ones have more users. How many valuable examples have you seen in our
docs?

Not that much (oh, maybe no...)

- --
Devrim GUNDUZ
devrim~gunduz.org                devrim.gunduz~linux.org.tr
             http://www.tdmsoft.com
             http://www.gunduz.org
-----BEGIN PGP SIGNATURE-----
Version: GnuPG v1.2.1 (GNU/Linux)

iD8DBQFBOAOitl86P3SPfQ4RAvN4AKChguGiSKYTdEeoiN+z06nWFmCTggCfQAJO
rleT+sRonrsJygI/Cj+IkgY=
=LzwY
-----END PGP SIGNATURE-----

Re: Comment forms in interactive docs

From
Robert Treat
Date:
On Thursday 02 September 2004 18:17, Devrim GUNDUZ wrote:
> Hi,
>
> There are comments forms interactive docs. I think we should remove them.
> Who follows the user comments in there? I'm sure, noone!
>
> Even though there is a warning that they are not support forums, I'm
> pretty sure that there are some ppl who will request for support -- and
> won't get a support.
>
> Comments?

FWIW I believe we have some better tools for pruning the idocs in the new
website code...

--
Robert Treat
Build A Brighter Lamp :: Linux Apache {middleware} PostgreSQL

Re: Comment forms in interactive docs

From
"Dave Page"
Date:

> -----Original Message-----
> From: pgsql-www-owner@postgresql.org
> [mailto:pgsql-www-owner@postgresql.org] On Behalf Of Marc G. Fournier
> Sent: 03 September 2004 00:57
> To: Tom Lane
> Cc: Devrim GUNDUZ; PostgreSQL WWW Mailing List
> Subject: Re: [pgsql-www] Comment forms in interactive docs
>
> On Thu, 2 Sep 2004, Tom Lane wrote:
>
> > Devrim GUNDUZ <devrim@gunduz.org> writes:
> >> There are comments forms interactive docs. I think we
> should remove them.
> >> Who follows the user comments in there? I'm sure, noone!
> >
> > Actually, we've made a practice of scavenging for useful
> comments at
> > least once a release cycle.  There's a lot of crud in
> there, I agree,
> > but some good ideas about missing material too.  Anyway,
> what is your
> > idea of "interactive" docs if not ones that people can comment on?
>
> I know that I tend to make extensive use of the user
> 'comments' when I'm looking at similar in the PHP docs ...
> you usually get some valuable examples that the docs are
> seriously lacking ...

Very true, the php idocs are excellent. The question is, how do we
encourage submissions of the same quality, without all the 'Where can I
get pdf docs' and 'why doesn't my C program work' questions?

Regards, Dave.

Re: Comment forms in interactive docs

From
Robert Treat
Date:
On Friday 03 September 2004 03:18, Dave Page wrote:
> > -----Original Message-----
> > From: pgsql-www-owner@postgresql.org
> > [mailto:pgsql-www-owner@postgresql.org] On Behalf Of Marc G. Fournier
> > Sent: 03 September 2004 00:57
> > To: Tom Lane
> > Cc: Devrim GUNDUZ; PostgreSQL WWW Mailing List
> > Subject: Re: [pgsql-www] Comment forms in interactive docs
> >
> > On Thu, 2 Sep 2004, Tom Lane wrote:
> > > Devrim GUNDUZ <devrim@gunduz.org> writes:
> > >> There are comments forms interactive docs. I think we
> >
> > should remove them.
> >
> > >> Who follows the user comments in there? I'm sure, noone!
> > >
> > > Actually, we've made a practice of scavenging for useful
> >
> > comments at
> >
> > > least once a release cycle.  There's a lot of crud in
> >
> > there, I agree,
> >
> > > but some good ideas about missing material too.  Anyway,
> >
> > what is your
> >
> > > idea of "interactive" docs if not ones that people can comment on?
> >
> > I know that I tend to make extensive use of the user
> > 'comments' when I'm looking at similar in the PHP docs ...
> > you usually get some valuable examples that the docs are
> > seriously lacking ...
>
> Very true, the php idocs are excellent. The question is, how do we
> encourage submissions of the same quality, without all the 'Where can I
> get pdf docs' and 'why doesn't my C program work' questions?
>

I believe one significant difference is the php doc submissions are moderated,
and therefore subject to less cruft.  I've suggested in the past that doc
submissions get posted to -www or -doc, but neither group seemed interested
in supporting that.

--
Robert Treat
Build A Brighter Lamp :: Linux Apache {middleware} PostgreSQL

Re: Comment forms in interactive docs

From
"Dave Page"
Date:

> -----Original Message-----
> From: Robert Treat [mailto:xzilla@users.sourceforge.net]
> Sent: 05 September 2004 03:33
> To: Dave Page
> Cc: Marc G. Fournier; Tom Lane; Devrim GUNDUZ; PostgreSQL WWW
> Mailing List
> Subject: Re: [pgsql-www] Comment forms in interactive docs
>
>
> I believe one significant difference is the php doc
> submissions are moderated, and therefore subject to less
> cruft.  I've suggested in the past that doc submissions get
> posted to -www or -doc, but neither group seemed interested
> in supporting that.

It's not so much that I'm not interested in it, more that I have enough
to do already. If someone wants to volunteer to be moderator, I for one
am happy for the code to be appropriately modified.

/D