The todo list for the documentation

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

During the PBF we will provide a spreadsheet with all topics you can work on. You can put your name on that sheet behind a topic you are working on, to avoid double work.

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.

In the spotlight: overview pages

When you look at the explanations in the user guide, you'll see they are grouped by subject. Each subject has an overview article, informing you what kind of information can be found on the underlying pages. For instance, under Articles you'll find 25 pages explaining all kinds of things relates to articles. In the overview page those pages are introduced in a structured manner.

Here is a list of overview pages that is missing. The more articles are under that overview page, the higher the need for a good overview page.

In the spotlight: tutorials about site building

At the moment we'll focus on tutorials about site building. Step-by-step guides showing all concepts that are used to build a site with Joomla.

How those tutorials for site building are built up and what existing user manual articles you can use for it can be found in this spreadsheet (work in progress).

You can find more in all sub-items of this issue: ... todo...

See the left side menu on the Tutorials page. There you can see how a tutorial can look like.

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.

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: