Re: feedback address as a separate doc?



This sounds like a great idea to me.

A few boring details:
1) Let's have "gnome" in the file name and hence the URL
(eg. gnome-feedback.sgml), since we want to preserve the ability to be
compatible with KDE in documentation.
2) Let's put the document in gnome-core/core-docs.
3) Are you volunteering to update the templates?

This document can provide a lot more details about submitting bugs reports
than the previous blurb.

Note there are a couple potential issues, but that didn't stop us before:

1) We have to use the "ghelp:" URI scheme instead of "gnome-help:" if we
want to be compatible with gnome-help-browser.  I believe the choice of
"gnome-help:" over "ghelp" was a matter of name-space issues, but breaks
backward compatibility. We are already using "gnome-help:" in other
places.  The proper solution would be to have gnome-help-browser handle
the "gnome-help:" scheme.

2) This creates an implicit dependency between a given package and
gnome-core or else the link will break.  We are already doing this too,
trusting that users will have gnome-core and that it will be a
sufficiently recent release to include the document.

Dan


On Wed, 28 Mar 2001, Alexander Kirillov wrote:

> 
> Hi guys:
> 
> faced with the prospect of changing the old bug submission
> instructions (referring to bugs.gnome.org) to the new ones
> (bugzilla.gnome.org) in ~170 files I think it is time to return to the
> suggestion which was discussed here some time ago - namely, that  we
> make a separate "feedback" document and have all docs  just link
> to it, e.g. 
> 
> 
> -------
>  <sect1 id="authors">
>   <title>Authors</title>
>   <para>
> 
>    <application>Gnome Control Center</application> was written by
>      Jonathan Blandford (<email>jrb redhat com</email>). This manual
>      was written by Dave Mason (<email>dcm redhat com</email>) and
>      Alexander Kirillov (<email>kirillov math sunysb edu</email>) with
>      some help from other members of Gnome Documentation
>      Project. Please send us commments,  bug reports and suggestions;
>      instructions for doing so can be found  <ulink type="help"
>      url="gnome-help:feedback">here</ulink>.
>  </para>
>  </sect1>
> -------
> 
> Not only it makes docs easier to update when some URLs change (I hope they
> do not change all that often), but it also makes life easier for
> distributors/vendors who may want to replace this with their own
> feedback channels - this point was raised by Sun people some time ago
> (I still think it is a good idea to discuss it with original
> developers first, but it is just my personal opinion). 
> 
> This suggestion was already discussed before but not implemented
> because 
> a) we (and I personally)  are lazy
> b) we only recently got reliable cross-linking between docs.
> 
> Comments?
> 
> Sasha
> 
> _______________________________________________
> gnome-doc-list mailing list
> gnome-doc-list gnome org
> http://mail.gnome.org/mailman/listinfo/gnome-doc-list
> 





[Date Prev][Date Next]   [Thread Prev][Thread Next]   [Thread Index] [Date Index] [Author Index]