From Fedora Project Wiki

< FWN‎ | Beats

m (beat ready for editing.)
m (beat is ready)
Line 8: Line 8:
Contributing Writer: Jason Taylor
Contributing Writer: Jason Taylor


=== Release Notes Galore ===
=== New Language Codes ===


With the approaching F10 release[1] the Docs team spent time this week getting release note beats updated and organized. A lot of progress was made updating the beats to include pertinent package information as well as all the new features[2] and it looks like there may be a new format for the release notes as well[3]. There has also been a lot of work on getting the release-note structure to be compatible with publican[4]. Once compatible with publican the release-notes will support additional formats (HTML, PDF, etc.).
There was some discussion[1] this week between the docs team and members of the translation team about changing the language codes in the Fedora documentation. The proposed change(s) would make the Fedora documentation, in this case the Release-Notes compatible with ISO naming standards.


[1] https://fedoraproject.org/wiki/Releases/10/Schedule
[1] https://www.redhat.com/archives/fedora-docs-list/2008-September/msg00097.html


[2] https://fedoraproject.org/wiki/Releases/10/FeatureList
=== Command Examples Documentation ===


[3] https://fedoraproject.org/wiki/Release_notes_structure_for_F10
Murray McAllister brought to light some discussion recently about how to properly document examples of system commands[1]. There was some interesting discussion on list about how to go about this and we look forward to a consensus in the near future.


[4] https://fedorahosted.org/publican
[1] https://www.redhat.com/archives/fedora-docs-list/2008-October/msg00008.html
 
=== Documentation Repository Changes ===
 
The Docs Project has been working to convert from CVS as the main repository for published documents to git[1]. More progress on that front was made this week as the Install-Guide[2] was moved over. The implementation of git and trac[3] allows for better group communication and work flow management with contributors.
 
[1] http://git.or.cz/
 
[2] https://fedorahosted.org/install-guide/
 
[3] http://trac.edgewall.org/

Revision as of 22:19, 4 October 2008

Documentation

In this section, we cover the Fedora Documentation Project.

http://fedoraproject.org/wiki/DocsProject

Contributing Writer: Jason Taylor

New Language Codes

There was some discussion[1] this week between the docs team and members of the translation team about changing the language codes in the Fedora documentation. The proposed change(s) would make the Fedora documentation, in this case the Release-Notes compatible with ISO naming standards.

[1] https://www.redhat.com/archives/fedora-docs-list/2008-September/msg00097.html

Command Examples Documentation

Murray McAllister brought to light some discussion recently about how to properly document examples of system commands[1]. There was some interesting discussion on list about how to go about this and we look forward to a consensus in the near future.

[1] https://www.redhat.com/archives/fedora-docs-list/2008-October/msg00008.html

Retrieved from "https://fedoraproject.org/w/index.php?title=FWN/Beats/Documentation&oldid=53479"