How to submit content to the Docs Project

= How To Highlight Something for Documentation a/k/a *docs* =

Six Ways of Submitting Content
This is your release note for that package or project; your contribution:
 * Include any relevant references, mailing list discussions, etc.
 * Bugzilla numbers
 * As much writing as you can/want to do for this note; writers will return for clarification, and we can clean up your writing

In order of best to least best:


 * 1) Edit the content directly within the appropriate beat at  Docs/Beats, using the same directions.
 * 2) Email relnotes@fedoraproject.org with all details.
 * 3) Add relnotes@fedoraproject.org as a Cc: in an existing bug report. Adding *docs* to a comments field identifies the field as the content you are referencing.  Include all relevant information and writing.
 * 4) Change the fedora_requires_release_note flag on an existing Bugzilla entry to +
 * 5) Enter any release note requests, comments, etc. into this pre-filled bugzilla request, using the same directions.
 * 6) Include the   keyword in your CVS commit log ([#CVS-keyword-docs More...] ).  Use this to mark milestone commits.  This is your release note for that project/package.

You can get more information about what to document. This same content is included at the bottom of this page for your convenience.

Using CVS Commit Logs
CVS users can alert the Documentation Project to a particular commit by using the keyword *docs* in the commit log.

Examples might be a CVS commit that fulfills a feature, fixes a bug, or otherwise is worth noting in the relnotes

When you put the keyword *docs* in the commit log message, a copy of the commit is sent to relnotes@fedoraproject.org. The beat writers and editors parse the note into the proper place, or open a bugzilla report to track the note suggestion.

Using *docs* in Bugzilla
Use a comment field to summarize whatever you think is needing attention by the Documentation team. In that field, put the keyword  at the top of the comment field.