Actions

JDOC

Difference between revisions of "How to Contribute to Joomla! Documentation"

From Joomla! Documentation

m (updates)
m (more wording and explanations)
Line 2: Line 2:
  
 
=Introduction=
 
=Introduction=
If you are reading this page, the Docs Team hopes you will take the next steps to maintaining, improving and contributing to the Joomla! Project's Documentation. Our documentation is written by users, developers, code contributors for the benefit of the same.
+
If you are reading this page, the Docs Team hopes you will take the next steps to maintaining, improving and contributing to the Joomla! Project's Documentation. Our documentation is written by users, developers, and code contributors for the benefit of the same. There are many Open Source Projects using Mediawiki software succesfully for their project's documentation. The Mediawiki software allows for open collaboration, version control of pages, tracking changes similar to Git and a large base of extensions to extend the user interface. A wiki is '''hard to break''' with page history. Make a mistake and just undo or revert the page back to the previous version.
  
 
==What you need==
 
==What you need==
Line 8: Line 8:
 
* '''Important!''' - You should review the [[JDOC:Wiki policy|Wiki policy]] before you start.
 
* '''Important!''' - You should review the [[JDOC:Wiki policy|Wiki policy]] before you start.
 
* If you'd like something to be edited, but you're not sure what to write exactly, use talk pages to add comments to pages.
 
* If you'd like something to be edited, but you're not sure what to write exactly, use talk pages to add comments to pages.
* There are several ways to get help.
+
 
 
==Help, I don't know Wiki Markup!==
 
==Help, I don't know Wiki Markup!==
 +
 +
If you are new to the use of '''''Wikis''''' and the simple markup to create pages, then you can use the following for help.
 +
*New WikiEditor contains buttons and quick links to make building pages easier. Click the word ''''Advanced'''' for a drop down of more buttons and quick formatting links.
 +
*Use the [[Help:Cheatsheet|JDOC's Wiki Cheatsheet]] to learn the basic syntax commands. There is also a drop down of the common markup in the editor. Just click the word ''''Help'''' once and it will appear.
 +
*Still afraid? Try these tools to help you create great wiki pages.
 +
:*[[http://www.microsoft.com/en-us/download/details.aspx?id=12298 Microsoft Word Add-on for Wiki Markup]], save Word Docs in Wiki Markup.
 +
:*'''OpenOffice.org versions 2.4 and later''' have a MediaWiki export filter built in. Just open a Writer document and click File - Export. Then, change File format to MediaWiki.
 +
:*Here is a [[wp:Wikipedia:Tools#Importing_.28converting.29_content_to_Wikipedia_.28MediaWiki.29_format|list of tools]] available to convert other formats to wiki markup, e.g. HTML, Excel, CSV. Some of them are online converters, cut and paste HTML for an output in wiki markup.
 +
*Get help on the [http://groups.google.com/group/joomla-docs Joomla! Documentation Mail List] by posting a question.
 +
*Post a question on an administrator's or editor's talk page.
  
 
=Where do I start?=
 
=Where do I start?=
Line 22: Line 32:
 
*The docs team is also working on [[Beginner Tutorials]]. Our goal is to make them easy to understand and navigate, something a Beginner can follow easily and learn basic concepts. Think back to when you were new to Joomla! and add a topic about something you struggled with as a beginner.
 
*The docs team is also working on [[Beginner Tutorials]]. Our goal is to make them easy to understand and navigate, something a Beginner can follow easily and learn basic concepts. Think back to when you were new to Joomla! and add a topic about something you struggled with as a beginner.
  
=Remember=
+
=Things to Remember=
  
 
Don't forget to add the {{tl|inuse}} template to an article you are going to be working on for a long period of time, more than a minute. It helps to prevent editing conflicts.
 
Don't forget to add the {{tl|inuse}} template to an article you are going to be working on for a long period of time, more than a minute. It helps to prevent editing conflicts.
  
 
<headertabs/>
 
<headertabs/>

Revision as of 07:20, 13 June 2013

Documentation all together tranparent small.png
Under Construction

This project page or section is in the process of an expansion or major restructuring. You are welcome to assist in its construction by editing it as well. If this project page or section has not been edited in several days, please remove this template.
This page was last edited by Tom Hutchison (talk| contribs) 14 months ago. (Purge)


Contents

Introduction

If you are reading this page, the Docs Team hopes you will take the next steps to maintaining, improving and contributing to the Joomla! Project's Documentation. Our documentation is written by users, developers, and code contributors for the benefit of the same. There are many Open Source Projects using Mediawiki software succesfully for their project's documentation. The Mediawiki software allows for open collaboration, version control of pages, tracking changes similar to Git and a large base of extensions to extend the user interface. A wiki is hard to break with page history. Make a mistake and just undo or revert the page back to the previous version.

What you need

  • To edit the Joomla! Documentation Wiki, you will need a user account. If you don't already have one, you may register on here. All a willing contributor needs is a valid email address to register. After confirming your email address you will have immediate permission to edit any page except for a few that are protected because they are high profile spam targets or high web traffic.
  • Important! - You should review the Wiki policy before you start.
  • If you'd like something to be edited, but you're not sure what to write exactly, use talk pages to add comments to pages.

Help, I don't know Wiki Markup!

If you are new to the use of Wikis and the simple markup to create pages, then you can use the following for help.

  • New WikiEditor contains buttons and quick links to make building pages easier. Click the word 'Advanced' for a drop down of more buttons and quick formatting links.
  • Use the JDOC's Wiki Cheatsheet to learn the basic syntax commands. There is also a drop down of the common markup in the editor. Just click the word 'Help' once and it will appear.
  • Still afraid? Try these tools to help you create great wiki pages.
  • [Microsoft Word Add-on for Wiki Markup], save Word Docs in Wiki Markup.
  • OpenOffice.org versions 2.4 and later have a MediaWiki export filter built in. Just open a Writer document and click File - Export. Then, change File format to MediaWiki.
  • Here is a list of tools available to convert other formats to wiki markup, e.g. HTML, Excel, CSV. Some of them are online converters, cut and paste HTML for an output in wiki markup.

Where do I start?

You are free to work on any aspect of the documentation that takes your fancy, but here are some suggestions below for stuff that really needs some love and attention. Don't worry, sometimes even the most seasoned wiki editors can get lost, distracted or confused about what to do next.

  • There are a lot of pages of antiquity in the 'Cookie jar' - they are all time stamped, some over 4 years old. The majority were never even started and pertain to Joomla! 1.5. Mark those articles with the {{delete}} template you feel need to be deleted. Approximately once a week, a bot run will clean up the ones marked deleted unless someone objects on the talk page of the article.
  • Have some fun and browse some articles and feel free to make use of the {{delete}}, {{merge}} or {{JSplit}} templates on the articles. Click the previous template links to see how to use and apply them to articles you think need these marker templates. Add them to the very top of a page and the page is marked.
  • Another area of similar to the 'Cookie jar' is our Needs pages. They are called 'Needs pages' because they are in need of various tasks to complete them. Some of these needs are simple tasks such as reviewing content, adding an image, more content or improvements. Pick a few, give them a little love and help others when they read the docs.
  • Categorisation is always a something easy to do, necessary and in great demand on our wiki! Pages without categories are abundant, pick some titles you know and skip the ones you might not know right off. Categories are important because they help define the structure of the wiki and make it easier to fine information.
  • Help pages, yes we know they are a lot of work, but necessary for beginners and even those with intermediate knowledge of Joomla! Joomla! 2.5 Help Screens are complete but Joomla! 3.x are still being worked on! The love you give them will be felt by many users worldwide. You can find the matrix of 3.x Help Screens here. Some just need to be reviewed and marked complete in status, others need to be started, completed, have images uploaded(670px max width), etc. Make sure you read the 3.x Style Guide. The Help Screens are seen by many worldwide and it is important to maintain a similar style from help page to help page.
  • Join the Developer Tutorials Project and share your knowledge. Sign your name using 4 tildes ( ~~~~ ) on the Developer Tutorials Project page and list what you might be able to do. Feel free to add some tutorial topics to the suggested topics list.
  • The docs team is also working on Beginner Tutorials. Our goal is to make them easy to understand and navigate, something a Beginner can follow easily and learn basic concepts. Think back to when you were new to Joomla! and add a topic about something you struggled with as a beginner.

Things to Remember

Don't forget to add the {{inuse}} template to an article you are going to be working on for a long period of time, more than a minute. It helps to prevent editing conflicts.

<headertabs/>