User Documentation
Download
Launch

Become a Knowledge Navigator

Contributions to the new Joomla! documentation are very welcome.

If you want to contribute, please do the following:

  • Login by clicking on the (blue) button above the left-side menu with "LOGIN (click here)" on it. 
    You will be redirected to the Joomla! Identity Portal, where you can log in with your Joomla Community account. That is the same account on identity.joomla.org as the one you use to log in into Mattermost.
  • If you have no account on identity.joomla.org yet, create one.
  • You can now log in with author permission.  You might have to log out and then log in again before your author permission can be used.
  • Your contributions to the user documentation are very welcome! Just create an article. 
  • In case you have any questions, you are welcome in the Documentation Suggestions channel on Mattermost, and we'll fix it.
  • Start writing! Nobody sees your draft until you submit it for review. You don't have to worry about the exact place where your contribution is placed: that is being taken care of by the Documentation Curators.

Pizza, Bugs & Fun August 21 + 22

For the user documentation we'll focus on adding missing Overview Pages this PBF.

An alien bug announcing the PBF of 21-22 August 2026.

In the user guide you have sections that are listed in an alphabetical order. Each section has an overview-page, that should guide you through the underlying pages. See for instance the overview page for Articles. But there are also missing overview pages. We want to solve that in this PBF.Your help is very welcome! Please help us to also get good overview-pages where they are missing now.

For this PBF we are going to create the 27 missing Overview pages. See the table down here:

Feature / Issue What is Needed (description in GitHub issue) Volunteer(s) doing the work
Missing Overview Pages    
Banners An overview of only one article; so can be very short.  
Dashboards Overview article, introducing the sub-articles.  
Editors Overview article, introducing the sub-articles.  
Extensions Overview article, introducing the sub-articles.  
Help Overview article, introducing the sub-articles.  
Hosting & Installation Overview article, introducing the sub-articles.  
Hosting Notes Overview article, introducing the sub-articles.  
Languages / Multilingual Overview article, introducing the sub-articles.  
Media Overview article, introducing the sub-articles.  
Menus Rework this category description to overview article (with links to sub-articles).  
Migration & Upgrade Overview article, introducing the sub-articles.  
Modules Overview article, introducing the sub-articles.  
News Feeds Overview article, introducing the sub-articles.  
Performance Overview article, introducing the sub-articles.  
Plugins This whole section should be reconsidered: Category is Content Plugins, About Plugins is very general, Joomla Update Notification is about a task (should be under scheduled tasks?) and a quick icon plugin.  
Privacy Overview article, introducing the sub-articles.  
Problems Good description of those very unrelated problems. Or should this be in another section? Or under How-to Guides? Also see next (Reference).  
Reference Good description of those very unrelated references. Or should this be in another section? Or under How-to Guides? Also see above (Problems).  
Security Overview article, introducing the sub-articles.  
SEO Overview article, introducing the sub-articles.  
Smart Search Add links to the overview page + use the name Finder in the overview (so it will be found when searching for that).  
System Overview article, introducing the sub-articles.  
Tags An overview of only one article; so can be very short.  
Templates Overview article, introducing the sub-articles.  
Test Installations Overview article, introducing the sub-articles. Should this go somewhere under Local Setup?  
Users This was an attempt to compose the overview page of all the intro-texts of the sub-articles. Rewrite this to one overview-article, also giving some structure to the sub-articles. Maybe articles like User Password Reset and Admin Password Recovery should be How-to Guides.  
Workflows Overview article, introducing the sub-articles. Maybe Example(s) should be in a (Site Building) tutorial.  

For the PBF, please put your name on the spreadsheet behind the overview page you want to create. We'll provide the spreadsheet during the PBF.

About Tutorials

We are working on a series of tutorials. You'll find them under Tutorials. Until now we have been mainly working on tutorials about Content Management.

  • A tutorial is almost never complete. It just shows a way to do something, not all the alternative possibilities to do so.
  • Main goal is to show some concepts you want to teach. No long explanations. A tutorial is learning by doing.
  • The tutorial offers a series of steps that the reader can repeat, leading to a reproducable result. The path however is more important than the result.
  • fixed order:
    • Start with an overview of prerequisites: what tutorials must be done before doing this one.
    • Then a summary of what this tutorial is about (shortly describing the example).
    • Then the steps to follow
    • End with a conclusion: summary of the covered concepts.

All contributions are in English; that is our basic language. We are first focussing on content. This summer we are working on a project to provide automatic translations, that are being reviewed by translators; they can also provide language-specific screenshots. The plan is to implement that in September.

Your main task is to show others how to use Joomla! You guide them with your knowledge. Hence the name Knowledge Navigator. You can earn Holopin badges with your contributions.
 

License

All contributions to the documentation are covered by the Joomla! Electronic Documentation License.