JDOC

Difference between revisions of "Joomla! Doc Sprints/Start Here"

From Joomla! Documentation

< JDOC:Joomla! Doc Sprints
m (update)
Line 33: Line 33:
 
* [[Using a terminal session]]
 
* [[Using a terminal session]]
  
This is a list of pages added auto-magically.
+
This is a list of pages added auto-magically in need of copyediting in general.
  
 
<small>List of all articles belonging to the "Needs copyediting" category. They really just need another editor to review them quickly or upload appropriate images.</small>
 
<small>List of all articles belonging to the "Needs copyediting" category. They really just need another editor to review them quickly or upload appropriate images.</small>
Line 46: Line 46:
 
Articles which are under construction and need help getting to the review point.
 
Articles which are under construction and need help getting to the review point.
  
<small>List of all articles belonging to the categories "Need review" AND "Testing"</small>
+
<small>List of all articles belonging to the category "Under Construction"</small>
 
<DPL>
 
<DPL>
 
noresultsheader=No articles found\n   
 
noresultsheader=No articles found\n   
Line 54: Line 54:
 
</DPL>
 
</DPL>
  
==Audience: Users/Administrators==
+
==Documentation Help by Audiences==
 +
===Users/Administrators===
 
Users are visitors to a Joomla! website; administrators are people who install and maintain the website.  The assumption is that these people will not know how to write code.
 
Users are visitors to a Joomla! website; administrators are people who install and maintain the website.  The assumption is that these people will not know how to write code.
  
Line 66: Line 67:
 
</DPL>
 
</DPL>
  
==Audience: Web Designers==
+
===Web Designers===
 
Web designers are those people tasked with creating a Joomla! website that will later be looked after by an administrator.  These people can be assumed to know about HTML and CSS but may have only minimal knowledge of PHP.
 
Web designers are those people tasked with creating a Joomla! website that will later be looked after by an administrator.  These people can be assumed to know about HTML and CSS but may have only minimal knowledge of PHP.
  
Line 79: Line 80:
 
</DPL>
 
</DPL>
  
==Audience: Core Developers==
+
===Core Developers===
 
By "core developers" we mean developers who are contributing to the Joomla! core distribution which includes the core extensions as well as the Framework.
 
By "core developers" we mean developers who are contributing to the Joomla! core distribution which includes the core extensions as well as the Framework.
  
Line 91: Line 92:
 
</DPL>
 
</DPL>
  
==Audience: Third-party Developers==
+
===Third-party Developers===
 
By "third-party developers" we mean developers who are working on extensions to Joomla! (components, modules, plugins and templates) which are made available separately from the Joomla! distribution.
 
By "third-party developers" we mean developers who are working on extensions to Joomla! (components, modules, plugins and templates) which are made available separately from the Joomla! distribution.
  
 
<small>List of all articles belonging to the categories "Need review" AND "Extension developers"</small>
 
<small>List of all articles belonging to the categories "Need review" AND "Extension developers"</small>
 
<DPL>
 
<DPL>
noresultsheader=No articles found\n  
+
noresultsheader=\nNo articles found   
 
category=Needs%
 
category=Needs%
 
categorymatch=%Extension%
 
categorymatch=%Extension%
Line 103: Line 104:
 
</DPL>
 
</DPL>
  
==Audience: Testers==
+
===Testers===
 
These people may be testing functionality from a user perspective; or they may be developers testing the code itself.
 
These people may be testing functionality from a user perspective; or they may be developers testing the code itself.
  
 
<small>List of all articles belonging to the categories "Need review" AND "Testing"</small>
 
<small>List of all articles belonging to the categories "Need review" AND "Testing"</small>
 
<DPL>
 
<DPL>
noresultsheader=No articles found\n  
+
noresultsheader=\nNo articles found   
 
category=Needs%
 
category=Needs%
 
categorymatch=%Testing%
 
categorymatch=%Testing%
Line 115: Line 116:
 
</DPL>
 
</DPL>
  
==Audience: Documentors==
+
===Documentors===
 
This is meta documentation for use by the Documentation Working Group and other documentors.
 
This is meta documentation for use by the Documentation Working Group and other documentors.
  

Revision as of 14:03, 13 October 2014

Instructions

Below is a list of tasks, categorised by intended audience. There will be overlap so treat this as a rough guide only. Please feel free to add new topics to this list.

To start writing on a topic, change the item in this list into a link (unless it's already a link of course!). To do this you simply surround the text by a pair of square brackets. For example, to make "text" into a link, change it to "[[text]]". Save your change. The link text should now appear in red. Click on this new link and you will be taken to an editor screen for the new page. Enter your new topic text and click save. Simple as that. If you encounter any problems, ask for help on the IRC channel.

When you begin editing a page please add {{inuse}} to the top of the page before you start working on it so that others do not create conflicting changes to the same page. And don't forget to remove it again when you have finished! Thank you.

Reference Information
  • If you are new to MediaWiki then you should consult the User's Guide for information on using the wiki software.
  • List of local wiki templates that can be used in your wiki pages. Templates reduce repetition and are the basis of modular documentation.
  • List of local wiki extensions that have been installed on this wiki. Extensions provide additionally functionality to the wiki such as syntax highlighting and conditional expressions.
  • List of local interwiki links that are available on this wiki. These provide useful shortcuts to creating URLs to other websites including the Joomla! forum, help screens and issue tracker; as well as links to the PHP documentation or Wikipedia.
  • Please read the Joomla! Editorial Style Guide and the list of words to watch.

Where to start[edit]

Looking for a topic to write about? At this point, please consider helping complete an article under construction first.

For small tasks look in the Cookie Jar (below). There are category lists about many topics of need on docs, here are a few:

Otherwise, look down this page and browse the links.

Doc Camp Cookie Jar[edit]

This is a list of small tasks that should be quick to get done and might be a good introduction to working on the documentation. These are a list of pages which are added manually.

This is a list of pages added auto-magically in need of copyediting in general.

List of all articles belonging to the "Needs copyediting" category. They really just need another editor to review them quickly or upload appropriate images.

Under Construction[edit]

Articles which are under construction and need help getting to the review point.

List of all articles belonging to the category "Under Construction"

Documentation Help by Audiences[edit]

Users/Administrators[edit]

Users are visitors to a Joomla! website; administrators are people who install and maintain the website. The assumption is that these people will not know how to write code.

List of all articles belonging to the categories "Need review" AND "Management(Adminstration)"

Web Designers[edit]

Web designers are those people tasked with creating a Joomla! website that will later be looked after by an administrator. These people can be assumed to know about HTML and CSS but may have only minimal knowledge of PHP.

List of all articles belonging to the categories "Need review" AND "Template specific article"

Core Developers[edit]

By "core developers" we mean developers who are contributing to the Joomla! core distribution which includes the core extensions as well as the Framework.

List of all articles belonging to the categories "Need review" AND "Core or Bug Squad"

Third-party Developers[edit]

By "third-party developers" we mean developers who are working on extensions to Joomla! (components, modules, plugins and templates) which are made available separately from the Joomla! distribution.

List of all articles belonging to the categories "Need review" AND "Extension developers"

Testers[edit]

These people may be testing functionality from a user perspective; or they may be developers testing the code itself.

List of all articles belonging to the categories "Need review" AND "Testing"

Documentors[edit]

This is meta documentation for use by the Documentation Working Group and other documentors.

MediaWiki setup notes