Actions

JDOC

Joomla! Doc Sprints/Start Here

From Joomla! Documentation

< JDOC:Joomla! Doc Sprints
Revision as of 15:15, 11 February 2008 by Marieke92 (Talk | contribs)

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.

Where to start

Looking for a topic to write about? Well, for small tasks look in the Cookie Jar (below).

There are lists about:

Otherwise, look down this page and browse the links. Red links are empty pages. If there is a topic that you feel we have missed then feel free to add it here.

Doc Camp Cookie Jar

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.

We need some basic information on the following pages. Looking for a simple definition of the term with links to further information if required.

Audience: 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.

Audience: 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.

Audience: 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.

Audience: 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.

Audience: Testers

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

  • Automated testing.

Audience: Various

Stuff that pertains to multiple audiences.

Audience: Documentors

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

MediaWiki setup notes

License

License

The contents of this wiki are subject to copyright law and are made available under the Joomla! Electronic Documentation License (JEDL) unless otherwise stated. You may find the JEDL Frequently Asked Questions useful in determining if your proposed use of this material is allowed. If you have any questions regarding licensing of this material please contact legal@opensourcematters.org. If you wish to report a possible violation of the license terms for the material on this site then please contact legal@opensourcematters.org.