Hi, CCing debian-www since we may be of little help here, but not tagging the bug as “affects www.debian.org” yet, since Russ first proposal doesn't need anything on our side. Le 25/12/2011 13:58, Russ Allbery a écrit : > Charles Plessy <plessy@debian.org> writes: >> 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. > > My first inclination would be to change the debian-policy package to stop > generating the broken-down version of the upgrading-checklist that has > multiple HTML files (there doesn't seem to be much point for that > document), generate the one-page HTML version as just > upgrading-checklist.html, and put it into the debian-policy.html directory > instead of at the top level. Then, the links to Policy can just be to the > individual ch-*.html files and are relative within a directory, which will > make them work on both www.debian.org and on local disk. > > The drawback to this, though, is that upgrading-checklist links to other > policies then don't work or are quite a bit harder. On the website, the Policy [1] and other Policy related documents [2] are indeed shipped in unrelated places. If upgrading-checklist is not yet with the other documents [2], I guess it's because it's quite new, and nobody took care yet to handle it yet, but since the way it is shipped may change soon, I didn't change this behavior right now. > We could rename the directory structure in debian-policy to match > www.debian.org, Please coordinate with us if you go that way, since we'll need to change the build process to include those documents (well, at worst, the website will provide an outdated version of the documents until someone notices and fixes this, but if we can make that time as short as possible, the better). > but /usr/share/doc/debian-policy/debian-policy looks > rather weird. Another option would be to change the way documents are provided on the website, but even if we can handle moved documents with HTML redirect, I don't know if it would be a good idea to change the current URL [1] for the Policy, nor that it would be a good idea to have multiple directories in http://www.debian.org/doc/ (on the contrary, we recently removed the old symlinks hacks in favor of Redirect to handle shipped documents in their canonical places, i.e manuals [3] and packaging-manuals [2], the only remaining exception being the debian-policy [1]). 1: http://www.debian.org/doc/debian-policy/ 2: http://www.debian.org/doc/packaging-manuals/ 3: http://www.debian.org/doc/manuals Regards David
Attachment:
signature.asc
Description: OpenPGP digital signature