From mboxrd@z Thu Jan 1 00:00:00 1970 Received: from lists.gentoo.org ([140.105.134.102] helo=robin.gentoo.org) by nuthatch.gentoo.org with esmtp (Exim 4.50) id 1EY2lH-0003Ta-78 for garchives@archives.gentoo.org; Fri, 04 Nov 2005 14:41:47 +0000 Received: from robin.gentoo.org (localhost [127.0.0.1]) by robin.gentoo.org (8.13.5/8.13.5) with SMTP id jA4EcxXK024974; Fri, 4 Nov 2005 14:38:59 GMT Received: from smtp.gentoo.org (smtp.gentoo.org [134.68.220.30]) by robin.gentoo.org (8.13.5/8.13.5) with ESMTP id jA4ERGk9022966 for ; Fri, 4 Nov 2005 14:27:17 GMT Received: from gentoo.xs4all.nl ([213.84.68.112] helo=[10.0.0.2]) by smtp.gentoo.org with esmtpa (Exim 4.43) id 1EY2XE-0001BA-CZ for gentoo-dev@lists.gentoo.org; Fri, 04 Nov 2005 14:27:16 +0000 Message-ID: <436B6FC3.2000203@gentoo.org> Date: Fri, 04 Nov 2005 15:27:15 +0100 From: Xavier Neys User-Agent: Mozilla Thunderbird 1.0.7 (X11/20051026) X-Accept-Language: en-us, en Precedence: bulk List-Post: List-Help: List-Unsubscribe: List-Subscribe: List-Id: Gentoo Linux mail X-BeenThere: gentoo-dev@gentoo.org Reply-to: gentoo-dev@lists.gentoo.org MIME-Version: 1.0 To: gentoo-dev@lists.gentoo.org Subject: Re: [gentoo-dev] GLEP ??: Critical News Reporting References: <20051101015125.1cc45eb4@snowdrop.home> <436AF548.8070406@ieee.org> <200511040032.25592.electronerd@monolith3d.com> <200511041033.06340.pauldv@gentoo.org> <436B34BD.7040509@gentoo.org> In-Reply-To: <436B34BD.7040509@gentoo.org> Content-Type: text/plain; charset=UTF-8; format=flowed Content-Transfer-Encoding: 7bit X-Archives-Salt: e52e1e4a-1ed9-47c2-b2eb-970bb618e460 X-Archives-Hash: 220833a3e4c45bc1bdf04829a0f29e25 Thierry Carrez wrote: > Paul de Vrieze wrote: > > >>Oh god help. This also points to another reason why this is not such a >>good idea. Writing guideXML is a lot more work than writing an e-mail >>format file (ciaran's proposed format for those who didn't recognize it). >> >>Also having double files containing the same information is broken by >>design. > > > OK so there is two options : > > 1- every "news" requires a GuideXML/RST/whatever errata at a central web > location > Pros: > - non-portage user can easily browse errata > - consistency in documentation > Cons: > - work overhead for errata-writing dev > > 2- every "news" requires just a short text-based item, extra doc is optional > Pros: > - flexibility: short news don't require writing extra doc > - external doc reuse: the documentation referenced in the news item can > be some upstream upgrade doc when sufficient > Cons: > - lack of consistency and difficulty for non-portage users to browse > > We can have the best of both worlds if we find a way to reduce the work > overhead to 0 (using some kind of news2errataXml translator ?). If we > can't, I tend to favor the second solution... Both can be done. Posting news items on our front page can be done today, publishing upgrade notes can be done today, grouping all upgrade documents in an upgrade category on the main doc index (docs.gentoo.org) can be done today, having upgrade.gentoo.org point to it can be done one hour later. All of the above does not require a single line of code. I suppose the news snippets could also be integrated in packages.gentoo.org, hopefully without requiring too much work. -- / Xavier Neys \_ Gentoo Documentation Project / French & Internationalisation Lead \ http://www.gentoo.org/doc/en /\ -- gentoo-dev@gentoo.org mailing list