Difference between revisions of "Documentation/Contribute"

From Apache OpenOffice Wiki
Jump to: navigation, search
(Prerequisites)
(Tasks from the Task List)
Line 29: Line 29:
 
=== Tasks from the Task List  ===
 
=== Tasks from the Task List  ===
  
Anyone can contribute by following this procedure:  
+
Anyone can contribute in the Wiki by following this simple procedure:  
  
 +
# Log in to the Wiki
 +
# Pick a topic that interests you
 +
# Edit the page and make the changes and edits as needed, and save
 +
 +
If the changes involve a rewrite or other major work, discuss it on the Documentation Mailing list first to let the team know what you are doing.  A large re-write project will need some co-ordination, and tracking.
 +
 +
<!--
 
#See the [http://www.openoffice.org/issues/buglist.cgi?issue_type=TASK&component=documentation&issue_status=UNCONFIRMED&issue_status=NEW&issue_status=STARTED&issue_status=REOPENED Task List].  
 
#See the [http://www.openoffice.org/issues/buglist.cgi?issue_type=TASK&component=documentation&issue_status=UNCONFIRMED&issue_status=NEW&issue_status=STARTED&issue_status=REOPENED Task List].  
 
#Log in and go to the task number in IssueTracker.  
 
#Log in and go to the task number in IssueTracker.  
Line 38: Line 45:
 
#Revise the file as needed after comments are received.  
 
#Revise the file as needed after comments are received.  
 
#When everyone, particularly the project leads, are happy with your work, they will upload it to the main Docs pages and link to it.
 
#When everyone, particularly the project leads, are happy with your work, they will upload it to the main Docs pages and link to it.
 +
-->
  
 
=== Ongoing Tasks  ===
 
=== Ongoing Tasks  ===

Revision as of 06:59, 11 August 2009


The OpenOffice.org Documentation Project always welcomes new contributors - especially experienced writers and editors. But no matter what your level of experience is, you can make a valuable contribution. If you are new to OpenOffice.org, or have no writing experience, you can be a great help by reviewing documentation.

Getting Started

Prerequisites

  • Join the Documentation Mailing List. Introduce yourself to the team, tell us where your strengths are, and how you would like to help.
  • Become a member of the Documentation Project.
  • Set up a user ID on the OpenOffice.org Wiki
  • Read and understand the Licences used within the Documentation Project
  • Read the Wiki Editing Policy.
  • Check the lists of high priority and ongoing tasks below and pick something that interests you.
  • Ask questions on the Documentation mailing list if you're not sure about how to do something.

High Priority Tasks

  • Review the tasks in the Task List. Are they still valid?
    • These Tasks are being closed and are no longer considered current/valid
  • Clean up the Contributing 101 page contents
  • Set up a guideline for new Doc Project members
  • Publish ODT and PDF versions of the Developer's Guide
  • Review and edit the Writer, Calc, Impress, Math documentation.
  • Develop a Base User Guide
  • Update the Migration Guide from 2.x to 3.x
  • Review pages in the Category:Documentation/NeedsRework. These documents need review and updating.

Tasks from the Task List

Anyone can contribute in the Wiki by following this simple procedure:

  1. Log in to the Wiki
  2. Pick a topic that interests you
  3. Edit the page and make the changes and edits as needed, and save

If the changes involve a rewrite or other major work, discuss it on the Documentation Mailing list first to let the team know what you are doing. A large re-write project will need some co-ordination, and tracking.


Ongoing Tasks

  • Find items to post to the articles and reviews section. Attach the items to Issue 47818 and mention them on the list.
  • FAQs: Any help with updating the FAQs would be greatly appreciated. This work is taking place on the wiki.
  • New HowTos, e.g. tips and tricks with Base or any other module that is not something that would be in a user guide but might be useful. For example, a HowTo for creating a Flow Chart using Draw. Check the Task List for suggestions, or start a new issue for a new HowTo. This work is taking place on the wiki.
  • Other specific features-oriented type short manuals.
  • Samples and templates. More are needed to add to this page.
  • Links to other OOo projects' documentation, to add to what is on this page.
  • Translations from other languages. A few from French and German have been done but there is much more that could be in English.

Documentation Developers

The majority of the Documentation work is now coordinated and written here on the Wiki.

People with Developer status at the Documentation Project can upload files directly to the Docs website and do other site maintenance duties. If you want to have Developer status, write to the mailing list and ask. This status is not granted automatically.

Once you have received Developer status, you will need to get CVS access. This page has links to FAQs on the subject. The instructions need to be consolidated and rewritten.

Personal tools