Bug#877337: www.debian.org: Switch back to single page version of Policy Manual

Package: www.debian.org
Severity: normal
Tags: patch

Hello www-team,

One of the improvements for which we switched Debian Policy to build
with Sphinx was the ability to output the Policy Manual as a single HTML
page.  Previously, it was only possible to output the Policy Manual as a
number of interlinked HTML pages.

We (the active Policy Team members) think that the single page version
is more suitable for Debian's web mirrors.  This is because it is more
useful for newcomers: with the single page version, it is possible to
use your browser's search function to search across the entire document.
More experienced users, who want the multi-page version, probably have
the debian-policy package installed locally.

When we uploaded Policy 4.1.0.0, this had the effect of switching the
version of the Policy Manual published on the web mirrors from
multi-page to single page.  But this was because we screwed up the
installed paths (see #872895).  With Policy 4.1.1.0, we've fixed the
paths, and so the version of the Policy Manual published on the web
mirrors has reverted to the multi-page version.

Please revert this, so the single page version is published on our web
mirrors.  Here is a patch (against [1]; unfortunately, I'm not in a
position to test it).  I'd appreciate it if this change could be made
quickly, to avoid URLs to the multi page version ending up in too many
mailing list posts/other documents.

    @@ -392,7 +392,8 @@ echo -n "Installing documents:"
     # Debian Policy Manual
     unpack debian-policy
     mvdocs debian-policy usr/share/doc/debian-policy NO en / policy
    -mvhtml_sphinx debian-policy usr/share/doc/debian-policy/policy.html NO en /
    +mvhtml_sphinx debian-policy usr/share/doc/debian-policy/policy-1.html NO en /
    +mv -f $webdocdir/debian-policy/policy-1.html $webdocdir/debian-policy/index.html
     
     mvdocs fhs usr/share/doc/debian-policy/fhs NO en packaging-manuals/ fhs-2.3
     mvhtml fhs usr/share/doc/debian-policy/fhs NO en packaging-manuals/ fhs-2.3

[1]  https://anonscm.debian.org/cgit/debwww/cron.git/tree/parts/7doc

-- 
Sean Whitton

From dcb0c69aa246e8076f79d6838cd7eec34d57b815 Mon Sep 17 00:00:00 2001
From: Sean Whitton <[email protected]>
Date: Sat, 30 Sep 2017 09:33:08 -0700
Subject: [PATCH] Publish single page version of Debian Policy Manual

---
 parts/7doc | 3 ++-
 1 file changed, 2 insertions(+), 1 deletion(-)

diff --git a/parts/7doc b/parts/7doc
index 4917094..8905599 100755
--- a/parts/7doc
+++ b/parts/7doc
@@ -392,7 +392,8 @@ echo -n "Installing documents:"
 # Debian Policy Manual
 unpack debian-policy
 mvdocs debian-policy usr/share/doc/debian-policy NO en / policy
-mvhtml_sphinx debian-policy usr/share/doc/debian-policy/policy.html NO en /
+mvhtml_sphinx debian-policy usr/share/doc/debian-policy/policy-1.html NO en /
+mv -f $webdocdir/debian-policy/policy-1.html $webdocdir/debian-policy/index.html
 
 mvdocs fhs usr/share/doc/debian-policy/fhs NO en packaging-manuals/ fhs-2.3
 mvhtml fhs usr/share/doc/debian-policy/fhs NO en packaging-manuals/ fhs-2.3
-- 
2.14.1

-----BEGIN PGP SIGNATURE-----

iQIzBAEBCgAdFiEEm5FwB64DDjbk/CSLaVt65L8GYkAFAlnPx2cACgkQaVt65L8G
YkCftg//S9OxkEpHZeSXv5ZaWIWl1oS2ltEjEPpLm8zMDgzbtQeTNnGHeTOBu01J
15VX9IC5AlEtG1NMVnbwGgAYd8C8qOTVM4otDdACndU2Y4M6zYLF4s9Z7IM2HUXY
MkBBeTTiHWMZlr7PypqVJr2hn3V5HoMs4Iosi4B84Bz55rOY7ElGBErA3tI5iXjb
hMwmig9QVHfklYsbvgFsUG3c7JcNYKn46uIebdBglurpdf/I8qJH0UNKJ86Wa4S9
zyLwXFxjojLMCHJeoKCh/9tMWaXBm/5UBbt4vnZZLT9VHrDLRgSUlaBCyHlin9Dw
d33FhRdGZ59ywTTq92Gi2j2bH4POuNckyS406dvC7TQlGL9/FW+fbTAf41+Y2W8P
FX4LDzKEonY+FGybCpaMR8zfT91vEHGwM6ghgdHtnx/9wTBfewVQ4s7UXcHJq7+k
Sz/2jKQZuI3Sfb7Qducck485aKFXXRrPb5ljDFZmS6ZyYLFKTbhA60yQ3SHheN+b
ZYjgQSzjmlOhK/niN4CQiCsfdhNvHBAwJr+UAR2TmXINq6YQFHWUMhebjSFtCZQF
GiGsvxprmP6u4cDSl3U9VzX1U1N+5SU3Ic2e9m0b+xNTbCHhDlFVQPP4ac0J1fsB
VIIGy93pP/le5a1k6FY5xJO9QzyprJ5xysSY6F+ihylCkTdMPOg=
=OwU0
-----END PGP SIGNATURE-----