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
