danielsiepmann/tea
danielsiepmann/tea
1
0
mirror of https://github.com/FriendsOfTYPO3/tea.git synced 2024-12-29 02:06:10 +01:00
Code Activity
tea/Documentation/Introduction.rst

76 lines
2.1 KiB
ReStructuredText
Raw Normal View History

[TASK] Update docs (#404) See https://github.com/TYPO3-Documentation/TYPO3CMS-Guide-HowToDocument/commit/c2bb63beadb7cc1ea6eb3496613c3376f970d4c9 for further details. The README.md should mostly only cover the abstract and links. The composer commands are the core value of this extension. List all commands in the documentation and copy the descriptions from the `composer.json`. This lets the global search at docs.typo3.org find these commands. Remove superfluous Linters page, which is integrated now in the Running page. Use sentence case in page titles in order to conform to the TYPO3 documentation standards. The ambiguous :ts: text role has been removed to not confuse the writer with typescript and typoscript. Add the common extension destinations to `composer.json`. (Packagist displays them in a prominent place.)
2022-04-12 19:00:11 +02:00
.. include:: /Includes.rst.txt
.. _introduction:
============
Introduction
============
.. _what-it-does:
What does it do?
================
This TYPO3 extension, based on Extbase and Fluid, is an example of best
practices in automated code checks, unit/functional/acceptance testing and
continuous integration (CI).
[TASK] Document that this is not a kickstarter package (#745) Resolves #407
2023-02-08 13:20:21 +01:00
.. note::
This is not a kickstarter extension.
This extension should not be used to kickstart other extensions.
Instead, this extension should serve as an example for best practices.
Use `EXT:extension_builder <https://extensions.typo3.org/extension/extension_builder>`__
in order to kickstart a new extension.
[TASK] Explain the extension name (#741) Some might find the extension name confusing. We therefore explain why we don't add `_example` or something else. Resolves: #692
2023-02-08 13:31:39 +01:00
.. _why-is-this-extension-called-tea:
Why is this extension called "tea"?
===================================
Good extension names cover the domain of their purpose.
This extension is about managing teas. That's why the name "tea" is a good fit.
We could also add `_example` to the name in order to state that this extension is an example.
But that would already break with our goal to provide a best practice.
This is not related to the `tea package manager <https://tea.xyz/>`__.
[TASK] Update docs (#404) See https://github.com/TYPO3-Documentation/TYPO3CMS-Guide-HowToDocument/commit/c2bb63beadb7cc1ea6eb3496613c3376f970d4c9 for further details. The README.md should mostly only cover the abstract and links. The composer commands are the core value of this extension. List all commands in the documentation and copy the descriptions from the `composer.json`. This lets the global search at docs.typo3.org find these commands. Remove superfluous Linters page, which is integrated now in the Running page. Use sentence case in page titles in order to conform to the TYPO3 documentation standards. The ambiguous :ts: text role has been removed to not confuse the writer with typescript and typoscript. Add the common extension destinations to `composer.json`. (Packagist displays them in a prominent place.)
2022-04-12 19:00:11 +02:00
.. _presentation-online-days-2021:
Presentation at the TYPO3 Online Days 2021
==========================================
At the TYPO3 Online Days 2021, `Oliver Klee <https://www.oliverklee.de/>`__
held a session presenting our approach to automate extension code quality.
Have a look at the slides and the video of the presentation!
.. container:: row m-0 p-0
.. container:: col-md-6 pl-0 pr-3 py-3 m-0
.. container:: card px-0 h-100
.. rst-class:: card-header h3
.. rubric:: Slides
.. container:: card-body
.. image:: /Images/SlidesCover.jpg
:target: https://speakerdeck.com/oliverklee/automating-the-code-quality-of-your-extensions
.. container:: col-md-6 pl-0 pr-3 py-3 m-0
.. container:: card px-0 h-100
.. rst-class:: card-header h3
.. rubric:: Video
.. container:: card-body
.. image:: /Images/VideoCover.jpg
:target: https://youtu.be/_oe8ku2GM84?t=6983
Copy permalink