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

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



Hello

El 04/10/17 a las 05:50, Paul Wise escribió:
> On Wed, Oct 4, 2017 at 11:41 AM, Sean Whitton wrote:
> 
>> - installing the policy.html/ dir as https://www.debian.org/doc/debian-policy/;
>> - copying policy-1.html into that dir; and
>> - telling Apache to serve policy-1.html as the directory index?
> 
> Correct.
> 
>> I'm a little worried people could be very confused (why is
>> debian-policy/index.html different from debian-policy/?!  is there some
>> cache refresh needed somewhere?) but I don't object.
> 
> Hmm, I'm not sure what to do about that.

My proposal is to clarify, at the top of the document, what the user gets, and
where are the other formats. In particular, add this paragraph (or something
similar) right after "This is Debian Policy version 4.1.2.0, released on
2017-11-30.":

---
This is Debian Policy version 4.1.2.0, released on 2017-11-30.

This document is also available from the Debian web mirrors at
https://www.debian.org/doc/debian-policy/ in several formats:
* single page HTML (at [policy-1.html],
https://www.debian.org/doc/debian-policy/ redirects to this),
* HTML splitted in chapters
([https://www.debian.org/doc/debian-policy/index.html]),
* electronic book ([policy.epub]) and printable format ([policy.pdf]),
* plain text (without section numbering) ([policy.txt]).
---

and then change the "New versions of this document" to the following:

----
New versions of this document

This manual is distributed via the Debian package debian-policy.

Policy changes between versions of this document are described in the [Upgrading
checklist](relative_link) which is also available as a standalone copy in the
debian-policy package and the [corresponding chapter in HTML
version](https://www.debian.org/doc/debian-policy/document-upgrading-checklist).
----

If this proposal is accepted, I'm happy to provide patches against debian-policy
to implement this. In the website version we would include both the single html
and the splitted in chapters html, and then, also fix the bug #877367
(www.debian.org: Please consider adding redirects for old Policy
chapters/appendices) without the need of adding redirects.

What do you think?

Cheers
-- 
Laura Arjona Reina
https://wiki.debian.org/LauraArjona


Reply to: