From Fedora Project Wiki

m (Replaced list homepage link with mailto: link to increase usability and reduce click-through.)
(→‎Signing Up: stripped ssh key requirement; stripped fedora cert requirement.)
Line 28: Line 28:
# Register for a [https://bugzilla.redhat.com/ Bugzilla]  account.  This account gives you the ability to file and respond to documentation bugs.
# Register for a [https://bugzilla.redhat.com/ Bugzilla]  account.  This account gives you the ability to file and respond to documentation bugs.
# Register for a Fedora Project account at https://admin.fedoraproject.org/accounts/ using the same email address as your Bugzilla account.  This account gives you the ability to edit this wiki, as well as other benefits and the ability to collaborate on other teams.
# Register for a Fedora Project account at https://admin.fedoraproject.org/accounts/ using the same email address as your Bugzilla account.  This account gives you the ability to edit this wiki, as well as other benefits and the ability to collaborate on other teams.
# Make a SSH (RSA) keypair and a GPG keypair.  Visit the [[Cryptography]] page for more information and instructions.  These keys let you communicate securely with Fedora Project servers, which helps you work directly on source code and documentation kept there.
# Request membership in the the [https://admin.fedoraproject.org/accounts/group/view/docs Docs Group] in the Fedora Account System
# Join the [https://admin.fedoraproject.org/mailman/listinfo/docs mailing list]  and send a [[DocsProject/SelfIntroduction| self introduction]] to tell the list who you are, your skills and abilities, and what you'd like to help accomplish.
# Join the [https://admin.fedoraproject.org/mailman/listinfo/docs mailing list]  and send a [[DocsProject/SelfIntroduction| self introduction]] to tell the list who you are, your skills and abilities, and what you'd like to help accomplish.  
# Get a client-side certificate from the [https://admin.fedoraproject.org/accounts/ Fedora account system].  Login, go to the bottom of the page to retrieve the certificate, and save it as the file <code>~/.fedora.cert</code>.
# Ask on the [https://admin.fedoraproject.org/mailman/listinfo/docs docs mailing list] how to get involved in work that interests you.
# Ask on the [https://admin.fedoraproject.org/mailman/listinfo/docs docs mailing list] how to join the appropriate groups in the account system to work on the teams that interest you.
# Join the [https://admin.fedoraproject.org/mailman/listinfo/docs-commits docs-commits mailing list], so you can see the flow of tasks and other work in our git and CVS repositories.
# Join the [https://admin.fedoraproject.org/mailman/listinfo/docs-commits docs-commits mailing list], so you can see the flow of tasks and other work in our git and CVS repositories.


 
{{admon/note|Multiple Docs Groups|You'll notice that there are multiple docs groups, start with just Docs, the additional groups grant additional privileges and responsibilities.}}


<!-- Why is a further checklist needed? -->
<!-- Why is a further checklist needed? -->

Revision as of 02:45, 8 June 2010

DocsProject Header docTeam1.png


The DocsProject adheres to the same standards as the rest of the Fedora Project, which means there is a certain amount of formal process. Don't let this put you off, however. Whatever your goals or skill level, you are more than welcome on the list or in any of our other forums.

How You Can Help

There are plenty of ways you can help:

  • Joining the authors already working on our current documents in progress
  • Writing new documents
  • Volunteering to edit draft documents
  • Providing feedback on current documents: final, draft or otherwise

What you can do

  • Edit existing wiki pages
  • Draft documents on the wiki
  • Find problems in existing docs and report or fix them
  • Work on official docs in CVS or git repositories
  • Collaborate with other Fedora teams or hosted projects

Still undecided about whether to join? Read Why you should join the Docs Project!

Signing Up

Idea.png
Use The List
If you have any problems with the following steps, post a question to the list. The members are happy to help you with any problems you might have, and you will likely get an answer in just a few minutes or hours.

Things you need to do

  1. Register for a Bugzilla account. This account gives you the ability to file and respond to documentation bugs.
  2. Register for a Fedora Project account at https://admin.fedoraproject.org/accounts/ using the same email address as your Bugzilla account. This account gives you the ability to edit this wiki, as well as other benefits and the ability to collaborate on other teams.
  3. Request membership in the the Docs Group in the Fedora Account System
  4. Join the mailing list and send a self introduction to tell the list who you are, your skills and abilities, and what you'd like to help accomplish.
  5. Ask on the docs mailing list how to get involved in work that interests you.
  6. Join the docs-commits mailing list, so you can see the flow of tasks and other work in our git and CVS repositories.
Note.png
Multiple Docs Groups
You'll notice that there are multiple docs groups, start with just Docs, the additional groups grant additional privileges and responsibilities.


Familiarize Yourself

To maintain a consistent style across all the docs, all contributors follow certain guidelines in our writings. The Docs Project also has work flows which help avoid clashing when working on docs together. Take some time to familiarize yourself with these practices before committing any changes, to make collaboration easy:

These are the important guidelines that will help you get started quickly. For a comprehensive collection of links relating to the DocsProject methods visit DocsProject/CompleteReference .