wiki:WikiStart
Last modified 14 months ago Last modified on 02/16/13 21:19:51

~ Fedora Resource Management Guide ~

The Fedora Deployment Guide documents relevant information regarding system resources management on Fedora Linux.

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. On Fedora, you can install Git with the following command: yum install git.

  1. Clone the Git repository (you will then have your own copy of the repo in the current directory named "resource-management-guide") and cd into it:
$ git clone ssh://git.fedorahosted.org/git/docs/resource-management-guide.git
$ cd resource-management-guide
  1. Edit a chapter file placed in the en-US/ directory or create your own XML file. If you do not know DocBook?, feel free to submit a plain text file using instructions in step 5.
  1. Commit your changes:
$ git commit -a -m "Fixed X; improved Y; added some rough content and comments."
[master 89ca226] Fixed X; improved Y; added some rough content and comments.
 2 files changed, 8 insertions(+), 8 deletions(-)
  1. Create a patch:
    $ git format-patch --keep-subject [revision_range]
    

Use git log to determine the revisions you want to send with your patch, and then, for example:

$ git format-patch --keep-subject 2884ce1..bea4e03
  1. In Bugzilla, open a bug (or file a new one) and attach your patch. 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 the Documentation Guide for some crash-course tips for contributors.

How Do I Become a Contributing Member with git push Rights

Once you submit either 8 complete patches, review a complete chapter for correctness, or create a draft of a new chapter (make sure to consult your idea for a chapter first!), you can then become a contributing member with git push access. The quality of the patches or chapter will be assessed by the project leads. If you have any questions, or need help creating a XML patch, please contact the project lead.

How Do I File Bugs Against the Resource Management Guide

Go to Bugzilla and select Fedora, then on the next page select the Fedora Documentation product and the resource-management-guide component, and, finally, enter the needed information and submit.

You can also use this link which will take you straight to a pre-filled Bugzilla form.