Fedora Release Notes Process
Notes to Add
port to XML, being careful not to overwrite old, still-accurate XML with new, needing-to-be-fixed XML
something about: export CVSROOT=:pserver:anonymous@cvs.fedoraproject.org:/cvs/docs export CVSROOT=:ext:mdious@cvs.fedoraproject.org:/cvs/docs
make validate-xml (for specific language, for example, make validate-xml-de
"validate-xml is all the checks, gets all the support files ready, etc., but does not build"
building fedora-release-notes package:
1. make distclean > /dev/null
1. make release-srpm
after updating po files: cvs ci po/*.po{,t}
http://fedoraproject.org/wiki/Releases/9/FeatureList
Process Outline
Preview Release Notes
1. Mail fedora-devel-list one to two weeks prior to Wiki freeze, asking people to add any content.
1. Clean up the Beats Wiki content.
1. Convert Wiki content to XML.
1. Fix XML tagging.
1. When working with XML files, commit each one separately by running the cvs ci [filename] .xml command.
1. Run the make pot command to create the POT and PO files for localization.
1. Commit the POT and PO files: change into the root release-notes-devel directory, and run the cvs ci po/*.po{,t} command.
1. Mail fedora-trans-list, notifying them that the POT and PO files have been updated. Keeping translators up-to-date is the key to success. Translators ROCK!
1. Make sure your checked-out versions are the latest: Change into the docs-common/ directory, and run the cvs up command. As well, change into the root release-notes-devel/ directory, and run the cvs up command.
1. Before building the fedora-release-notes package, change into the root release-notes-devel/ directory and run the make validate-xml command to make sure all XML is valid, and will build correctly.
1. Once the translation deadline occurs, run the make release-srpm command to build the fedora-release-notes package.
GA Release Notes
1. Mail fedora-devel-list one to two weeks prior to Wiki freeze, asking people to add any content.
1. Use the Info feature to see what content has changed since the preview Release Notes Wiki freeze.
1. Integrate Wiki changes manually into the existing, correctly tagged XML.
1. Run the make pot po command, which updates the existing POT file, and merges changes into the existing PO files.
1. Mail fedora-trans-list, notifying them that the POT and PO files have been updated. Keeping translators up-to-date is the key to success. Translators ROCK!
1. Before building the fedora-release-notes package, change into the root release-notes-devel/ directory and run the make validate-xml command to make sure all XML is valid, and will build correctly.
1. Once the translation deadline occurs, run the make release-srpm command to build the fedora-release-notes package.
Zero-day Updates
1. Merge changes from Wiki into CVS.
1. Update the POT and PO files by running the make pot po command.
1. Mail fedora-trans-list, notifying them that the POT and PO files have been updated. Keeping translators up-to-date is the key to success. Translators ROCK!
Beats Wiki Cleanup
The Beats Wiki, http://fedoraproject.org/wiki/Docs/Beats, is used to gather and write content, that eventually becomes the Fedora release notes. The Documentation Schedule Wiki, http://fedoraproject.org/wiki/DocsProject/Schedule, details when the Beats Wiki is frozen, when the POT file is due for translations, and then the fedora-release-notes package is required for Release Engineering.
Cleaning the Beats Wiki can commence before the Wiki freeze. For example, for the Fedora 9 preview Release Notes, the Beats Wiki was frozen on 2008-03-16; however, to avoid a rush at the end, it is advised that the cleanup process commence one week earlier. Use the Release Notes Beat Status Wiki, http://fedoraproject.org/wiki/Docs/BeatStatus, to keep track of what has been done.
To cleanup the Beats Wiki:
- Wiki cleaned: edit the content to fix style, grammar, and clarity problems.
- Fixing markup: fix the page markup as per http://fedoraproject.org/wiki/WikiEditing#Marking_Technical_Terms.
- Removing old content: this is a judgment call. It is up to the Beats writers to maintain current content; however, using the
Infofeature, if something is clearly old, and no longer required, then it is safe to remove. If people are unhappy that it was removed in the preview Release Notes, it can be added back to the GA Release Notes.
.png){kind=small} Cleaning the Beats Wiki before the freeze
|
If you clean a Beat earlier, watch the page before the freeze to make sure not more content as been added. To watch all Beats, watch the Docs/Beats.* and Docs/Beat.* pages.
|
Emailing Announcements
Fedora Devel List
A few weeks before a Wiki freeze, email the fedora-devel-list asking developers to add content that they would like in the Release Notes:
http://www.redhat.com/mailman/listinfo/fedora-devel-list
The following is an example announcement to fedora-devel-list:
Hi, A quick reminder, the http://fedoraproject.org/wiki/Docs/Beats/ wiki will be frozen at 2359 UTC on 2008-03-16 - the wiki content at this point will comprise the Fedora 9 preview release notes. Content added after 2359 UTC 2008-03-17 will become part of the Fedora 9 GA release notes. A big thank you to everyone who has been adding to the wiki. Kind Regards, Murray.
Fedora Trans List
Once the Release Notes POT file is available in CVS, email fedora-trans-list advising translators that the POT file is available, as well as reminding them when the PO files are due:
http://www.redhat.com/mailman/listinfo/fedora-trans-list
The following is an example announcement to fedora-trans-list:
The Fedora Documentation Project is pleased to deliver the POT file for the Fedora 9 GA release notes. These release notes are going to be delivered with the Fedora 9 GA Release. Translations are due at 2359 UTC on 2008-04-15. Access via Transifex: https://translate.fedoraproject.org/submit/module/docs-release-notes Access via CVS: Via CVS: cvs.fedoraproject.org:/cvs/docs/release-notes/devel/ If you want a complete documentation build environment for the release notes: export CVS_RSH=ssh export CVSROOT=:ext:USERNAME.cvs.fedoraproject.org:/cvs/docs cvs co release-notes-devel If you need just the directory with XML and /po directory: export CVS_RSH=ssh export CVSROOT=:ext:USERNAME.cvs.fedoraproject.org:/cvs/docs cvs co release-notes-dir Definitely let us know if we are missing any of the steps in making the files available for translators. We'll fix it right away! Stop by #fedora-docs on irc.freenode.net or send an email back to this thread. Thanks - Fedora release notes team
SRPM Revision Numbers
(09:39:40 AM) stickster: mdious: So what I did was to make sure that all the modules that are involved in the SRPM are at the same version (09:39:47 AM) stickster: You do that by editing rpm-info.xml for each module (09:39:59 AM) stickster: Just make sure the revision number is the same on the most recent revision. (09:40:09 AM) mdious: ah, so you have to manually change it? (09:40:12 AM) stickster: For F9 PR, that will be 8.92 (09:40:17 AM) stickster: mdious: Right now you do