From Fedora Project Wiki

(saving useful new how to)
 
(Update these instructions for new git based owners module)
 
Line 1: Line 1:
 
[[Category:Docs Project how to]]
 
[[Category:Docs Project how to]]
  
To follow these directions, you need:
+
{{admon/note|Prerequisites|To follow these directions, you need to be a member of the '''doc-writers''' group in FAS. More information is found on the [[Docs Project workflow]] page.}}
  
* Access to commit to cvs.fedoraproject.org:/cvs/docs/owners
+
== Procedure ==
** Commit to /cvs/docs is gained through being part of the 'docs' group
+
<!-- Use HTML markup since you can't easily embed <pre> inside list elements otherwise -->
 +
<ol>
 +
<li>Clone the git repository from Fedora Hosted:
 +
<pre>git clone ssh://username@fedorahosted.org/git/docs/owners.git</pre>
 +
If you already have a local copy, make sure you have the latest updates with a ''pull'' or ''merge''. If you have unsaved changes, you may want to do a ''rebase''. '''Please be careful with this repository!'''</li>
 +
<li>Open <code>owners.list</code> in a text editor.</li>
 +
<li>The components are stored in English alphabetical order by component name.  Insert the new component in the appropriate location.
 +
Component names should be more specific than generic.  For example, ''fedora-guide'' is too generic, whereas ''fedora-user-guide'' is better. Usually the component name and the repository name are the same.</li>
 +
<li> The entry follows this format:
 +
<pre>product|component|description|initialowner|initialqacontact|initialcclist</pre>
 +
<ul><li>The <code>product</code> is ''Fedora Documentation''</li>
 +
<li>The <code>component</code> is e.g. ''fedora-user-guide''</li>
 +
<li>The <code>description</code> is a short, one sentence description of the document.</li>
 +
<li>The <code>initialowner</code> is the Bugzilla account name (email address) of the person who is assigned new bugs by default. This can only be one account.</li>
 +
<li>The <code>initialqacontact</code> is the Bugzilla account name (email address) of the person who is assigned QA of new bugs by default. This can only be one account.</li>
 +
<li>The <code>initialcclist</code> is a comma-separated list of Bugzilla accounts who are included in the Cc: field of new bugs by default.</li></ul></li>
 +
<li>When the new line is complete, save the <code>owners.list</code> file.</li>
 +
<li>Commit <code>owners.list</code> with an appropriate message. It is recommended that you include details and pointers to relevant tracking information in the extended comment area:
 +
<pre>git add owners.list
 +
git commit</pre>
 +
An editor will open for you to make your comments. Use proper git format, which is a short comment of no more than 50 characters on the first line, followed optionally by a blank line and one or more lines of details. For example: <pre>Remove John Q. Public from CC list on foo-guide
  
'''Steps:'''
+
Per request by John, see:
 +
http://lists.fedoraproject.org/mailman/archives/docs/msg00000.html</pre></li>
 +
</ol>
  
# Make sure you have the latest updates:
+
{{admon/note | Synchronization time required | Components are created automatically via a <code>cronjob</code>, usually within sixty minutes.}}
#* <pre>cd /path/to/cvs/docs/owners</pre>
+
 
#* <pre>cvs up -d</pre>
+
If you have any problems, either ask questions on <code>#fedora-admin</code> or file a bug in bugzilla against the ''Fedora'' product, ''bugzilla'' component.
# Open <code>owners.list</code> in a text editor
 
# The components are stored in English alphabetical order by component name; inser the new component in the appropriate location
 
#* Component names should be more specific than generic.  For example, 'fedora-guide' is too generic, where 'fedora-user-guide' is nicely specific.
 
# The entry follows the format of:
 
#* <pre>product|component|description|initialowner|initialqacontact|initialcclist</pre>
 
#** The <code>product</code> is 'Fedora Documentation'
 
#** The <code>component</code> is e.g. 'fedora-user-guide'
 
#** The <code>description</code> is a short, one sentence description of the document
 
#** The <code>initialowner</code> is the bugzilla account name of the person who is assigned ownership of new bugs by default; this can only be one account
 
#** The <code>initialqacontact</code> is the bugzilla account name of the person who is assigned QA of new bugs by default; this can only be one account
 
#** The <code>initialcclist</code> is a comma-separated list of bugzilla accounts who are put in the Cc: field of new bugs by default
 
# When the new line is complete, save the <code>owners.list</code> file
 
# Commit <code>owners.list</code> with an appropriate comment with details and pointers to relevant request tracking, etc.:
 
#* <pre>cvs ci -m "Adding new component for first arrival of Fedora User Guide, \</pre>
 
#* <pre>ref. http://fedorahosted.org/user-guide/ticket/17" owners.list</pre>
 
# Components are created automatically via a <code>cronjob</code>, usually within sixty minutes.
 
# If you have any problems, either ask questions on <code>#fedora-admin</code> or file a bug in bugzilla against the Fedora product, 'bugzilla' component.
 

Latest revision as of 00:11, 23 March 2011


Note.png
Prerequisites
To follow these directions, you need to be a member of the doc-writers group in FAS. More information is found on the Docs Project workflow page.

Procedure

  1. Clone the git repository from Fedora Hosted:
    git clone ssh://username@fedorahosted.org/git/docs/owners.git
    If you already have a local copy, make sure you have the latest updates with a pull or merge. If you have unsaved changes, you may want to do a rebase. Please be careful with this repository!
  2. Open owners.list in a text editor.
  3. The components are stored in English alphabetical order by component name. Insert the new component in the appropriate location. Component names should be more specific than generic. For example, fedora-guide is too generic, whereas fedora-user-guide is better. Usually the component name and the repository name are the same.
  4. The entry follows this format:
    product|component|description|initialowner|initialqacontact|initialcclist
    • The product is Fedora Documentation
    • The component is e.g. fedora-user-guide
    • The description is a short, one sentence description of the document.
    • The initialowner is the Bugzilla account name (email address) of the person who is assigned new bugs by default. This can only be one account.
    • The initialqacontact is the Bugzilla account name (email address) of the person who is assigned QA of new bugs by default. This can only be one account.
    • The initialcclist is a comma-separated list of Bugzilla accounts who are included in the Cc: field of new bugs by default.
  5. When the new line is complete, save the owners.list file.
  6. Commit owners.list with an appropriate message. It is recommended that you include details and pointers to relevant tracking information in the extended comment area:
    git add owners.list
    git commit
    An editor will open for you to make your comments. Use proper git format, which is a short comment of no more than 50 characters on the first line, followed optionally by a blank line and one or more lines of details. For example:
    Remove John Q. Public from CC list on foo-guide
    
    Per request by John, see:
    http://lists.fedoraproject.org/mailman/archives/docs/msg00000.html
Note.png
Synchronization time required
Components are created automatically via a cronjob, usually within sixty minutes.

If you have any problems, either ask questions on #fedora-admin or file a bug in bugzilla against the Fedora product, bugzilla component.