Difference between revisions of "Joomla! Doc Sprints/Start Here"
From Joomla! Documentation
< JDOC:Joomla! Doc Sprints
m (→Where to start) |
(Corrected some category spellings.) |
||
(62 intermediate revisions by 8 users not shown) | |||
Line 1: | Line 1: | ||
− | + | <noinclude><languages /></noinclude> | |
− | |||
− | |||
− | < | ||
− | < | ||
− | |||
− | + | <div class="NavFrame small-12 large-4-spaced columns panel right" style="vertical-align:top; border:1px solid #abd5f5; background-color:#f1f5fc; font-size:85%;padding:.5em; margin-left:.5em"> | |
+ | <div class="NavHead" style="border-bottom:1px solid #abd5f5; background-color:#d0e5f5; padding:0.2em 0.5em 0.2em 0.5em; font-size:110%;"><translate><!--T:1--> | ||
+ | '''Reference Information'''</translate></div> | ||
+ | <div class="NavContent" style="display: none;"> | ||
+ | <translate><!--T:2--> | ||
+ | * If you are new to MediaWiki you should consult the [https://meta.wikimedia.org/wiki/Help:Contents MediaWiki Handbook].</translate> | ||
+ | <translate><!--T:3--> | ||
+ | * List of [[S:MyLanguage/JDOC:Local wiki templates|local Wiki templates]] that can be used in your Wiki pages. Templates reduce repetition and are the basis of modular documentation.</translate> | ||
+ | <translate><!--T:4--> | ||
+ | * List of [[S:MyLanguage/JDOC:Local wiki extensions|local Wiki extensions]] that have been installed on this Wiki. Extensions provide additionally functionality to the Wiki such as syntax highlighting and conditional expressions.</translate> | ||
+ | <translate><!--T:5--> | ||
+ | * List of [[S:MyLanguage/JDOC:Local interwiki links|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 [https://www.php.net/manual/en/ PHP Manual] and [[wikipedia:Main_Page|Wikipedia]].</translate> | ||
+ | <translate><!--T:6--> | ||
+ | * Please read pages in the [https://docs.joomla.org/Category:Style_guides Style Guides category] and the list of [https://github.com/joomla/user-interface-text/blob/master/words2watch.md Words2Watch].</translate> | ||
+ | </div> | ||
+ | </div> | ||
+ | |||
+ | <translate> | ||
+ | <!--T:37--> | ||
+ | Below is a list of articles in need of some attention, then categorised by intended profile. There will be overlap so treat these lists as a rough guide only. | ||
+ | </translate> | ||
+ | |||
+ | <translate> | ||
+ | <!--T:7--> | ||
+ | Remember, if you want to help with translation of our documentation you should go to the page specifically for [[S:MyLanguage/JDOC:Documentation_Translators|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. | ||
+ | </translate> | ||
− | + | {{tip|title=<translate><!--T:8--> | |
− | </ | + | Please Remember</translate>|<translate><!--T:9--> |
+ | 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.</translate>}} | ||
+ | {{-}} | ||
+ | |||
+ | == <translate><!--T:10--> | ||
+ | Where to start? Confused?</translate> [[File:Confused.png|32px]] == | ||
+ | <translate> | ||
+ | <!--T:11--> | ||
+ | Looking for a topic to write about? Please consider helping [[S:MyLanguage/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. | ||
+ | </translate> | ||
+ | |||
+ | <translate> | ||
+ | <!--T:12--> | ||
+ | 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: | ||
+ | * [[S:MyLanguage/:Category:Needs_review|Articles that require a review]] are awaiting a second opinion or a review for accuracy. | ||
+ | * [[S:MyLanguage/:Category:Needs_improvement|Article in need of improvement]] require more information to make them useful. | ||
+ | * [[S:MyLanguage/:Category:Needs_completion|Article in need of completion]] were started, have come a long way but are not quite finished yet. | ||
+ | </translate> | ||
+ | |||
+ | <translate> | ||
+ | <!--T:13--> | ||
+ | Otherwise, look down this page and browse the links. | ||
+ | </translate> | ||
+ | |||
+ | <translate> | ||
+ | == Quick Tasks (Reviews and Images) == <!--T:14--> | ||
+ | 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. | ||
+ | </translate> | ||
− | + | <translate> | |
+ | <!--T:15--> | ||
+ | * [[S:MyLanguage/Register globals|Register globals]] | ||
+ | </translate> | ||
− | + | <translate> | |
− | + | <!--T:16--> | |
− | + | This is a list of pages added auto-magically in need of copyediting in general so they can be moved to translation status. | |
− | + | </translate> | |
− | |||
− | |||
− | |||
− | |||
− | </ | ||
− | |||
− | + | <translate><!--T:17--> | |
− | + | List of all articles belonging to the ''Needs Copyediting'' category. They really just need another editor to review them quickly or upload appropriate images.</translate> | |
+ | <DPL> | ||
+ | noresultsheader=No articles found\n | ||
+ | category=Need copyediting | ||
+ | include={version}:1 | ||
+ | format = ,\n* [[%PAGE%|%TITLE%]] ²{JVer/multi¦,}², | ||
+ | </DPL> | ||
− | + | <translate> | |
− | + | == New Joomla Features == <!--T:18--> | |
− | |||
− | + | <!--T:19--> | |
+ | This list is 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. | ||
+ | </translate> | ||
− | == | + | <translate> |
− | + | === J3.4 Release === <!--T:20--> | |
− | * [[ | + | * [[S:MyLanguage/J3.x:Installing Weblinks|Installing Weblinks]] - How to install it if you want to use it with your website. |
− | * [[ | + | * [[S:MyLanguage/J3.x:Using Composer with Joomla|Using Composer with Joomla]] - What it is, how to use it for developers and its purpose. |
− | + | </translate> | |
− | |||
− | |||
− | + | <translate> | |
− | + | ==Documentation Help by Profile== <!--T:21--> | |
− | + | Below you will find a listing of articles which need attention. They are broken down by the profile, which means the level of knowledge needed to review the article. | |
− | + | </translate> | |
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | == | + | <translate> |
− | Users are visitors to a Joomla! website | + | === Users/Administrators === <!--T:22--> |
+ | Users are visitors to a Joomla! website. Administrators are persons that install and maintain the website. The assumption is that these people will not know how to write code. | ||
+ | </translate> | ||
− | + | <translate><!--T:23--> | |
− | + | List of all articles belonging to both the categories ''Needs Review'' and ''Management (Administration)''.</translate> | |
− | + | <DPL> | |
− | + | noresultsheader=No articles found\n | |
− | + | notnamespace=J2.5 | |
− | + | category=Needs review | |
− | * [[ | + | categorymatch=%Management% |
− | + | include={version}:1 | |
− | + | format = ,\n* [[%PAGE%|%TITLE%]] ²{JVer/multi¦,}², | |
+ | </DPL> | ||
− | == | + | <translate> |
− | Web designers are those people tasked with creating a Joomla! website that will later be looked after by an administrator. | + | === Web Designers === <!--T:24--> |
+ | 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. | ||
+ | </translate> | ||
− | + | <translate><!--T:25--> | |
− | + | List of all articles belonging to both the categories ''Needs review'' and ''Template specific article''.</translate> | |
− | + | <DPL> | |
− | + | noresultsheader=No articles found\n | |
− | * [[ | + | notnamespace=J2.5 |
− | + | category=Needs review% | |
+ | categorymatch=%Templat%|%templat% | ||
+ | notnamespace=JDOC | ||
+ | include={version}:1 | ||
+ | format = ,\n* [[%PAGE%|%TITLE%]] ²{JVer/multi¦,}², | ||
+ | </DPL> | ||
− | == | + | <translate> |
− | By | + | === Core Developers === <!--T:26--> |
+ | By ''core developers'' we mean developers who are contributing to the Joomla! core distribution which includes the core extensions as well as the Framework. | ||
+ | </translate> | ||
− | + | <translate><!--T:27--> | |
− | + | List of all articles belonging to the categories ''Needs review'' and ''Core'' or ''Bug Squad''</translate> | |
− | + | <DPL> | |
− | + | noresultsheader=No articles found\n | |
− | + | notnamespace=J2.5 | |
− | + | category=Needs review% | |
− | + | categorymatch=%Core%|%Bug% | |
− | + | include={version}:1 | |
− | + | format = ,\n* [[%PAGE%|%TITLE%]] ²{JVer/multi¦,}², | |
− | + | </DPL> | |
− | |||
− | * [[ | ||
− | == | + | <translate> |
− | By | + | === Third-party Developers === <!--T:28--> |
+ | 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. | ||
+ | </translate> | ||
− | + | <translate><!--T:29--> | |
− | + | List of all articles belonging to both the categories ''Needs review'' and ''Extension developers''.</translate> | |
− | + | <DPL> | |
− | + | noresultsheader=\nNo articles found | |
− | + | notnamespace=J2.5 | |
− | + | category=Needs review% | |
− | + | categorymatch=%Extension% | |
− | + | include={version}:1 | |
− | + | format = ,\n* [[%PAGE%|%TITLE%]] ²{JVer/multi¦,}², | |
− | + | </DPL> | |
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | * [[ | ||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | == | + | <translate>=== Testers === <!--T:30--> |
− | These people may be testing functionality from a user perspective | + | These people may be testing functionality from a user perspective or they may be developers testing the code itself.</translate> |
− | * | + | <translate><!--T:31--> |
+ | List of all articles belonging to both the categories ''Needs review'' and ''Testing''.</translate> | ||
+ | <DPL> | ||
+ | noresultsheader=\n* Yeah! There were no articles found! This selection must be empty. | ||
+ | notnamespace=J2.5 | ||
+ | category=Needs review% | ||
+ | categorymatch=%Testing% | ||
+ | include={version}:1 | ||
+ | format = ,\n* [[%PAGE%|%TITLE%]] ²{JVer/multi¦,}², | ||
+ | </DPL> | ||
− | == | + | <translate> |
− | + | == Under Construction == <!--T:32--> | |
+ | Articles that are under construction and need help getting to the review point. | ||
+ | </translate> | ||
− | + | <translate><!--T:33--> | |
− | + | List of all articles belonging to the category ''Article Under Construction''.</translate> | |
− | + | <DPL> | |
− | * | + | noresultsheader=No articles found\n |
+ | category=Article under construction | ||
+ | include={version}:1 | ||
+ | format = ,\n* [[%PAGE%|%TITLE%]] ²{JVer/multi¦,}², | ||
+ | </DPL> | ||
− | == | + | <translate> |
+ | === Documentors === <!--T:34--> | ||
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. | ||
+ | </translate> | ||
− | [[Project:MediaWiki setup notes|MediaWiki setup notes]] | + | <translate> |
− | + | <!--T:35--> | |
− | + | * [[Project:MediaWiki setup notes|MediaWiki setup notes]] | |
− | + | </translate> | |
− | [[Category: | + | <translate> |
+ | <!--T:36--> | ||
+ | [[Category:DocSprint]] | ||
+ | [[Category:Documentation Wiki Information]] | ||
+ | </translate> |
Latest revision as of 11:09, 12 July 2022
Below is a list of articles in need of some attention, then categorised by intended profile. 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.
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? [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:
- Articles that require a review are awaiting a second opinion or a review for accuracy.
- Article in need of improvement require more information to make them useful.
- 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.
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 is 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]
- Installing Weblinks - How to install it if you want to use it with your website.
- Using Composer with Joomla - What it is, how to use it for developers and its purpose.
Documentation Help by Profile[edit]
Below you will find a listing of articles which need attention. They are broken down by the profile, which means the level of knowledge needed to review the article.
Users/Administrators[edit]
Users are visitors to a Joomla! website. Administrators are persons that install and maintain the website. The assumption is that these people will not know how to write code.
List of all articles belonging to both the categories Needs Review and Management (Administration).
- Adding a new menu item/da
- Adding a new menu item/de
- Adding a new menu item/el
- Adding a new menu item/en
- Adding a new menu item/et
- Adding a new menu item/fr
- Adding a new menu item/nl
- Adding a new menu item/pt
- Adding a new user/be
- Adding a new user/bn
- Adding a new user/de
- Adding a new user/el
- Adding a new user/en
- Adding a new user/es
- Adding a new user/et
- Adding a new user/fr
- Adding a new user/nl
- Adding a new user/pt
- Adding a new user/pt-br
- Adding a new user/ro
- Adding a new user/ru
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 both the categories Needs review and Template specific article.
- Making templates translatable
- Making templates translatable/en
- Making templates translatable/es
- Making templates translatable/fr
- Making templates translatable/zh-tw
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 Needs review and Core or Bug Squad No articles found
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 both the categories Needs review and Extension developers.
- Creating a custom form field type
- Creating a custom form field type/de
- Creating a custom form field type/en
- Creating a custom form field type/es
- Creating a custom form field type/fr
- Creating a custom form field type/nl
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 both the categories Needs review and Testing.
- Yeah! There were no articles found! This selection must be empty.
Under Construction[edit]
Articles that are under construction and need help getting to the review point.
List of all articles belonging to the category Article Under Construction.
- Controllers
- GSoD 2023
- GSoD 2023 Project Ideas
- Models
- Testing Joomla Extensions with Codeception
- Views
Documentors[edit]
This is meta documentation for use by the Documentation Working Group and other documentors.