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

Bug#639663: [debian-policy] Please provide upgrading-checklist via web



Le Sun, Sep 04, 2011 at 09:13:14AM +0200, Raphael Hertzog a écrit :
> 
> On Sat, 03 Sep 2011, Giovanni Mascellani wrote:
> > I though about this, but couldn't come up with any easy solution. I
> > mostly consider this tool to be useful for people who just have to check
> > the very last versions of the policy, so the problem is actually quite
> > mitigated.
> > 
> > I don't even think that old versions of the policy are available online.
> 
> Policy could start putting "id" attributes to sections linked from the
> upgrading checklist. Then those references will be more stable that plain
> section numbers.

Hello everybody,

the Policy actually has already ID attributes in some of its sections, for
instance 's-f-Architectureq for 5.6.8.  It would indeed be a good idea to add
IDs to other sections when we modify them.

For links from the PTS to the checklist, the easy part would be to also add IDs
in the checklist

Using IDs, like this:

  <sect id='3.9.3.0'> Version 3.9.3.0

The HTML document will have anchors like that:

  <h2><a name="s-3.9.3.0"></a>2.1 Version 3.9.3.0</h2>

They will be easy to preserve if the checklist migrates to DocBook.

Then, to serve on www.debian.org the HTML version that is currently in the
debian-policy binary package, a cron job has to be modified by the WWW team.

   http://anonscm.debian.org/gitweb/?p=debwww/cron.git;a=blob;f=parts/7doc;hb=HEAD

Having nice HTML links from the upgrade checklist to the Policy's section
numbers is more challenging, as it looks difficult to have links that would be
valid on both www.debian.org and the users local disks.

On users local disks:

  /usr/share/doc/debian-policy/policy.html/ch-*.html
  /usr/share/doc/debian-policy/upgrading-checklist.html/ch*.html
    or
  /usr/share/doc/debian-policy/upgrading-checklist-1.html

On www.debian.org:

  /doc/debian-policy/ch-*.html

This means we would need to install upgrading-checklist-1.html or
upgrading-checklist-1.html/ in /doc, or to make adjustments or hardcode to the
www.debian.org version.

Have a nice day,

-- 
Charles Plessy
Tsurumi, Kanagawa, Japan



Reply to: