Here we present topics to work on for the user documentation. 

You can find a detailed list on https://github.com/joomla/documentation/issues. There you can also find discussions about a subject and background information. You can also mark there you are working on a specific article, to avoid someone else working on the same topic.

For the Pizza, Bugs & Fun (PBF) event of January 30 + 31 we will focus on content management tutorials.  

Feature / Issue What is Needed (description in GitHub issue) Existing documentation (User Guide)
Content Management (CM) Tutorials    
5. Delete, archive and filter    
5.1 Filter articles on properties CM5.1 Filter articles on properties #59 Articles: Filter Options
5.2 Delete articles CM5.2 Delete articles #60 Articles: Delete
5.3 Archive articles CM5.3 Archive articles #61 Articles: Archive
6. Pagination and Read More    
6.1 Pagination CM6.1 Pagination #62 Article: Edit - Pagination
6.2 Read More CM6.2 Read More #63 Article: Edit - Read More
7. Publishing and access restrictions    
7.1 Publishing hierarchy CM7.1 Publishing hierarchy #64  
7.2 Timed publishing CM7.2 Timed publishing #75 Article: Edit - Publishing
7.3 View Access restrictions CM7.3 View Access restrictions #65 Article: Access Restriction
7.4 Locking an article CM7.4 Locking an article #66 Article: Check-in
7.5 Edit permissions for articles CM7.5 Edit permissions for articles #67 Article: Edit - Permissions
Tags    
8.1 Content Tags CM8.1 Content Tags #68 Content Tags
Metadata    
9.1 Article metadata CM9.1 Article metadata #69 Article: Edit - Metadata
Modules    
10.1 Adding text other than in an article CM10.1 Adding text other than in an article #70 Custom Module
10.2 Module display by menu-item CM10.2 Module display by menu-item #71 Module Display by Menu Item
     
     
Menus    
11.1 Adding another menu CM11.1 Adding another menu #72 Adding a New Menu
11.2 Submenus    
11.3 Split menu    
     
     


In the spotlight: content management tutorials

At the moment we'll focus on tutorials about content management. That is the management of the content in articles, menu-items, categories, modules, etcetera, ignoring building and maintaining a site (that's the subject for another series of tutorials). 

  • A series of tutorials that shows beginners how articles, menus and categories play together in Joomla. Targeted at new Joomla users.
  • In the current user manual those topics are scattered under several headings (getting started, articles, menus). We especially need some articles that show the relation between the several parts. For instance you can set some general values in the articles options, but you can also set those values in the options-tab of an article or of a menu-item. In addition, you can also adjust the settings in the settings of a category.
  • We are restructuring the content of the manual: now it is mainly an alphabetical listing, but we want to put things that belong together more together. All those things about articles, menu's and categories will be under one heading of Content management.

How those tutorials for content management are built up and what existing user manual articles you can use for it can be found in this spreadsheet (work in progress):
https://docs.google.com/spreadsheets/d/1oBTz5hIfIJaMo3gcAWJ5oTLx0CadR_rbcKlJYM407kU/edit?usp=sharing

You can find more in all sub-items of this issue: Tutorials about content management. Look for the open items (CM5.1 and higher).

The tutorials that will be made today will first be published in the left side menu on the Tutorials page. There you can see how a tutorial can look like.

For the PBF, please put your name on the spreadsheet behind the tutorial you want to create. You'll find a link to the spreadsheet on the Mattermost OR PBF channel.

About Tutorials

  • 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.

Other topics you could work on:

  1. Custom Fields.
  2. How-to guides with mod_articles.
  3. Tutorial: Add a module to the Dashboard.
  4. Template overrides.
  5. Useful Magazine Articles.

Custom Fields

Needed:

  • a tutorial explaning how to use custom fields; now: https://docs-core.sandbox.joomla.org/user-manual/fields/fields-fields-and-field-groups
  • Of all the articles currently under "fields" there are 4 general articles (fields and field groups, field parameters, multilingual sites, and template overrides). They are on the same level with the 15 types of custom fields and one article about a special custom field: subform. Can you come up with a better structure instead of putting all those articles on the same level? if you need a deeper layer, don't forget the overview page.
  • a how-to guide about how to repeat custom fields (using a subform).
  • example of using nested subforms in custom fields (new since 5.2).
  • a reference (overview) of all custom fields + short description.
  • tutorial about template overrides. see https://docs-core.sandbox.joomla.org/user-manual/fields/fields-adding-custom-fields-overrides

See the series about custom fields by Marc Dechèvre in the Magazine:

 Is there anything in those articles that should be in the documentation?

 

How-to guides with mod_articles

Also: update https://docs-core.sandbox.joomla.org/user-manual/modules/modules-site-modules for mod_articles.

 

Tutorial: Add a module to the Dashboard

 

Template overrides and alternate view templates

 

Useful Magazine Articles

Some of these can be used as base for a documentation article.

 

Move to Developers Manual To-do List