Gentoo Archives: gentoo-doc

From: "Jan Kundrát" <jkt@g.o>
To: gentoo-doc@l.g.o
Subject: Re: [gentoo-doc] [RFC] Marking unmaintained documents
Date: Thu, 08 Sep 2005 17:37:29
Message-Id: 43207688.2040801@gentoo.org
In Reply to: Re: [gentoo-doc] [RFC] Marking unmaintained documents by Xavier Neys
1 Xavier Neys wrote:
2 >> a) "This article is not part of the official Gentoo documentation, it
3 >> has been republished on our site only for your convenience and with
4 >> permisson of the respective copyright owner. It may not reflect current
5 >> state of things and could be outdated."
6 >
7 > No need to hack the xsl for that, just add it at the beginning of each
8 > article like we already have the note about owners.
9
10 This implies manual changing of several files which is not good, IMHO.
11
12 >> b) "This Handbook is no longer maintained and is left here only for your
13 >> convenience, please don't bother with submitting bugreports. In case you
14 >> are looking for networkless installation instructions, please consult
15 >> <link>current handbook</link>."
16 >> c) "This language is not backed up by an official Translation Team and
17 >> might be outdated or even incorrect. In doubts please consult
18 >> [link]original document[/link]."
19 >
20 >
21 > Can only be done with a reliable document location made available to the
22 > xsl which we lack at the moment.
23 >
24 > I wish we could but at the moment, we can't really
25
26 Well, I think that fixing <guide path="..."> that does'nt contain
27 directory name is easier than adding some disclaimer to every file and
28 could be done by a script (haven't tried, though). And it wouldn't
29 matter if we didn't catch every outdated/unmaintained/... document, but
30 at least some of them will be marked.
31
32 So, is there any problem to check the value of the path attribute
33 (provided it includes the directory name) against some regexp and if it
34 matches, add some warning to the generated page?
35
36 Maybe also introduce another parameter to metadoc saying "this
37 translation is outdated", but I'm not sure if this is worth the effort.
38
39 Cheers,
40 -jkt
41
42 --
43 cd /local/pub && more beer > /dev/mouth

Attachments

File name MIME type
signature.asc application/pgp-signature

Replies

Subject Author
Re: [gentoo-doc] [RFC] Marking unmaintained documents Xavier Neys <neysx@g.o>