| 1 |
-----BEGIN PGP SIGNED MESSAGE----- |
| 2 |
Hash: SHA1 |
| 3 |
|
| 4 |
Xavier Neys wrote: |
| 5 |
> Thierry Carrez wrote: |
| 6 |
> |
| 7 |
>> Paul de Vrieze wrote: |
| 8 |
>> |
| 9 |
>> |
| 10 |
>>> Oh god help. This also points to another reason why this is not such |
| 11 |
>>> a good idea. Writing guideXML is a lot more work than writing an |
| 12 |
>>> e-mail format file (ciaran's proposed format for those who didn't |
| 13 |
>>> recognize it). |
| 14 |
>>> |
| 15 |
>>> Also having double files containing the same information is broken by |
| 16 |
>>> design. |
| 17 |
>> |
| 18 |
>> |
| 19 |
>> |
| 20 |
>> OK so there is two options : |
| 21 |
>> |
| 22 |
>> 1- every "news" requires a GuideXML/RST/whatever errata at a central web |
| 23 |
>> location |
| 24 |
>> Pros: |
| 25 |
>> - non-portage user can easily browse errata |
| 26 |
>> - consistency in documentation |
| 27 |
>> Cons: |
| 28 |
>> - work overhead for errata-writing dev |
| 29 |
>> |
| 30 |
>> 2- every "news" requires just a short text-based item, extra doc is |
| 31 |
>> optional |
| 32 |
>> Pros: |
| 33 |
>> - flexibility: short news don't require writing extra doc |
| 34 |
>> - external doc reuse: the documentation referenced in the news item can |
| 35 |
>> be some upstream upgrade doc when sufficient |
| 36 |
>> Cons: |
| 37 |
>> - lack of consistency and difficulty for non-portage users to browse |
| 38 |
>> |
| 39 |
>> We can have the best of both worlds if we find a way to reduce the work |
| 40 |
>> overhead to 0 (using some kind of news2errataXml translator ?). If we |
| 41 |
>> can't, I tend to favor the second solution... |
| 42 |
> |
| 43 |
> |
| 44 |
> Both can be done. |
| 45 |
> Posting news items on our front page can be done today, publishing |
| 46 |
> upgrade notes can be done today, grouping all upgrade documents in an |
| 47 |
> upgrade category on the main doc index (docs.gentoo.org) can be done |
| 48 |
> today, having upgrade.gentoo.org point to it can be done one hour later. |
| 49 |
> All of the above does not require a single line of code. |
| 50 |
> |
| 51 |
> I suppose the news snippets could also be integrated in |
| 52 |
> packages.gentoo.org, hopefully without requiring too much work. |
| 53 |
> |
| 54 |
|
| 55 |
Great, then I hope that the scope of the GLEP gets expanded to include: |
| 56 |
|
| 57 |
- - central website (ugrade.g.o or errata.g.o or whatever) |
| 58 |
- - external docs follow existing doc policy |
| 59 |
-----BEGIN PGP SIGNATURE----- |
| 60 |
Version: GnuPG v1.4.1 (GNU/Linux) |
| 61 |
|
| 62 |
iD8DBQFDa4d82QTTR4CNEQARApNQAJ9RzRxl1y/KRd/5xhVh0gQuwU4OEQCdFofK |
| 63 |
pC5D+BbzmgOcSDdW3IookUs= |
| 64 |
=J44D |
| 65 |
-----END PGP SIGNATURE----- |
| 66 |
-- |
| 67 |
gentoo-dev@g.o mailing list |
Archives