Improvements for Documentation Contributors

2019-03-08 by Sybille Peters

If you are not yet familiar with contributing to the documentation at all, we suggest you read the TYPO3 blog article Start Improving Docs Now to Grow TYPO3 for an excellent introduction.

Meanwhile, we discovered that some information about contributing was missing and parts of the information was spread out in too many places. This made it difficult for a contributor to find things or find out which of the information was relevant and up to date.

Because of this, we made several improvements.

These include additional chapters to the manual Writing Documentation to help you get started, such as:

You can start right away and learn as you go along, but if you are looking for guidelines and best practices, we created an entire chapter Conventions for that. This includes:

We reduced duplicate information and try to link to one single entry point.

We also made some minor changes to make it easier for you to find things, like:

  • The channel topic for #typo3-documentation now contains the date of the next Slack call.
TYPO3 Slack call information

#typo3-documentation channel topic

  • All repositories of main manuals now contain a CONTRIBUTING file. GitHub automatically displays a link to this, if you open a new issue or go to the issues tab as new contributor.

Link to CONTRIBUTING for GitHub repository "TYPO3 Explained"

  • We introduced the label "good first issue". This can be assigned to issues which are not very complex and can be solved by new contributors.
  • All main manuals now contain a README.rst with a link to the rendered documentation.

We hope that these changes will prove useful to you. There is still lots to do. If you have additional suggestions, don't hesitate to write an issue or make the changes yourself.

Or tell us what works for you and what doesn't on Slack.

NEW: Documentation of Locking API

2019-03-08 by Sybille Peters

A chapter on the Locking API is now available in "TYPO3 Explained". This chapter has been written by Sybille Peters and reviewed by Markus Klein.

You may have never been aware of the locking API because it works under the hood in the TYPO3 core.

If you develop an extension and use the Caching framework or have other issues where concurrent access to a resource must be prevented, you should check it out.

As always, you can help to improve the documentation: Create an issue or click the "Edit me on GitHub" button on the top right of any page. Read Contribute in "Writing Documentation" to find out more.

NEW: Documentation for rte_ckeditor

2019-02-14 by Sybille Peters

A teaser screenshot

Integration of CKEditor was introduced with TYPO3 8 LTS in the system extension rte_ckeditor, thus replacing the previously used "HtmlArea".

Finally, documentation for this system extension was added to the core and is available to be read online.

Thanks goes to Benni Mack for writing the initial version of the documentation, Sybille Peters for converting to reStructuredText and adding additional chapters and Josef Glatz for further enhancing it.

The community is invited to participate in enhancing it: