mirror of https://github.com/FriendsOfTYPO3/tea.git synced 2024-11-08 22:36:16 +01:00
Commit graph

29 commits

Author SHA1 Message Date
Karsten Nowak
277a167621 [DOCS] Add documentation part for command controller
Related: #1120
2024-10-20 11:49:43 +02:00
Muhammad Salman
c99b073bf6
[TASK] Rework the testing framework section in the docs (#1480) 2024-10-06 20:20:31 +02:00
5986b09e81
[BUGFIX] Broken rendering in docs (#1428)
Add necessary blank line.
The indentation will be rendered as quote otherwise.
2024-08-20 08:51:16 +02:00
Eike Starkmann
8e592adba7
[TASK] Add more development documentation (#1399)
Resolves:  #1393
2024-07-30 17:41:28 +00:00
5a25569a19
[TASK] Use typoscript instead of ts within script names (#1392)
As ts is usually understood as TypeScript instead of TypoScript.
TYPO3 itself also changed its file extension from `.ts` to `.typoscript`.
We reflect that by adopting the script name.

Resolves: #1385
2024-07-29 19:49:37 +02:00
Eike Starkmann
f0118614ae
[TASK] Add missing switch, hint to run composer install at beginning (#1377) 2024-07-29 18:04:41 +02:00
Oliver Klee
8dad7bd5ca
[TASK] Document our approach to assertions and type checks (#1339)
Fixes #1330
2024-06-11 11:56:20 +02:00
4ee0848039
[TASK] Document to use WSL for tests on Windows (#1295)
Resolves: #1130
2024-05-07 16:35:15 +02:00
b8ef4383b7
[TASK] Migrate from Services.yaml to Services.php (#1286)
* Migrate existing configuration from yaml to php.
* Document why we did the switch and that using yaml or both is totally
  valid and conforms to best practices.
* Document why we are not using attributes but only `Services.php`
  right now.

Resolves: #1172
Relates: #1237
2024-05-07 14:14:54 +02:00
Chris Müller
9b4c0a8f50
[TASK] Switch the documentation to PHP-based rendering (#1190)
Command for rendering:

    ./Build/Scripts/runTests.sh -s docsGenerate

or just:

    composer docs:generate

The reference to the TYPO3 Documentation Rendering Guide was adjusted as the Quickstart page does not exist anymore.

Additionally, the genindex isn't supported anymore. It is planned to consider the `index` directive in the global search on docs.typo3.org.

Resolves: #1189
2024-05-07 12:18:26 +02:00
Łukasz Uznański
fc512e50e9
[TASK] Drop DDEV configuration (#1063)
Resolves: #971
2024-04-15 18:22:03 +02:00
Oliver Klee
33a014d549
[TASK] Stop using the predefined GitHub Actions (#1211)
We won't maintain the predefined GitHub Actions anymore and hence
should not use them in the example extension.

Fixes #1210
2024-04-03 16:37:41 +02:00
Oliver Klee
6f9dd4b904
V3.1.0: New features, bugfixes and cleanup (#1112) 2024-01-08 19:47:37 +01:00
Łukasz Uznański
7fa63d8f02
Drop obsolete tasks from documentation (#1067)
Co-authored-by: Łukasz Uznański <l.uznanski@macopedia.com>
2023-12-15 14:05:21 +01:00
Łukasz Uznański
81340a28d0
[TASK] Update repository urls (#946)
Resolves: #895

Co-authored-by: Łukasz Uznański <l.uznanski@macopedia.com>
2023-10-08 21:53:41 +02:00
0e85116d75
[TASK] Remove phpcpd (PHP Copy/Paste Detector) (#800)
The project got archived and is not maintained anymore.

Resolves: #796
2023-04-06 16:26:51 +02:00
fa77cef5f2
[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
02ee56e042
[TASK] Document that this is not a kickstarter package (#745)
Resolves #407
2023-02-08 13:20:21 +01:00
Oliver Klee
0fa4cfe8d9
V3.0.0: Add TYPO3 12 support, drop TYPO3 10LTS support 2022-10-19 22:19:52 +02:00
Oliver Klee
88785e32e0
[TASK] Document our approach to PHP version support (#654)
Fixes #579
Closes #530

[ci skip]
2022-10-19 18:16:37 +02:00
Oliver Klee
899f2b588a
V2.0.1: Bug fixes and cleanup (#580) 2022-09-21 19:11:36 +02:00
Oliver Klee
be838adde5
[TASK] Remove the ancient acceptance tests (#512)
The acceptance tests have not been testing the extension itself,
have not been maintained for quite some time, and do not serve
as a good example anymore.

Until we have a proper set of example acceptance tests, we should
remove them.

Also drop the now-unused dependency on Codeception.
2022-08-28 09:33:50 +02:00
Oliver Klee
0ec3eaab31
V2.0.0: Drop support for TYPO3 9LTS (#494) 2022-07-26 12:15:13 +02:00
Alexander Nitsche
fc5b861bcd
[TASK] Update docs (#404)
See c2bb63bead 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
Alexander Nitsche
923ff398cb
[DOCS] Reference manual's start page with :doc:<manual>:Index (#418)
Adding the custom label `start` to the beginning of the manual's
Index.rst is redundant. Use :doc:`<manual>:Index` instead of
:ref:`<manual:start>` to refer to it.
2022-04-07 10:48:33 +02:00
Oliver Klee
8654223e22
V1.1.0: Add support for TYPO3 11LTS (#364) 2022-01-04 01:33:24 +01:00
Oliver Klee
d8d55e05a6
V1.0.0: First public release (#322) 2021-10-12 19:06:56 +02:00
Łukasz Uznański
8e3e3630a5
[TASK] Add separate workflow for composer scripts (#258)
Co-authored-by: David Bruchmann <david.bruchmann@gmail.com>
Co-authored-by: Łukasz Uznański <l.uznanski@macopedia.com>
2021-07-21 13:06:59 +02:00
Łukasz Uznański
dee89c5266
[TASK] Prepare documentation rendering (#157)
Co-authored-by: Łukasz Uznański <l.uznanski@macopedia.com>
2020-11-29 18:28:34 +01:00