Re: wiki.debian.org/doc/packagename/readme.debian ?
On Tue, 2008-05-06 at 23:47 -0500, Lukasz Szybalski wrote:
> >
> >
> > > > However, if DD were interested in maintaining that file on the wiki (which
> > > > is probably what you have in mind), I would find it very suitable.
> > > > Of course, only the packages actually updating the README from the wiki
> > > > should be published on the wiki.
> > >
> > > I'm not sure what would need to happen process wise to enable
> > > Developers to use wiki page to collaborate their readme and
> > > readme.debian.
> >
> > Making DD's life easier would unsure quick adoption. May be :
> > - A set of scripts for the DD to retrieve and update the wiki page.
> > (that might later be included in debhelper)
>
> Making a download script wouldn't be hard. Upload on the other hand
> would have to somehow be automated triggered by some event. Update
> script needs access to the wiki files. aka needs to be run from the
> same server. How would I get access to wiki server if one wanted to
> implement this?
>
> What could that event be? New version?
You should bring this question (and the whole proposal) to debian-devel.
> > - A page with some guidelines for contributors.
> > - Provide a good template (actually, a wiki-page header, with link to
> > package page, )
>
> Do you have a link of example wiki page header I could use?
I've quickly made a sample page :
http://wiki.debian.org/pkg/README.DebianTemplate
> > - RFC and Announce it on debian-devel ml.
> >
> >
> > > We could definitely upload and download it.
> > I'm not sure what you mean... i guess "we"= "the DD"
> >
> >
> > My major concern is that such pages would have to be maintained : In two
> > years time, we would have a problem of knowing what to do with the
> > pages.
> > If the page have been modified (and we hope they would), what should we
> > do about it ? How could we know that the package have been updated by
> > the maintainer ?
>
> How is the package released? If new package has a new release
> number/version number we could track the new package and know to
> upload the readme file. If I somehow would be able to tell there is a
> new version I can overwrite the wiki page.
We need to make sure that the package maintainer has updated the package
README.Debian before overwriting the wiki page.
However the maintainer will probably want to adjust the README's
suggested improvements... so you can't just compare the contents.
The solution is probably to get the maintainer to update the wiki page
when he/she update the package (by using some script so he/she doesn't
actually have to visit wiki.debian.org manually)
> > Should we update the wiki-page with the latest DD's README.Debian ?
> >
> >
> > > > What about URIs like this ?
> > > > http://wiki.debian.org/pkg/ant/README.Debian
> > >
> > > I'll modify the script to make it so.
> > > How things change from stable to testing?, maybe
> > > http://wiki.debian.org/etch/pkg/ant/README.Debian or
> > > http://wiki.debian.org/stable/pkg/ant/README.Debian ?
> >
> > The page should be for development (i.e "unstable") only since
> > DebianStable package is unlikely to be updated for a mere README update.
>
> Good point. In that case I would upload stable/testing with readonly
> access
see Kevin's post. (package.debian.org is more suitable for publishing
existing static files)
> and ustable would be the one people could modify, allow
> somekind of suggestions.
> In that case:
>
> http://wiki.debian.org/sid/pkg/ant/README.Debian
> or
> http://wiki.debian.org/sid/ant/README.Debian
The wiki-page's name doesn't have to contain the word "sid". It can just
be mentioned in the page header.
A page name like http://wiki.debian.org/pkg/ant/README.Debian would
actually initialize a standard page naming scheme for wiki page related
to a specific package : http://wiki.debian.org/pkg/ant
> As far as bugs that Kevin Mentioned. All of them talk either about
> readme, readme.debian or changelog,news, todo files. We could
> definitely include these files on a wiki, and link to them from
> packages.debina.org but take the readme to next level.
Those must not be updated on the wiki:
- changelog, readme, news and todo are upstream developer files
- NEWS.Debian is probably too "static" to be useful. regular bugs
would do.
Franklin
Reply to: