From 1f8eceb85e236eaad0c43482643e72a3666bc3b8 Mon Sep 17 00:00:00 2001 From: Christian Kuhn Date: Mon, 30 Oct 2023 16:42:32 +0100 Subject: [PATCH] [TASK] styleguide: Streamline README.md https://github.com/TYPO3-CMS/styleguide/pull/460 Shorten README.md to relevant text valid when styleguide is merged into core monorepo. Also remove the 'legal' note of the tree icon since it was meanwhile changed by us to a different one. --- typo3/sysext/styleguide/README.md | 80 +------------------ .../Private/Templates/Backend/Index.html | 5 -- 2 files changed, 4 insertions(+), 81 deletions(-) diff --git a/typo3/sysext/styleguide/README.md b/typo3/sysext/styleguide/README.md index a4b406d41bed..2076e8dd396d 100644 --- a/typo3/sysext/styleguide/README.md +++ b/typo3/sysext/styleguide/README.md @@ -1,10 +1,3 @@ -![tests](https://github.com/TYPO3/styleguide/workflows/tests/badge.svg) -![tests-ac-mariadb-mysqli](https://github.com/TYPO3/styleguide/actions/workflows/tests-ac-mariadb-mysqli.yml/badge.svg) -![tests-ac-mariadb-pdo-mysql](https://github.com/TYPO3/styleguide/actions/workflows/tests-ac-mariadb-pdo-mysql.yml/badge.svg) -![tests-ac-mysql-mysqli](https://github.com/TYPO3/styleguide/actions/workflows/tests-ac-mysql-mysqli.yml/badge.svg) -![tests-ac-mysql-pdo-mysql](https://github.com/TYPO3/styleguide/actions/workflows/tests-ac-mysql-pdo-mysql.yml/badge.svg) -![tests-ac-postgres](https://github.com/TYPO3/styleguide/actions/workflows/tests-ac-postgres.yml/badge.svg) - TYPO3 CMS Backend Styleguide ============================ @@ -17,11 +10,8 @@ Styleguide is a TYPO3 extension. It provides a backend module that hooks into the 'Help' menu of the top toolbar of the TYPO3 Backend. It can also create a page tree to show examples. -This extension in maintained in the official [TYPO3 github organization.](https://github.com/TYPO3/styleguide) - -Styleguide is developed "core-near": When TYPO3 core adds or deprecates features -covered by this extension, core developers strive to keep it updated, reflecting -these changes. +When TYPO3 core adds or deprecates features covered by this extension, core developers +strive to keep it updated, reflecting these changes. Styleguide is a reference to show a lot of TYPO3 backend features, often relevant for own extensions: @@ -44,8 +34,7 @@ for own extensions: of what the backend editing is capable of out-of-the-box and which parts can be sold to customers without adding expensive implementation burdens to developers. -* Styleguide is a "require-dev" dependency of the [TYPO3 CMS core mono repository](https://github.com/typo3/typo3). - It is used by **core developers** to test and verify changes to JavaScript, HTML +* Styleguide is used by **core developers** to test and verify changes to JavaScript, HTML and PHP code do not break layout or functionality of backend modules. The extension is also used in core backend acceptance tests to verify FormEngine details do not break when developing core patches. @@ -54,11 +43,6 @@ for own extensions: and possible usages of core functionality. Especially the [TCA reference](https://docs.typo3.org/m/typo3/reference-tca/master/en-us/) heavily relies on it. -* Styleguide comes with a simple set up of unit, functional and acceptance tests that - are executed by github action workflow "tests.yml" - or locally if desired. This setup - is documented as a working test set up example within the official [TYPO3 explained testing section](https://docs.typo3.org/m/typo3/reference-coreapi/10.4/en-us/Testing/Index.html) - and can be used as a copy+paste boilerplate in own extensions. - # Installation Styleguide comes as a TYPO3 extension for the TYPO3 backend. It appears as backend module @@ -67,27 +51,6 @@ to let styleguide create an example page tree with records by clicking the "TCA / records -> Create styleguide page tree with data", and waiting for a couple of seconds for the system to crunch the data. -## Composer -With [composer based](https://docs.typo3.org/m/typo3/tutorial-getting-started/main/en-us/Installation/Install.html) -TYPO3 installations, styleguide is easily added to the project. - -TYPO3 v12 based project: - -``` -composer require --dev typo3/cms-styleguide:^12 -``` - -TYPO3 v11 based project: - -``` -composer require --dev typo3/cms-styleguide:^11 -bin/typo3 extension:activate styleguide -``` - -## TYPO3 Extension Repository -For non-composer projects, the extension is available in TER as extension key `styleguide` and can -be installed using the extension manager. - # Initialization With styleguide, it is possible to automatically create sample pages and content for 2 purposes: @@ -121,43 +84,8 @@ get access to the records. The TYPO3 TCA reference documentation often uses examples from the styleguide. -# Running tests - -Styleguide comes with a simple demo set of unit, functional and acceptance tests. It relies -on the runTests.sh script which is a simplified version of a similar script from the TYPO3 core. -Find detailed usage examples by executing `Build/Scripts/runTests.sh -h` and have a look at -`.github/workflows/tests.yml` to see how this is used in CI. - -Example usage: - -``` -Build/Scripts/runTests.sh -s composerUpdate -Build/Scripts/runTests.sh -s unit -``` - - -# Tagging and releasing - -[packagist.org](https://packagist.org/packages/typo3/cms-styleguide) is enabled via the casual github hook. -TER releases are created by the "publish.yml" github workflow when tagging versions -using [tailor](https://github.com/TYPO3/tailor). The commit message of the commit a tag points to is -used as TER upload comment. - -Example: - -``` -composer req --dev typo3/tailor -.Build/bin/tailor set-version 12.0.0 -composer rem --dev typo3/tailor -git commit -am "[RELEASE] 12.0.0 Core v12 compatibility" -git tag 12.0.0 -git push -git push --tags -``` - - # Legal + This project is released under GPLv2 license. See LICENSE.txt for details. -* The "tree" icon is from [Yusuke Kamiyamane](http://p.yusukekamiyamane.com/) * Placeholder texts are from [Bacon Ipsum](http://baconipsum.com/) diff --git a/typo3/sysext/styleguide/Resources/Private/Templates/Backend/Index.html b/typo3/sysext/styleguide/Resources/Private/Templates/Backend/Index.html index f4da50fee707..7435c260218b 100755 --- a/typo3/sysext/styleguide/Resources/Private/Templates/Backend/Index.html +++ b/typo3/sysext/styleguide/Resources/Private/Templates/Backend/Index.html @@ -15,11 +15,6 @@

Presents supported styles for TYPO3 backend modules.

- - This styleguide is work in progress. It is not part of and does not represent the official documentation, yet.
- Styleguide extension currently brings own css definitions that need to be integrated into TYPO3 CMS step by step. - -

Styleguide examples

For information on supported styles and example code, see the link tree on the left.