~ Fedora Deployment Guide ~
The Fedora Deployment Guide documents relevant information regarding the deployment, configuration and administration of Fedora Linux.
- Project Maintainer: Jaromír Hradílek — jhradile@…
- Bug Tracker: bugzilla.redhat.com (file a new bug)
- Latest Release: Multi-page HTML, Single-page HTML, PDF
Frequently Asked Questions
Do I Need An Account or Login to Contribute?
No. All you need is the Git revision control system and Publican.
How Do I Contribute?
Prerequisite: you must first have Git on your system. You can install Git on Fedora by running, as root, yum install git-all.
- Clone the Git repository (you'll then have your own copy of the repo in the current directory named "deployment-guide") and cd into it:
$ git clone http://git.fedorahosted.org/git/docs/deployment-guide.git $ cd deployment-guide.git
- Best practice is to change to a new branch for development: git checkout -b <name> creates a new branch called <name> and switches to it. You can then edit the <chapter>.xml file of your fancy in the en-US directory.
$ git checkout -b yum_additional_command_doc $ myfancyeditor en-US/Yum.xml
- Commit your changes:
$ git commit -a -m "Yum: fixed X; improved Y; added outline of new section Z and comments." [yum_dev 89ca226] Yum: fixed X; improved Y; added outline of new section Z and comments. 2 files changed, 28 insertions(+), 8 deletions(-)
- Create a patch (and there's no need to worry about branches):
$ git format-patch --keep-subject [revision_range]
Use git log to determine the revisions (which are denoted by the first few characters of their hashes below, as a range from, and including, the 2884ce1 change, to the one denoted by bea4e03) you want to send with your patch, and then run:
$ git format-patch --keep-subject 2884ce1..bea4e03
- You can either submit your patch by attaching it to a Bugzilla bug, or by emailing it directly to jhradile@… (and letting him know what the patch does!). If you have made multiple commits and therefore have multiple patches, simply zip or gzip them and send the archive.
I'm Not a Writer! Help!
Great! Writers are just the tip of the iceberg when it comes to producing good technical documentation. We are reliant on engineers to provide technical facts and reviews, and users to provide very useful audience and usability feedback. See WritingAndReviewingTips for some crash-course tips for contributors.
How Do I Become a Contributing Member with git push Rights
Please come talk to Jaromír Hradílek (jhradile) or Petr Kovar (pkovar) on the #fedora-docs IRC channel. They will assess the quality of your patches and make the decision. If you have any questions, or need help creating an XML patch, please contact the project leads.
How Do I File Bugs Against the Deployment Guide
Every chapter in the Deployment Guide has a corresponding tracker bug.
- DeploymentGuideTrackingBugs — master list of tracking bugs
New bugs should be filed against these tracking bugs for:
- corrections to paragraph-level or section-level corrections to a chapter, or
- corrections to an entire chapter at once (certain chapters are very short), or
- new content for enhancements or new capabilities currently not present in a chapter.
One helpful way to contribute is to go to Bugzilla and select Fedora, then on the next page select the Fedora Documentation product and the deployment-guide component, and, finally, enter the Bugzilla number of the chapter the bug refers/applies to in the Blocks field. Here's an example (note the bug summary format):
Note: as chapter numbers are automatically generated from the unnumbered sequence of chapters in the XML, chapter numbers in the tracker bug titles may not match up with the actual table of contents.