From: "Jan Kundrát" <jkt@gentoo.org>
To: gentoo-doc@lists.gentoo.org
Subject: Re: [gentoo-doc] Re: [RFC] Marking unmaintained documents
Date: Fri, 16 Sep 2005 15:01:04 +0200 [thread overview]
Message-ID: <432AC210.5020400@gentoo.org> (raw)
In-Reply-To: <loom.20050915T135454-193@post.gmane.org>
[-- Attachment #1: Type: text/plain, Size: 2073 bytes --]
Xavier Neys wrote:
> Of course, users reading a 2004.3 handbook should realise it's old, but they
> could at least be told it's not maintained anymore so that 1) they can read it
> with a grain of salt 2) they should not bother submitting bugs.
IMHO that's against what SwifT said about fixing?
> Dumping the text in the doc itself is not a great idea as it will lead to
> cut'n'paste errors and lose consistency. Besides, scripts could not distinguish
> normal content from such disclaimers.
Yep.
> Another way would have been to list the outdated/unmaintained docs in an
> external file, or add attributes to metadoc. IMO, this adds some unnecessary
> complexity.
External file would look mroe elegant to me, but that's just me.
> I much prefer something along Flammie's idea, a new tag. This way, we just need
> to add the tag to the relevant doc and forget about it.
>
> As we already see the need for different disclaimers, I suggest using a
> <disclaimer> tag with a type attribute. The relevant text is fished from our
> inserts.xml files and I suggest displaying it right at the top of the content
> area. It needs to be either before, after or on the side, but I'd rather not
> insert it randomly in the text.
Seems great.
> Now about outdated translations:
> It's possible to use metadoc to check the corresponding original and display a
> note about a more recent original.
That would be great.
> I've implemented the following:
> If a translation is not listed in its local metadoc, warn users translation is
> not maintained.
> If a translation is listed in its local metadoc, but not in the parent one (ie.
> the English one), warn users original doc is not maintained anymore.
> If file appears both in local and English metadocs, compare their dates and warn
> users that a more recent original exists with a link to it.
Well, as I said on IRC, I'd prefer checking <version>, but <date> is
also better than nothing, yep (code which would check <version>s of HB
files is not available).
Cheers,
-jkt
--
cd /local/pub && more beer > /dev/mouth
[-- Attachment #2: OpenPGP digital signature --]
[-- Type: application/pgp-signature, Size: 256 bytes --]
next prev parent reply other threads:[~2005-09-16 13:01 UTC|newest]
Thread overview: 43+ messages / expand[flat|nested] mbox.gz Atom feed top
2005-09-08 16:56 [gentoo-doc] [RFC] Marking unmaintained documents Jan Kundrát
2005-09-08 17:07 ` Xavier Neys
2005-09-08 17:36 ` Jan Kundrát
2005-09-08 17:54 ` Xavier Neys
2005-09-08 18:12 ` Jan Kundrát
2005-09-08 19:04 ` Shyam Mani
2005-09-09 17:00 ` Sven Vermeulen
2005-09-09 16:57 ` Sven Vermeulen
2005-09-10 13:10 ` Jan Kundrát
2005-09-10 18:22 ` Sven Vermeulen
2005-09-10 20:26 ` Jan Kundrát
2005-09-14 16:55 ` Sven Vermeulen
2005-09-14 18:20 ` Jan Kundrát
2005-09-08 21:00 ` Alexey Chumakov
2005-09-08 21:10 ` Jan Kundrát
2005-09-08 21:11 ` Łukasz Damentko
2005-09-09 1:13 ` Flammie Pirinen
2005-09-09 6:50 ` Alexey Chumakov
2005-09-09 13:10 ` Jan Kundrát
2005-09-09 13:08 ` Jan Kundrát
2005-09-09 15:49 ` Flammie Pirinen
2005-09-09 16:26 ` Łukasz Damentko
2005-09-10 13:11 ` Jan Kundrát
2005-09-09 16:50 ` Sven Vermeulen
2005-09-10 12:35 ` Jan Kundrát
2005-09-15 11:51 ` Xavier Neys
2005-09-15 11:55 ` [gentoo-doc] " Xavier Neys
2005-09-16 13:01 ` Jan Kundrát [this message]
2005-09-17 12:06 ` Sven Vermeulen
2005-09-19 7:51 ` Alexey Chumakov
2005-09-16 9:01 ` [gentoo-doc] " Xavier Neys
2005-09-16 13:07 ` Jan Kundrát
2005-09-16 15:24 ` Xavier Neys
2005-09-16 18:51 ` Jan Kundrát
2005-09-29 15:41 ` Xavier Neys
1980-01-03 20:09 ` Alexey Chumakov
2005-09-29 16:49 ` Jose Luis Rivero
2005-09-29 22:57 ` Łukasz Damentko
2005-09-30 7:20 ` Shyam Mani
2005-09-30 8:59 ` Flammie Pirinen
2005-09-30 16:29 ` Sven Vermeulen
2005-10-02 13:11 ` Jan Kundrát
2005-10-09 10:21 ` Xavier Neys
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=432AC210.5020400@gentoo.org \
--to=jkt@gentoo.org \
--cc=gentoo-doc@lists.gentoo.org \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox