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. Your contributions to the user documentation are very welcome! Just create an article.
- N.B.: you don't have to wait to get author permission anymore. This is different from the instructions and video for the PBF; you will immediately get author rights. In case anything goes wrong, you can come to the Documentation Suggestions channel on Mattermost, and we'll fix it. You might have to log out and then log in again before your author permission can be used.
- 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.
JDay USA documentation session:
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 on GitHub: Tutorials about content management.
The tutorials that will be made today will be published in the left side menu under Tutorials in the top menu. We have now finished them until 4.3 ("Intro image"). There you can see how a tutorial can look like.
For JDay USA, please put your name on the spreadsheet behind the tutorial you want to create. We'll provide the spreadsheet during the documentation session on JDay USA
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.
All contributions are in English; that is our basic language. We are first focussing on content. Coming summer we'll do a project to provide automatic translations, that are being reviewed by translators; they can also provide language-specific screenshots.
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.