Actions

Difference between revisions of "Wiki Wednesdays"

From Joomla! Documentation

m (adding a category, testing DPL random article transclusion by chapter(heading))
m (adding category)
Line 1: Line 1:
{{RightTOC}}Wiki Wednesdays (adapted from an idea from the Mozilla project) are a chance to make an important contribution to the Joomla project in a day (or less).  On Wednesdays one or more tasks that involve pages in the documentation wiki and that need some attention are published.  This could range from just a simple tidy-up by someone with knowledge of wiki syntax, to writing new content on a specific topic. The important point is that they will be short, simple tasks that can be completed in less than a day and usually much less; we're aiming for chunks of work that will only take an hour or so.  It's a great way to contribute and make incremental improvements to the documentation at the same time.
+
{{RightTOC}}'''Wiki Wednesdays''' (adapted from an idea from the Mozilla project) are a chance to make an important contribution to the Joomla project in a day (or less).  On Wednesdays one or more tasks that involve pages in the documentation wiki and that need some attention are published.  This could range from just a simple tidy-up by someone with knowledge of wiki syntax, to writing new content on a specific topic. The important point is that they will be short, simple tasks that can be completed in less than a day and usually much less; we're aiming for chunks of work that will only take an hour or so.  It's a great way to contribute and make incremental improvements to the documentation at the same time.
  
 
Tasks listed with a status of "open" mean that the task has not been completed and we are still looking for people to work on the task so it can be completed and "closed".  If you would like to work on one or more of these tasks there is no need to ask for permission; just go right ahead and get started.
 
Tasks listed with a status of "open" mean that the task has not been completed and we are still looking for people to work on the task so it can be completed and "closed".  If you would like to work on one or more of these tasks there is no need to ask for permission; just go right ahead and get started.
Line 16: Line 16:
 
::Some resources that might contain useful information:
 
::Some resources that might contain useful information:
 
::* the source code itself
 
::* the source code itself
::* [[What%27s new in Joomla 1.6]]
+
::* [[What's new in Joomla 1.6]]
 
::* [[16Events]]
 
::* [[16Events]]
 
::* [[Adapting a Joomla 1.5 extension to Joomla 1.6]]
 
::* [[Adapting a Joomla 1.5 extension to Joomla 1.6]]
Line 94: Line 94:
 
*: Open
 
*: Open
 
* '''Description'''
 
* '''Description'''
*: For the non-developers, this page: [[Restricting access to %22read_more%22]], needs to be checked and a new section added if the procedure for Joomla 2.5 differs from the one stated for Joomla 1.5.  It also needs to be added to relevant categories.
+
*: For the non-developers, this page: [[Restricting access to "read more"]], needs to be checked and a new section added if the procedure for Joomla 2.5 differs from the one stated for Joomla 1.5.  It also needs to be added to relevant categories.
  
 
==Task #9==
 
==Task #9==
Line 114: Line 114:
 
*: When a help screen is identified as being non-compliant in this thread, then it clearly needs to be amended to make it compliant.  So this task is to take one of the identified help screens and make just the minimal changes required to bring it into compliance.  All that is required here is that the correct headings are present and in the correct order.  You don't have to add or amend any text at this stage, although if you want to go ahead and do that, then that would be great.
 
*: When a help screen is identified as being non-compliant in this thread, then it clearly needs to be amended to make it compliant.  So this task is to take one of the identified help screens and make just the minimal changes required to bring it into compliance.  All that is required here is that the correct headings are present and in the correct order.  You don't have to add or amend any text at this stage, although if you want to go ahead and do that, then that would be great.
 
:: The idea is that the very big job of updating the help screens is being broken down into a series of small steps that anyone can help out with given just a small amount of time to spare.
 
:: The idea is that the very big job of updating the help screens is being broken down into a series of small steps that anyone can help out with given just a small amount of time to spare.
<noinclude>[[Category:Wiki Wednesdays]]</noinclude>
+
<noinclude>[[Category:Wiki Wednesdays]]</noinclude><noinclude>[[Category:Landing subpages|{{PAGENAME}}]]</noinclude>

Revision as of 02:35, 1 September 2012

Contents

Wiki Wednesdays (adapted from an idea from the Mozilla project) are a chance to make an important contribution to the Joomla project in a day (or less). On Wednesdays one or more tasks that involve pages in the documentation wiki and that need some attention are published. This could range from just a simple tidy-up by someone with knowledge of wiki syntax, to writing new content on a specific topic. The important point is that they will be short, simple tasks that can be completed in less than a day and usually much less; we're aiming for chunks of work that will only take an hour or so. It's a great way to contribute and make incremental improvements to the documentation at the same time.

Tasks listed with a status of "open" mean that the task has not been completed and we are still looking for people to work on the task so it can be completed and "closed". If you would like to work on one or more of these tasks there is no need to ask for permission; just go right ahead and get started.

If you have any questions regarding these tasks, or suggestions for additional tasks, then please contact the Wiki Wednesdays organiser: Chris Davenport.

Task #1

  • Type
    Developer
  • Status
    Open
  • Description
    Update the list of events available in the CMS here: Plugin/Events.
The aim is to make this a complete list of all events that are or have been available across all versions of Joomla (1.5 onwards). Consequently, each event needs to be flagged with the version numbers in which it is/was available. This is done by adding a tag after the event name, like this {{JVer|1.6}}.
Some resources that might contain useful information:

Task #2

  • Type
    User
  • Status
    Open
  • Description
    "Many hands make light work". Think about your day as a Joomla site administrator and the tasks you had to perform. Think about the goals you were trying to achieve then break those goals down into a set a of short titles that can be added to this page: Administrator goals. This is a temporary page that will be transformed into something else at a later stage.
The idea is to collect a list of goals that a Joomla site administrator might need to perform. For example, "add a new page to the website" is an obvious one. To begin with don't worry too much about whether a particular goal can be broken down into sub-goals or how you would reach a particular goal by breaking it into a list of tasks that need to be completed; we'll do that stuff at a later date. For now we just want to capture as complete a list of goals as we can. Think about things from the user point of view so instead of things like "changing the publish start date" you might add "automatically publish or unpublish a page on a given date". We want all the most common goals and most of the less common ones, listed on this page.

Task #3

  • Type
    User
  • Status
    Open
  • Description
    The Evaluators page is intended to assist people who are evaluating Joomla to assemble the information they need to make the decision on whether to use it or not. I think it is in need of a review and a bit of an update. For example, the link to the demonstration site is clearly out-of-date. Please read it through and improve it if you can.

Task #4

  • Type
    Developer
  • Status
    Open
  • Description
    Accessing the database using JDatabase. This page needs some minor revisions. In particular, the section on “Preparing the query” should be extended to show how to use the JDatabaseQuery class to the prepare the query. This should include just the very briefest example as there really needs to be separate documentation pages that cover JDatabaseQuery in depth.
Also, I think the & can be dropped from the code fragments now as nobody should be running a PHP 4 server any more.

Task #5

  • Type
    All
  • Status
    Open
  • Description
    Sometimes pages are written on the wiki but the author neglects to add a link to the new page from an existing page. Sometimes too, links get deleted because they are no longer relevant and pages become orphaned that way. Regardless of how they came to be orphaned, such pages are harder to find than pages that are linked to. So, your mission Jim, should you choose to accept it, is to seek out lonely pages and either find them a new parent or flag them for graceful retirement. Here’s how to do it:
There’s a complete list of orphaned pages here: Special:LonelyPages
Choose a page from the list and read it through. Ask yourself “is this page still relevant to Joomla users?” Then...
  1. If you think it’s a complete waste of electrons then let me know by adding a link in this thread. The Documentation Team will then make a decision on whether to delete it or not.
  2. If you think it is worth keeping, try to find a page where it would be appropriate to link to it. If you can’t find a suitable page then flag it up on this list. Maybe someone else can find a suitable page. Perhaps the text would be better merged into another page rather than being linked to, so consider that too.
  3. If you’re not sure then just leave it and look at another page from the list.
Let’s see how many orphans can be found new homes this week.

Task #6

  • Type
    Developer
  • Status
    Open
  • Description
    Developers. This is a task that will hopefully lead to a significant reorganisation of this important page. As a first step we need each of the pages listed on this page to be flagged according to which version (or versions) of Joomla it is applicable to. This is done by adding a tag after the event name, like this {{JVer|1.6}}.
So, for example, if you see a link like this:
  • [[a link to a developer page]]
and you discover that it only applies to Joomla 1.5, then change the link to
  • [[a link to a developer page]] {{JVer|1.5}}
If the page applies to multiple Joomla versions then add tags for all the applicable versions. For example:
  • [[a link to a developer page]] {{JVer|1.6}}{{JVer|1.7}}{{JVer|2.5}}
Ideally, I'd like to see all the links on the Developers page flagged like this before we move on to the next stage.

Task #7

  • Type
    Developer
  • Status
    Open
  • Description
    Adding JavaScript. For the developers among you, this page needs to be checked and updated.

Task #8

  • Type
    User
  • Status
    Open
  • Description
    For the non-developers, this page: Restricting access to "read more", needs to be checked and a new section added if the procedure for Joomla 2.5 differs from the one stated for Joomla 1.5. It also needs to be added to relevant categories.

Task #9

  • Type
    User
  • Status
    Open
  • Description
    The idea is that the help screens should all follow the same basic structure as described in our "prototypical" help screen in the help screen style guide: Help25:Help screens styleguide which also includes some notes on how each section of the help screen should be written.
This task is to simply check that all the help screens follow this same structure. The help screens are served from the documentation wiki and there is a complete list of all the Joomla 2.5 help screens here: Help25:Help screens. Click on each of them in turn and compare it with the description given in the style guide. At this stage all you're looking for is just the presence of the correct headings; don’t worry about the text itself for the moment as that's for a later task. You need to read the instructions in the style guide as some help screens quite legitimately don't have all the headings. If you find one that is not compliant simply flag it for attention by replying in this thread. Please also include a short sentence on what needs to be done to bring it into compliance.
That's it; that's all there is to this task. I reckon someone could very likely complete this in a couple of hours.

Task #10

  • Type
    User
  • Status
    Open
  • Description
    When a help screen is identified as being non-compliant in this thread, then it clearly needs to be amended to make it compliant. So this task is to take one of the identified help screens and make just the minimal changes required to bring it into compliance. All that is required here is that the correct headings are present and in the correct order. You don't have to add or amend any text at this stage, although if you want to go ahead and do that, then that would be great.
The idea is that the very big job of updating the help screens is being broken down into a series of small steps that anyone can help out with given just a small amount of time to spare.