JDOC

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

From Joomla! Documentation

< JDOC:Joomla! Doc Sprints
m (update)
m (→‎Documentation Help by Audiences: update to uninclude 2.5)
(12 intermediate revisions by the same user not shown)
Line 15: Line 15:
 
{{tip|title=Please Remember|When you begin editing a page please add '''<nowiki>{{inuse}}</nowiki>''' to the top of the page before you start working on it so that others do not create conflicting changes to the same page.  Then don't forget to remove it again when you have finished!  Thank you.}}
 
{{tip|title=Please Remember|When you begin editing a page please add '''<nowiki>{{inuse}}</nowiki>''' to the top of the page before you start working on it so that others do not create conflicting changes to the same page.  Then don't forget to remove it again when you have finished!  Thank you.}}
 
{{-}}
 
{{-}}
−
== Where to start ==
+
== Where to start? Confused? [[File:Confused.png|32px]]  ==
−
Looking for a topic to write about? Please consider helping [[JDOC:Joomla!_Doc_Sprints/Start_Here#Under_Construction|complete an article under construction]] listed here first before creating any new articles.
+
Looking for a topic to write about? Please consider helping [[JDOC:Joomla!_Doc_Sprints/Start_Here#Under_Construction|complete an article under construction]] listed here first before creating any new articles. We are trying to organise our content, find holes, note and fix them, or document future features being released.
  
−
For small tasks look in the Cookie Jar (below). There are category lists about many topics of need on docs, here are a few:
+
For small tasks look in the Quick Tasks (below). These will mainly be editing for misspelling, grammar, and flow. 5 minute reads, and they can be cleared out. There are category lists about many topics of need on docs, here are a few:
 
* [[:Category:Needs_review|Articles that require a review]] are awaiting a second opinion or a review for accuracy.
 
* [[:Category:Needs_review|Articles that require a review]] are awaiting a second opinion or a review for accuracy.
 
* [[:Category:Needs_improvement|Article in need of improvement]] require more information to make them useful.
 
* [[:Category:Needs_improvement|Article in need of improvement]] require more information to make them useful.
 
* [[:Category:Needs_completion|Article in need of completion]] were started, have come a long way but are not quite finished yet.
 
* [[:Category:Needs_completion|Article in need of completion]] were started, have come a long way but are not quite finished yet.
 +
 
Otherwise, look down this page and browse the links.
 
Otherwise, look down this page and browse the links.
  
−
==Doc Camp Cookie Jar==
+
== Quick Tasks (Reviews and Images) ==
−
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 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 because they are high traffic pages. Please remove them once they have been edited.
 +
 
 
* [[Register globals]]
 
* [[Register globals]]
 
* [[Using an FTP client to upload files]]
 
* [[Using an FTP client to upload files]]
−
* [[Using a terminal session]]
 
  
−
This is a list of pages added auto-magically in need of copyediting in general.
+
This is a list of pages added auto-magically in need of copyediting in general so they can be moved to translation status.
  
 
<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 40: Line 41:
 
</DPL>
 
</DPL>
  
−
== Under Construction ==
+
== New Joomla Features ==
−
Articles which are under construction and need help getting to the review point.
+
 
 +
This list if for features just released or being released in the near future. Please add to the list by editing the section with an appropriate, descriptive title using the '''<code>J#.x:</code>''' prefix (only if it is version specific), e.g. <code><nowiki>[[J3.x:A Descriptive Title]]</nowiki></code>. Then add a short summary of what it should contain.
  
−
<small>List of all articles belonging to the category "Under Construction"</small>
+
=== J3.4 Release ===
−
<DPL>
+
* [[J3.x:Installing Weblinks]] - How to install it if you want to use it with your website.
−
noresultsheader=No articles found\n 
+
* [[J3.x:Using Composer with Joomla]] - What it is, how to use it for devs, and it's purpose.
−
category=Article under construction
 
−
include={version}:1 
 
−
format  = ,\n* [[%PAGE%|%TITLE%]]&nbsp;²{JVer/multi¦,}²,
 
−
</DPL>
 
  
 
==Documentation Help by Audiences==
 
==Documentation Help by Audiences==
Line 60: Line 58:
 
<DPL>
 
<DPL>
 
noresultsheader=No articles found\n   
 
noresultsheader=No articles found\n   
 +
notnamespace=J2.5
 
category=Needs review
 
category=Needs review
 
categorymatch=%Management%
 
categorymatch=%Management%
Line 72: Line 71:
 
<DPL>
 
<DPL>
 
noresultsheader=No articles found\n   
 
noresultsheader=No articles found\n   
 +
notnamespace=J2.5
 
category=Needs%
 
category=Needs%
 
categorymatch=%Templat%|%templat%
 
categorymatch=%Templat%|%templat%
Line 85: Line 85:
 
<DPL>
 
<DPL>
 
noresultsheader=No articles found\n   
 
noresultsheader=No articles found\n   
 +
notnamespace=J2.5
 
category=Needs%
 
category=Needs%
 
categorymatch=%Core%|%Bug%
 
categorymatch=%Core%|%Bug%
Line 97: Line 98:
 
<DPL>
 
<DPL>
 
noresultsheader=\nNo articles found   
 
noresultsheader=\nNo articles found   
 +
notnamespace=J2.5
 
category=Needs%
 
category=Needs%
 
categorymatch=%Extension%
 
categorymatch=%Extension%
Line 108: Line 110:
 
<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=\n* Yeah, there were no articles found! This category must be empty.   
+
noresultsheader=\n* Yeah! There were no articles found! This category must be empty.   
 +
notnamespace=J2.5
 
category=Needs%
 
category=Needs%
 
categorymatch=%Testing%
 
categorymatch=%Testing%
 +
include={version}:1 
 +
format  = ,\n* [[%PAGE%|%TITLE%]]&nbsp;²{JVer/multi¦,}²,
 +
</DPL>
 +
 +
== Under Construction ==
 +
Articles which are under construction and need help getting to the review point.
 +
 +
<small>List of all articles belonging to the category "Under Construction"</small>
 +
<DPL>
 +
noresultsheader=No articles found\n 
 +
category=Article under construction
 
include={version}:1   
 
include={version}:1   
 
format  = ,\n* [[%PAGE%|%TITLE%]]&nbsp;²{JVer/multi¦,}²,
 
format  = ,\n* [[%PAGE%|%TITLE%]]&nbsp;²{JVer/multi¦,}²,

Revision as of 12:41, 16 October 2014

Reference Information

Below is a list of articles in need of some attention, then categorised by intended audience. There will be overlap so treat these lists as a rough guide only.

Remember, if you want to help with translation of our documentation you should go to the page specifically for Documentation Translators and sign up. We have over 60 active contributors helping translate our documentation! Join the group and have some fun but don't delay, there are a few tasks you need to complete. You will get translator approval, a friendly welcome message, and added to the group chat for translators. There are lots of great people willing to help get you started.

Please Remember

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. Then don't forget to remove it again when you have finished! Thank you.

Where to start? Confused? Confused.png[edit]

Looking for a topic to write about? Please consider helping complete an article under construction listed here first before creating any new articles. We are trying to organise our content, find holes, note and fix them, or document future features being released.

For small tasks look in the Quick Tasks (below). These will mainly be editing for misspelling, grammar, and flow. 5 minute reads, and they can be cleared out. There are category lists about many topics of need on docs, here are a few:

Otherwise, look down this page and browse the links.

Quick Tasks (Reviews and Images)[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 because they are high traffic pages. Please remove them once they have been edited.

This is a list of pages added auto-magically in need of copyediting in general so they can be moved to translation status.

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

New Joomla Features[edit]

This list if for features just released or being released in the near future. Please add to the list by editing the section with an appropriate, descriptive title using the J#.x: prefix (only if it is version specific), e.g. [[J3.x:A Descriptive Title]]. Then add a short summary of what it should contain.

J3.4 Release[edit]

Documentation Help by Audiences[edit]

Below you will find a listing of articles which need attention. They are broken down by the Audience Type, which means the level of knowledge needed to review the article.

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"

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"

Documentors[edit]

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

Retrieved from "https://docs.joomla.org/index.php?title=JDOC:Joomla!_Doc_Sprints/Start_Here&oldid=127448"