From Fedora Project Wiki

(small clarifications and style fixes)
(→‎All contributors: Updated list link)
 
(4 intermediate revisions by 3 users not shown)
Line 1: Line 1:
= Checklist =
 
 
 
This page provides detailed information about what you need to do, how to do it, and why you need to do it. Use the contents to jump the sections you're interested in.
 
This page provides detailed information about what you need to do, how to do it, and why you need to do it. Use the contents to jump the sections you're interested in.
  
Line 7: Line 5:
 
'''All contributors''' need:
 
'''All contributors''' need:
  
* Subscription to the [https://listman.redhat.com/mailman/listinfo/fedora-docs-list fedora-docs-list] mailing list.
+
* Subscription to the [https://admin.fedoraproject.org/mailman/listinfo/docs docs] mailing list.
 
** This is the primary forum used for discussions about the docs: we use it for everything, from developing new ideas to refining old ones. By subscribing to this list you're sure to know about everything that's going on with the DocsProject!
 
** This is the primary forum used for discussions about the docs: we use it for everything, from developing new ideas to refining old ones. By subscribing to this list you're sure to know about everything that's going on with the DocsProject!
 
* A [[DocsProject/SelfIntroduction| self introduction]] sent to the list.
 
* A [[DocsProject/SelfIntroduction| self introduction]] sent to the list.
Line 20: Line 18:
  
 
* Everything in [[#All_contributors]] and ...
 
* Everything in [[#All_contributors]] and ...
* Read the guidelines in the [[DocsProject/DocumentationGuide| Documentation Guide]] , and [[DocsProject/WritingUsingTheWiki| WritingUsingTheWiki]]  
+
* Read the guidelines in the [[DocsProject/StyleGuide| Docs Project Style Guide]] , and [[DocsProject/WritingUsingTheWiki| WritingUsingTheWiki]]  
 
* Watch the document(s) which you are working on in [[Special:Preferences]] or by clicking on the ''watch'' link.  Read [[Watchlist_How-To]] for more tips.
 
* Watch the document(s) which you are working on in [[Special:Preferences]] or by clicking on the ''watch'' link.  Read [[Watchlist_How-To]] for more tips.
  
 
== CVS Doc Writers and Editors ==
 
== CVS Doc Writers and Editors ==
  
* Everything in [[#Draft doc writers and editors]] and ...
+
* Everything in [[#All_contributors]] and ...
 
* A GPG key.
 
* A GPG key.
* Familiarity with the [[DocsProject/DocumentationGuide| Documentation Guide]] .
+
* Familiarity with the [[DocsProject/StyleGuide| Docs Project Style Guide]] .
 
* A Fedora CVS account.
 
* A Fedora CVS account.
 
* A Fedora certificate (<code>~/.fedora.cert</code>)
 
* A Fedora certificate (<code>~/.fedora.cert</code>)
Line 33: Line 31:
 
* Cc: on the Bugzilla bugs that track your documents (ask CVS admin).
 
* Cc: on the Bugzilla bugs that track your documents (ask CVS admin).
 
* A subscription to [http://redhat.com/mailman/listinfo/fedora-docs-commits fedora-docs-commits]  mailing list.
 
* A subscription to [http://redhat.com/mailman/listinfo/fedora-docs-commits fedora-docs-commits]  mailing list.
 +
 +
 +
[[Category:Docs Project]][[Category:Docs Project process]]

Latest revision as of 23:56, 14 June 2010

This page provides detailed information about what you need to do, how to do it, and why you need to do it. Use the contents to jump the sections you're interested in.

All contributors

All contributors need:

  • Subscription to the docs mailing list.
    • This is the primary forum used for discussions about the docs: we use it for everything, from developing new ideas to refining old ones. By subscribing to this list you're sure to know about everything that's going on with the DocsProject!
  • A self introduction sent to the list.
    • This is a great way to get started in the project. It lets everyone know what you would like to work on, and they can advise you on the best way forward.
  • A Fedora Project account.
    • The account system has several benefits, including helping us to maintain our free and open source status. Find out more about the account system, which includes FAQs about common concerns.
    • Request sponsorship in the 'docs' group after you have completed your self-introduction.
  • A Bugzilla account.
    • This enables you to submit patches and suggestions for documents through the Bugzilla system. Submissions made this way are sent straight to their author, and should always be responded to. It is also used for filing software bugs discovered while documenting.

Draft doc writers and editors

CVS Doc Writers and Editors

  • Everything in #All_contributors and ...
  • A GPG key.
  • Familiarity with the Docs Project Style Guide .
  • A Fedora CVS account.
  • A Fedora certificate (~/.fedora.cert)
  • A SSH keypair to access CVS (the keys must use RSA).
  • Cc: on the Bugzilla bugs that track your documents (ask CVS admin).
  • A subscription to fedora-docs-commits mailing list.