Suggestion for writing release notes

Eric "Sparks" Christensen sparks at fedoraproject.org
Wed Sep 5 23:53:22 UTC 2012


-----BEGIN PGP SIGNED MESSAGE-----
Hash: SHA1

On 09/05/2012 04:24 PM, Couret Charles-Antoine wrote:
> I think, the releases notes require to many skills in "data
> processing" to understand the news in Fedora. For me, it's the
> official document to communicate the changelog with the public and
> actually, it's not possible with that.

I would recommend that if you would like to see more content in the
Release Notes that you write a beat[0].  Many times the short text
that you find in the Release Notes is because no one wrote up more
than that.  If you have additional information to add to the updates
of the desktops or any other beat please add it!

> With the French team, we thought to write the release notes in
> French and translate that in English for others translation team. 
> If you are ok to this project, I can write the document before the
> 17th September, it's sufficient for others translation in future.

We've done this with one other guide and it generally adds a lot of
time to the document.  This isn't to say that it can't be done but it
needs to be done very quickly.

> That could be a Publican replacement for the usual Release Notes.
> I don't master yet Publican but I am willing to learn.

The Beats are written in the wiki and moved over to Publican so you
won't have to worry about the DocBook XML markup.

> In short, the idea is to provide the Release Notes for Fedora 18 in
> a detail document avoiding the usual phrasing like bellow: "
> Desktop - GNOME has been updated to the latest release XX; - KDE
> has been updated to the latest release YY; - Mate has been packaged
> for the first time in Fedora.."

I agree that it would be nice to have more information in the Release
Notes.  We just need someone to provide that information.

[0] https://fedoraproject.org/wiki/Category:Documentation_beats

- -- Eric
-----BEGIN PGP SIGNATURE-----
Version: GnuPG v1.4.12 (GNU/Linux)
Comment: Using GnuPG with Mozilla - http://www.enigmail.net/

iQIcBAEBAgAGBQJQR+XtAAoJEIB2q94CS7PR+IkQAKI5eqXQtuw1FKxPb/pWyjFi
nKhTMdZiPabZM+fDdPzsFA3kdnSaRtRBaMEgZ2lu6HbFGZ5LQo1HXOGuor+DF4zx
vjaomp9ykMHZMAPKRTZFP3psxzjuWbq/V9+a5n/+XGE67ob8Gt8YBZ1JxMydI5xO
ettJNMNt6hJfVN4kOyBaM+56zJJRgJym31Fu0caEWDZwrWB++qZvvVPU136ZWevO
FA0Sh5NbEDfqI4alyzvDxYQBB4Nau2CVjEscDNNANsj0+qQJD1ax1P7rrqkyclmj
8Pf+FJLIYiDkeBPMZckd3AVohXoWPu2ejjMCMY+83VCQl/FP46Lxxe7tUnm2M+IB
AWakrTRl8RWBZEboIwns54a1qJDGfOEBaeZ33ZJ7FIYqNiWmOZRVMfF+6k4HORKL
2moeTjbCvANov1mZiTMaW8tNhF1N1ZR8LXEuAGkvPhxulzFmSfvLUlWvCWuABCOb
D1ObZcMSZeKl91xZY2L1Vlrhb/jMdsYmUak38AbFXjoEs8vANzxGltvG5jkRPPlX
hgIPNfi0sIvu3Yzqn1OWYNNNcgy1xQE8wJH42DlG/aoZh2zFqdoigfsT+yYFtr6f
hKkA6JQbTG3o6UDQ2BDynWZZSH+mToTKszzMVKYVjemxkau0GXER+0VTd9XcUtEF
iWxRpydHr6r6wBvqkcGY
=krQ6
-----END PGP SIGNATURE-----


More information about the docs mailing list