Fixing documentation bugs

From FedoraProject

(Difference between revisions)
Jump to: navigation, search
(Created page with "{{header|docs}} == Procedure == # [https://bugzilla.redhat.com/buglist.cgi?query_format=advanced&order=Importance&bug_status=NEW&bug_status=ASSIGNED&classification=Fedora&produc...")
 
(Procedure)
 
Line 5: Line 5:
 
# Once you have found a bug you want to work on, assign the ticket to yourself and update the status to ASSIGNED.
 
# Once you have found a bug you want to work on, assign the ticket to yourself and update the status to ASSIGNED.
 
# Pull the source of the guide.  All guides are in git on fedorahosted.org.  To pull the code simply <code>git clone git+ssh://<fasid>@git.fedorahosted.org/git/docs/<guide>.git</code>.
 
# Pull the source of the guide.  All guides are in git on fedorahosted.org.  To pull the code simply <code>git clone git+ssh://<fasid>@git.fedorahosted.org/git/docs/<guide>.git</code>.
# Copy the file you want to edit as <filename>.xml.org and then edit the <filename>.xml file.
+
# Create a new branch (you can replace bugfix with the bugzilla number or a name): <code>git checkout -b bugfix</code>
# Once changes have been made, go up one directory level and execute <code>gendiff > <bugid>.patch</code>.
+
# edit the file appropriately
# Submit the patch to the bugzilla ticket and state that the ticket is ready for QA. Change the status to MODIFIED.
+
# Add the edited file: <code>git add <file></code>
 +
# Commit the file: <code>git commit <file></code>
 +
# Create the patch: <code>git format-patch master</code>
 +
# Submit the patch to the bugzilla ticket and state that the ticket is ready for QA. Change the status to ON_QA.
 +
# (Optional) delete your new branch with: <code>git branch -d bugfix</code>
  
 
The bug will now be in the hands of the QA people who will check the text for spelling and grammar problems, DocBook tags, and check procedures.  Once complete the guide owner, or you, can publish the change and close the bug.
 
The bug will now be in the hands of the QA people who will check the text for spelling and grammar problems, DocBook tags, and check procedures.  Once complete the guide owner, or you, can publish the change and close the bug.
  
 
[[Category:Docs Project]]
 
[[Category:Docs Project]]

Latest revision as of 02:26, 31 January 2012

DocsProject Header docTeam1.png


[edit] Procedure

  1. Search Bugzilla for bugs that need to be fixed.
  2. Once you have found a bug you want to work on, assign the ticket to yourself and update the status to ASSIGNED.
  3. Pull the source of the guide. All guides are in git on fedorahosted.org. To pull the code simply git clone git+ssh://<fasid>@git.fedorahosted.org/git/docs/<guide>.git.
  4. Create a new branch (you can replace bugfix with the bugzilla number or a name): git checkout -b bugfix
  5. edit the file appropriately
  6. Add the edited file: git add <file>
  7. Commit the file: git commit <file>
  8. Create the patch: git format-patch master
  9. Submit the patch to the bugzilla ticket and state that the ticket is ready for QA. Change the status to ON_QA.
  10. (Optional) delete your new branch with: git branch -d bugfix

The bug will now be in the hands of the QA people who will check the text for spelling and grammar problems, DocBook tags, and check procedures. Once complete the guide owner, or you, can publish the change and close the bug.