From Fedora Project Wiki

m (DocsProject/ReleaseNotes/Process moved to Release notes process: docs project cleanup)
Line 1: Line 1:
{{header|docs}}
+
#REDIRECT [[Writing for DocBook using the wiki]]
 
 
= Release Notes Process =
 
 
 
This page explains the release notes process for the Fedora Project.  Release notes are separated into ''beats'' for easier division and maintenance.  {{FedoraDict/Beat}}
 
 
 
{{Anchor|submitting}}
 
{{Anchor|Submitting}}
 
{{Anchor|Six_Ways_to_Submit_a_Release_Note}}
 
== Six Ways to Submit a Release Note ==
 
 
 
These are in order of preference, starting with the ''best'' option.  Choose only one:
 
 
 
# Edit the content directly within the appropriate beat at [[Docs/Beats| Docs/Beats]].  '''This is the best option ''by far'', since all account holders can edit the wiki as needed.'''
 
# Email relnotes@fedoraproject.org.
 
# Add relnotes@fedoraproject.org as a Cc: in an existing bug report.
 
# Change the <code>fedora_requires_release_note</code> flag on an existing Bugzilla entry to '''+''' ''[[BugzillaFlag|  How to use]] ''
 
# Enter a new release note request, comment, etc. into this [http://tinyurl.com/nej3u pre-filled bugzilla request].  ''NOTE:  This Bugzilla link is '''NOT''' for problems with Fedora software, only for problems with the release notes themselves.''
 
# Include the <code>*docs*</code> keyword in your CVS commit log.  Read [[DocsProject/HighlightedForDocs#CVS-keyword-docs|these guidelines]] on what to put in the commit message.
 
 
 
Read more details on all this at [[DocsProject/HighlightedForDocs| DocsProject/HighlightedForDocs]] .  You can get more information about [[DocsProject/WhatToDocument| what to document]].
 
 
 
We reserve the right to update this process in realtime, via the Wiki
 
page and announcements to the [http://www.redhat.com/mailman/listinfo/fedora-devel-announce developer announcement list].
 
 
 
{{Admon/tip | Make Release Notes meaningful | The text "FooBar 1.2 is now included" is not a meaningful release note.  What does the feature add from the user or developer's point of view?  Follow up with details, but don't go overboard by listing every single change.  Pick the most appealing new items to highlight.  Indicate recommended usage if needed.}}
 
 
 
 
 
 
 
{{Anchor|TheProcess}}
 
{{Anchor|The_Process}}
 
 
 
== The Process ==
 
 
 
<!-- INCLUDERELNOTESPROCESSSTART
 
-->
 
This content is maintained at [[DocsProject/ReleaseNotes/Process#The_Process| DocsProject/ReleaseNotes/Process#The_Process]] .
 
 
 
# Content is updated in [[Docs/Beats| Docs/Beats]]  throughout the development cycle under content-specific coverage areas (''beats'').
 
# For Fedora Alpha and Beta releases, the release notes are a ''one-sheet'' on the Wiki that summarizes the latest information about the release, with appropriate pointers. For the Preview release a full set of release notes is included in the distribution for preview and fixes before the final, Gold release notes are produced.
 
# Link to one-sheet should be included in releng's freeze reminder
 
#* Nagmail to f-maintainers and f-devel (automate?)
 
# One-sheet is linked from announcements
 
# One-sheet has link from within <code>/usr/share/doc/HTML/index.html</code>
 
# How do we link the one-sheet from <code>/usr/share/doc/HTML/RELEASE-NOTES-*.html</code>?
 
# A prominent link is placed in the one-sheet to [[Docs/Beats| Docs/Beats]]  as an early preview of the Preview release notes.  Contributions and etc. are invited.
 
# Coinciding with the Beta release and in preparation for the Preview release, content in [[Docs/Beats| Docs/Beats]]  is checked and cleared out; a diff is generated using the '''Get Info''' tool in the Wiki, with the delta date around the previous Fedora release.  Content is kept that was added after the release date or is a keep-for-a-few-releases piece, such as [[Docs/Beats/Kernel| details on how to build a kernel from the src.rpm]] .
 
#* If a page has not changed but does not need to be released, the equivalent XML is left as-is in CVS
 
# For the Preview release notes, content is converted to XML and output to PO files for translation; [[DocsProject/Schedule| scheduling]]  is coordinated with the [[L10N| L10N]]  project.
 
#* Follow the directions in [[DocsProject/Wiki2XML/ReleaseNotes| DocsProject/Wiki2XML/ReleaseNotes]]
 
# This Preview is built into the <code>fedora-release-notes</code> package, which puts it in to the proper locations in <code>/usr/share/doc/HTML/</code>.  This Preview needs to be widely promoted as the "beta" version of the release notes.  Content should be >80% complete at this point to ease the burden on translators.
 
# Final changes come in from various locations prior to the final release of Fedora.  The schedule is closely followed to make certain PO files arrive to translators on-time.
 
# Content that does not make the deadline is included in [[Docs/Beats| Docs/Beats]] .  This location is prominently linked in the release notes, and is the source for any updates done to the <code>fedora-release-notes</code> package.
 
# A web-only update to the release notes is done on the day of Gold release for last minute changes; this is linked prominently from the in-ISO release notes.
 
#* Customarily this update is pushed as a zero-day package update to <code>fedora-release-notes</code>
 
#* Further fixes can be pushed in one or (rarely) more updates to <code>fedora-release-notes</code>
 
<!-- INCLUDERELNOTESPROCESSEND
 
-->
 
 
 
{{Anchor|BugzillaFlag}}
 
== Using fedora_requires_release_note Bugzilla Flag ==
 
 
 
# Set the flag positive '''+''' to request a release note.
 
# A writer/editor sends in an acknowledgement in a comment, including a pointer to where the content landed
 
# If the content is not used, a writer/editor should set the value to negative '''-'''.
 
 
 
== Help With the Release Notes ==
 
 
 
=== Current Wiki Users ===
 
 
 
To add content for the release notes, just edit the beats directly on the Wiki.  This is explained at [[Docs/Beats/HowTo| Docs/Beats/HowTo]].  You can find the list of  beats at [[Documentation Beats]].
 
 
 
=== FDP Writers, Editors, and New Members ===
 
 
 
If you are a writer/editor interested in working on part of the release notes:
 
 
 
# Join [http://www.redhat.com/mailman/listinfo/fedora-docs-list fedora-docs-list] .  You also want to read the DocsProject/NewWriters page.
 
# [[DocsProject/ReleaseNotes/Beats| Visit the release notes beats page]]  to read about release note beats and see the beat assignments.  You can look at the active beats at Docs/Beats.
 
# Subscribe to the [http://www.redhat.com/mailman/listinfo/fedora-relnotes-content content flow]  mailing list that receives raw content from developers for relnotes and other documentation purposes.
 
 
 
Normally the release notes process uses bugzilla entries to track all requests, so nothing is lost between the cracks.  You can see a list of all pending release notes bugs [https://bugzilla.redhat.com/bugzilla/showdependencytree.cgi?id=151189&hide_resolved=1 here in Bugzilla] .
 
 
 
To publish the release notes from the Wiki, we take a snapshot of the Wiki, convert it to DocBook XML, have it translated, and included in the release.  A snapshot is also taken and used as part of a Web-only latest release notes posted at the same time as general release.  The latest release is linked prominently from the release notes that are linked from Fedora's Firefox default homepage.
 
 
 
Some philosophical notes on this process [[DocsProject/ReleaseNotes/Process/Philosophy| reside here]] .
 
 
 
[[Category:Docs Project process]]
 

Revision as of 12:41, 22 February 2009