From b14b6207f381389eef902cba23eef70dab95200d Mon Sep 17 00:00:00 2001
From: Benni Mack <benni@typo3.org>
Date: Wed, 29 Nov 2017 18:47:21 +0100
Subject: [PATCH] [TASK] Make install tool cards more speaking
Resolves: #83169
Releases: master
Change-Id: Ic9ed0f3ceb06aa3befcc3931ba656639615c2f6f
Reviewed-on: https://review.typo3.org/54873
Tested-by: TYPO3com <no-reply@typo3.com>
Reviewed-by: Wouter Wolters <typo3@wouterwolters.nl>
Reviewed-by: Susanne Moog <susanne.moog@typo3.org>
Tested-by: Susanne Moog <susanne.moog@typo3.org>
Reviewed-by: Christian Kuhn <lolli@schwarzbu.ch>
Tested-by: Christian Kuhn <lolli@schwarzbu.ch>
---
.../Partials/Maintenance/ClearAllCache.html | 2 +-
.../Partials/Maintenance/CreateAdmin.html | 1 -
.../Partials/Maintenance/DumpAutoload.html | 3 --
.../Maintenance/ResetBackendUserUc.html | 4 --
.../Private/Templates/Environment/Cards.html | 22 +++++-----
.../Private/Templates/Maintenance/Cards.html | 40 +++++++++----------
.../Private/Templates/Settings/Cards.html | 30 +++++++-------
.../Private/Templates/Upgrade/Cards.html | 38 +++++++++---------
8 files changed, 66 insertions(+), 74 deletions(-)
diff --git a/typo3/sysext/install/Resources/Private/Partials/Maintenance/ClearAllCache.html b/typo3/sysext/install/Resources/Private/Partials/Maintenance/ClearAllCache.html
index 8694b0901635..58b1a405b1cf 100644
--- a/typo3/sysext/install/Resources/Private/Partials/Maintenance/ClearAllCache.html
+++ b/typo3/sysext/install/Resources/Private/Partials/Maintenance/ClearAllCache.html
@@ -1,6 +1,6 @@
<p>
Similar to the clear cache function found in TYPO3’s backend.
- This utility directly clears all system caches including opcode cache.
+ This utility directly clears all registered caches including opcode cache.
</p>
<p>
A fatal error will be thrown if a broken extension is detected.
diff --git a/typo3/sysext/install/Resources/Private/Partials/Maintenance/CreateAdmin.html b/typo3/sysext/install/Resources/Private/Partials/Maintenance/CreateAdmin.html
index 0d385f5716c5..267a58a06515 100644
--- a/typo3/sysext/install/Resources/Private/Partials/Maintenance/CreateAdmin.html
+++ b/typo3/sysext/install/Resources/Private/Partials/Maintenance/CreateAdmin.html
@@ -1,5 +1,4 @@
<p>
- You should use this function only if there are no admin users in the database, for instance if this is a blank database.
After you've created the user, log in and add the rest of the user information, like email and real name.
</p>
diff --git a/typo3/sysext/install/Resources/Private/Partials/Maintenance/DumpAutoload.html b/typo3/sysext/install/Resources/Private/Partials/Maintenance/DumpAutoload.html
index 4b7000d92e31..a36521d6f867 100644
--- a/typo3/sysext/install/Resources/Private/Partials/Maintenance/DumpAutoload.html
+++ b/typo3/sysext/install/Resources/Private/Partials/Maintenance/DumpAutoload.html
@@ -1,6 +1,3 @@
-<p>
- This (re-)dumps autoload information for all active third party extensions.
-</p>
<div class="t3js-dumpAutoload-output"></div>
<button
class="btn btn-warning t3js-dumpAutoload-dump"
diff --git a/typo3/sysext/install/Resources/Private/Partials/Maintenance/ResetBackendUserUc.html b/typo3/sysext/install/Resources/Private/Partials/Maintenance/ResetBackendUserUc.html
index 979a12f365da..23498b513d0a 100644
--- a/typo3/sysext/install/Resources/Private/Partials/Maintenance/ResetBackendUserUc.html
+++ b/typo3/sysext/install/Resources/Private/Partials/Maintenance/ResetBackendUserUc.html
@@ -1,7 +1,3 @@
-<p>
- Clears user preferences of all backend users from be_users table.
- The field 'uc' will be set to an empty string.
-</p>
<p>
This may come in handy in rare cases where that configuration may be corrupt.
Clearing this will clear all user settings from the 'Setup' module.
diff --git a/typo3/sysext/install/Resources/Private/Templates/Environment/Cards.html b/typo3/sysext/install/Resources/Private/Templates/Environment/Cards.html
index 3ac812827fbf..64d9436b9c0f 100644
--- a/typo3/sysext/install/Resources/Private/Templates/Environment/Cards.html
+++ b/typo3/sysext/install/Resources/Private/Templates/Environment/Cards.html
@@ -7,43 +7,43 @@
require: '',
baseClass: 't3js-system',
title: 'Main System Information',
- category: 'environment',
- description: 'Gives a short overview of your system environment.'
+ category: 'Environment',
+ description: 'Gives a short overview of your system environment, webserver, PHP and database information.'
},
1: {partial: 'Environment/EnvironmentCheck',
require: 'TYPO3/CMS/Install/EnvironmentCheck',
baseClass: 't3js-environmentCheck',
- title: 'Environment check',
- category: 'php environment',
- description: 'Perform a huge number of environment checks.'
+ title: 'Check Environment',
+ category: 'PHP',
+ description: 'Performs various checks if there are problems within the server to have TYPO3 running properly.'
},
2: {partial: 'Environment/FolderStructure',
require: 'TYPO3/CMS/Install/FolderStructure',
baseClass: 't3js-folderStructure',
title: 'Check Folder Structure',
- category: 'document structure',
+ category: 'Permissions',
description: 'Analyzes your folder structure by checking the permissions and whether files or folders are missing.'
},
3: {partial: 'Environment/PhpInfo',
require: '',
baseClass: 't3js-phpinfo',
title: 'PHP Info',
- category: 'environment',
+ category: 'PHP',
description: 'Outputs a large amount of information about the current state of PHP.'
},
4: {partial: 'Environment/MailTest',
require: 'TYPO3/CMS/Install/MailTest',
baseClass: 't3js-mailTest',
title: 'Test Mail Setup',
- category: 'environment',
- description: 'Checks the basic mail functionality by sending a test email.'
+ category: 'Mail',
+ description: 'Checks if TYPO3 can send out emails properly by sending a test email.'
},
5: {partial: 'Environment/ImageProcessing',
require: 'TYPO3/CMS/Install/ImageProcessing',
baseClass: 't3js-imageProcessing',
title: 'Image Processing',
- category: 'environment',
- description: 'Creates test images and compare with a reference.'
+ category: 'Image Processing',
+ description: 'Creates test images and compares with a reference to ensure that Image Processing works correctly in the current environment.'
}
}}">
<div class="gridder">
diff --git a/typo3/sysext/install/Resources/Private/Templates/Maintenance/Cards.html b/typo3/sysext/install/Resources/Private/Templates/Maintenance/Cards.html
index 7f6330d4618a..50489e41cdad 100644
--- a/typo3/sysext/install/Resources/Private/Templates/Maintenance/Cards.html
+++ b/typo3/sysext/install/Resources/Private/Templates/Maintenance/Cards.html
@@ -6,51 +6,51 @@
0: {partial: 'Maintenance/ClearAllCache',
require: 'TYPO3/CMS/Install/Cache',
baseClass: 't3js-clearAllCache',
- title: 'Clear all cache',
+ title: 'Flush TYPO3 and PHP Caches',
category: 'Caching',
- description: 'Clears all cache. Including Frontend, backend and language caches.'
+ description: 'Clears all TYPO3 Caches including PHP Op-Caches, similiar to the \'Clear Cache\' Button in the TYPO3 Backend.'
},
- 1: {partial: 'Maintenance/ClearTypo3tempFiles',
+ 1: {partial: 'Maintenance/DatabaseAnalyzer',
+ require: 'TYPO3/CMS/Install/DatabaseAnalyzer',
+ baseClass: 't3js-databaseAnalyzer',
+ title: 'Analyze Database Structure',
+ category: 'Database',
+ description: 'Compare and update the database table and field definitions of the current database with specifications from extensions.'
+ },
+ 2: {partial: 'Maintenance/ClearTypo3tempFiles',
require: 'TYPO3/CMS/Install/ClearTypo3tempFiles',
baseClass: 't3js-clearTypo3temp',
- title: 'Clean typo3temp/assets/',
+ title: 'Remove Temporary Assets',
category: 'Caching',
- description: 'Clears temporary files in typo3temp/assets/ folder, including processed and cached images.'
+ description: 'Clears temporary files in typo3temp/assets/ folder, including concatenated JS/CSS files, and processed images.'
},
- 2: {partial: 'Maintenance/DumpAutoload',
+ 3: {partial: 'Maintenance/DumpAutoload',
require: 'TYPO3/CMS/Install/DumpAutoload',
baseClass: 't3js-dumpAutoload',
- title: 'Dump Autoload Information',
+ title: 'Rebuild PHP Autoload Information',
category: 'Caching',
description: 'This (re-)dumps autoload information for all active third party extensions.'
},
- 3: {partial: 'Maintenance/DatabaseAnalyzer',
- require: 'TYPO3/CMS/Install/DatabaseAnalyzer',
- baseClass: 't3js-databaseAnalyzer',
- title: 'Database analyzer',
- category: 'Database',
- description: 'Verify and update database status.'
- },
4: {partial: 'Maintenance/ClearTables',
require: 'TYPO3/CMS/Install/ClearTables',
baseClass: 't3js-clearTables',
- title: 'Clear Tables',
+ title: 'Clear Semi-Temporary Database Tables',
category: 'Database',
- description: 'Clears semi-temporary data from database tables.'
+ description: 'Truncates semi-temporary database tables, which are not related to caches, but can also be re-populated by TYPO3.'
},
5: {partial: 'Maintenance/CreateAdmin',
require: 'TYPO3/CMS/Install/CreateAdmin',
baseClass: 't3js-createAdmin',
- title: 'Create Admin',
+ title: 'Add Administrator User',
category: 'Backend Users',
- description: 'Creates a backend administrator user.'
+ description: 'Use this function if there are no admin users in the database, for instance if this is a blank installation.'
},
6: {partial: 'Maintenance/ResetBackendUserUc',
require: 'TYPO3/CMS/Install/ResetBackendUserUc',
baseClass: 't3js-resetBackendUserUc',
- title: 'Reset User Preferences',
+ title: 'Reset All Backend User Preferences',
category: 'Backend Users',
- description: 'Reset backend user preferences to defaults.'
+ description: 'Clears user preferences of all backend users from be_users table. The field \'uc\' will be set to an empty string.'
}
}}">
<div class="gridder">
diff --git a/typo3/sysext/install/Resources/Private/Templates/Settings/Cards.html b/typo3/sysext/install/Resources/Private/Templates/Settings/Cards.html
index 11b999dcf036..f519ebd8c1e8 100644
--- a/typo3/sysext/install/Resources/Private/Templates/Settings/Cards.html
+++ b/typo3/sysext/install/Resources/Private/Templates/Settings/Cards.html
@@ -6,30 +6,30 @@
0: {partial: 'Settings/ChangeInstallToolPassword',
require: 'TYPO3/CMS/Install/ChangeInstallToolPassword',
baseClass: 't3js-changeInstallToolPassword',
- title: 'Change install tool password',
+ title: 'Change Install Tool Password',
category: 'Access',
- description: 'Set a new install tool password.'
+ description: 'Set a new password for accessing the Install Tool in Standalone Mode.'
},
1: {partial: 'Settings/SystemMaintainer',
require: 'TYPO3/CMS/Install/SystemMaintainer',
baseClass: 't3js-systemMaintainer',
- title: 'Configure system maintainer',
+ title: 'Configure System Maintainers',
category: 'Access',
- description: 'Backend admin users with access to install tool.'
+ description: 'Add or remove backend administrators which should have access to the Install Tool.'
},
- 2: {partial: 'Settings/LocalConfiguration',
- require: 'TYPO3/CMS/Install/LocalConfiguration',
- baseClass: 't3js-localConfiguration',
- title: 'Configure Global Settings',
- category: 'LocalConfiguration',
- description: 'Modify LocalConfiguration.php settings.'
- },
- 3: {partial: 'Settings/Presets',
+ 2: {partial: 'Settings/Presets',
require: 'TYPO3/CMS/Install/Presets',
baseClass: 't3js-presets',
- title: 'Configure Presets',
- category: 'LocalConfiguration',
- description: 'Detect and select default LocalConfiguration.php settings.'
+ title: 'Configure and Presets',
+ category: 'Global Configuration',
+ description: 'Detect and select settings for Image Processing, Debug/Live mode and Mail settings.'
+ },
+ 3: {partial: 'Settings/LocalConfiguration',
+ require: 'TYPO3/CMS/Install/LocalConfiguration',
+ baseClass: 't3js-localConfiguration',
+ title: 'Configure installation-wide options',
+ category: 'Global Configuration',
+ description: 'Modify settings to be written into TYPO3\'s LocalConfiguration.php.'
}
}}">
<div class="gridder">
diff --git a/typo3/sysext/install/Resources/Private/Templates/Upgrade/Cards.html b/typo3/sysext/install/Resources/Private/Templates/Upgrade/Cards.html
index 4a89fa0c867d..f7ec9e6ca15d 100644
--- a/typo3/sysext/install/Resources/Private/Templates/Upgrade/Cards.html
+++ b/typo3/sysext/install/Resources/Private/Templates/Upgrade/Cards.html
@@ -6,51 +6,51 @@
0: {partial: 'Upgrade/CoreUpdate',
require: 'TYPO3/CMS/Install/CoreUpdate',
baseClass: 't3js-coreUpdate',
- title: 'Update Core',
- category: 'upgrade',
- description: 'One click core updater.'
+ title: 'Update TYPO3 Core',
+ category: 'Core Upgrade',
+ description: 'Update your TYPO3 installation with one click, if your instance is set up correctly.'
},
1: {partial: 'Upgrade/UpgradeWizards',
require: 'TYPO3/CMS/Install/UpgradeWizards',
baseClass: 't3js-upgradeWizards',
- title: 'Upgrade Wizard',
- category: 'upgrade',
- description: 'Execute upgrade wizards after core upgrades.'
+ title: 'Execute Upgrade Wizards',
+ category: 'Core Upgrade',
+ description: 'If you upgrade your TYPO3 installation from e.g. v8 to v9, then Upgrade Wizards guide you through the necessary steps.'
},
2: {partial: 'Upgrade/UpgradeDocs',
require: 'TYPO3/CMS/Install/UpgradeDocs',
baseClass: 't3js-upgradeDocs',
- title: 'Upgrade Documentation',
- category: 'upgrade',
- description: 'Show documentation files describing important changes.'
+ title: 'View Upgrade Documentation',
+ category: 'Core Upgrade',
+ description: 'Show and search documentation files describing important changes between TYPO3 versions.'
},
3: {partial: 'Upgrade/TcaExtTablesCheck',
require: 'TYPO3/CMS/Install/TcaExtTablesCheck',
baseClass: 't3js-tcaExtTablesCheck',
title: 'Check TCA in ext_tables.php',
- category: 'tca',
- description: 'Test if extensions still change TCA in ext_tables.php files'
+ category: 'TCA',
+ description: 'Test if extensions still change TCA in ext_tables.php files, resulting in performance drawbacks.'
},
4: {partial: 'Upgrade/ExtensionCompatTester',
require: 'TYPO3/CMS/Install/ExtensionCompatTester',
baseClass: 't3js-extensionCompatTester',
title: 'Check for broken extensions',
- category: 'extension',
- description: 'Check if loaded extensions main files can be included without errors.'
+ category: 'Extensions',
+ description: 'Check if all base configuration files of currently loaded extensions have errors with the current TYPO3 version.'
},
5: {partial: 'Upgrade/TcaMigrationsCheck',
require: 'TYPO3/CMS/Install/TcaMigrationsCheck',
baseClass: 't3js-tcaMigrationsCheck',
- title: 'Check TCA migrations',
- category: 'tca',
- description: 'Check for needed TCA migrations.'
+ title: 'Check TCA Migrations',
+ category: 'TCA',
+ description: 'Check if third-party extensions have outdated TCA configuration which should be adapted for the current TYPO3 version.'
},
6: {partial: 'Upgrade/ExtensionScanner',
require: 'TYPO3/CMS/Install/ExtensionScanner',
baseClass: 't3js-extensionScanner',
- title: 'Extension scanner',
- category: 'extension',
- description: 'Scan extensions for usage of deprecated and breaking core API.'
+ title: 'Scan Extension Files',
+ category: 'Extensions',
+ description: 'Scan extensions for usage of deprecated or outdated TYPO3 API calls.'
}
}}">
<div class="gridder">
--
GitLab