From Fedora Project Wiki

No edit summary
Line 40: Line 40:
* 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.
* 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.
* 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>.
* 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://www.redhat.com/mailman/listinfo/fedora-docs-list fedora-docs-list] how to join the appropriate groups in the account system to work on the teams that interest you.
* Join the [https://www.redhat.com/mailman/listinfo/fedora-docs-commits fedora-docs-commits mailing list], so you can see the flow of tasks and other work in our git and CVS repositories.
* Join the [https://www.redhat.com/mailman/listinfo/fedora-docs-commits fedora-docs-commits mailing list], so you can see the flow of tasks and other work in our git and CVS repositories.
* If not already done, [[#Familiarize Yourself]] with how to write for the Docs project.
* If not already done, [[#Familiarize Yourself]] with how to write for the Docs project.

Revision as of 23:21, 30 December 2008

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

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

Signing Up

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.

Beginners

Things you can do

  • Edit existing wiki pages
  • Draft documents on the wiki
  • Find problems in existing docs and report or fix them

Things you need to do

  • 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.
  • Register for a 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.
  • #Familiarize Yourself with how to write for the Docs project.

Advanced

Things you can do

  • Work on official docs in CVS or git repositories
  • Collaborate with other Fedora teams or hosted projects

Things you need to do

  • 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.
  • Get a client-side certificate from the Fedora account system. Login, go to the bottom of the page to retrieve the certificate, and save it as the file ~/.fedora.cert.
  • Ask on the fedora-docs-list how to join the appropriate groups in the account system to work on the teams that interest you.
  • Join the fedora-docs-commits mailing list, so you can see the flow of tasks and other work in our git and CVS repositories.
  • If not already done, #Familiarize Yourself with how to write for the Docs project.


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 .