From 2326fc220e2b60c60f2baf1e20b96be81cdbfa44 Mon Sep 17 00:00:00 2001 From: "github-actions[bot]" <41898282+github-actions[bot]@users.noreply.github.com> Date: Thu, 28 Mar 2024 07:36:01 +0100 Subject: [PATCH] [TASK] Adjust indentations in "Major upgrade" chapter (#373) MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Additionally, streamline some spellings. Releases: main, 12.4 Co-authored-by: Chris Müller <2566282+brotkrueml@users.noreply.github.com> --- Documentation/Major/Index.rst | 56 +++++++++---------- .../BackendTranslations.rst.txt | 6 +- .../PostupgradeTasks/ClearCaches.rst.txt | 8 +-- .../PostupgradeTasks/DatabaseAnalyser.rst.txt | 38 ++++++------- .../Major/PostupgradeTasks/Index.rst | 24 ++++---- .../PostupgradeTasks/UpgradeWizard.rst.txt | 47 ++++++++-------- .../PostupgradeTasks/UserSettings.rst.txt | 6 +- .../Major/PreupgradeTasks/Backup.rst.txt | 12 ++-- .../Major/PreupgradeTasks/Changelog.rst.txt | 31 +++++----- .../PreupgradeTasks/Deprecations.rst.txt | 37 ++++++------ Documentation/Major/UpgradeCore.rst | 24 ++++---- 11 files changed, 142 insertions(+), 147 deletions(-) diff --git a/Documentation/Major/Index.rst b/Documentation/Major/Index.rst index a80cc77b..c5c1d79e 100644 --- a/Documentation/Major/Index.rst +++ b/Documentation/Major/Index.rst @@ -1,53 +1,53 @@ -.. include:: /Includes.rst.txt -.. _major: +.. include:: /Includes.rst.txt +.. _major: ============= Major upgrade ============= -.. container:: row m-0 p-0 +.. container:: row m-0 p-0 - .. container:: col-md-6 pl-0 pr-3 py-3 m-0 + .. container:: col-md-6 pl-0 pr-3 py-3 m-0 - .. container:: card px-0 h-100 + .. container:: card px-0 h-100 - .. rst-class:: card-header h3 + .. rst-class:: card-header h3 - .. rubric:: :ref:`Pre-upgrade tasks ` + .. rubric:: :ref:`Pre-upgrade tasks ` - .. container:: card-body + .. container:: card-body - Before upgrading TYPO3 to a major release, there are several tasks that can be performed - to help ensure a successful upgrade and help minimise any potential downtime. + Before upgrading TYPO3 to a major release, there are several tasks that can be performed + to help ensure a successful upgrade and help minimise any potential downtime. - .. container:: col-md-6 pl-0 pr-3 py-3 m-0 + .. container:: col-md-6 pl-0 pr-3 py-3 m-0 - .. container:: card px-0 h-100 + .. container:: card px-0 h-100 - .. rst-class:: card-header h3 + .. rst-class:: card-header h3 - .. rubric:: :ref:`Upgrade the core ` + .. rubric:: :ref:`Upgrade the Core ` - .. container:: card-body + .. container:: card-body - This chapter details how to perform a major upgrade using Composer. + This chapter details how to perform a major upgrade using Composer. - .. container:: col-md-6 pl-0 pr-3 py-3 m-0 + .. container:: col-md-6 pl-0 pr-3 py-3 m-0 - .. container:: card px-0 h-100 + .. container:: card px-0 h-100 - .. rst-class:: card-header h3 + .. rst-class:: card-header h3 - .. rubric:: :ref:`Post-upgrade tasks ` + .. rubric:: :ref:`Post-upgrade tasks ` - .. container:: card-body + .. container:: card-body - Once TYPO3's core has been upgraded, there a few tasks that need to be actioned to complete the process. + Once TYPO3's Core has been upgraded, there a few tasks that need to be actioned to complete the process. -.. toctree:: - :hidden: - :titlesonly: +.. toctree:: + :hidden: + :titlesonly: - PreupgradeTasks/Index - UpgradeCore.rst - PostupgradeTasks/Index + PreupgradeTasks/Index + UpgradeCore.rst + PostupgradeTasks/Index diff --git a/Documentation/Major/PostupgradeTasks/BackendTranslations.rst.txt b/Documentation/Major/PostupgradeTasks/BackendTranslations.rst.txt index e5e8a083..ca693f40 100644 --- a/Documentation/Major/PostupgradeTasks/BackendTranslations.rst.txt +++ b/Documentation/Major/PostupgradeTasks/BackendTranslations.rst.txt @@ -1,6 +1,6 @@ -.. include:: /Includes.rst.txt +.. include:: /Includes.rst.txt -.. _update-translations: +.. _update-translations: In the Install tool, go to the module "Maintenance" -> "Manage languages" and update your translations. If you don't update your translations, new texts will @@ -8,4 +8,4 @@ only be displayed in English. Missing languages or translations can be added following the section :ref:`Internationalization and Localization `. -.. include:: /Images/AutomaticScreenshots/AdminTools/InstallLanguagePacks.rst.txt +.. include:: /Images/AutomaticScreenshots/AdminTools/InstallLanguagePacks.rst.txt diff --git a/Documentation/Major/PostupgradeTasks/ClearCaches.rst.txt b/Documentation/Major/PostupgradeTasks/ClearCaches.rst.txt index 9b6b02ff..a3294832 100644 --- a/Documentation/Major/PostupgradeTasks/ClearCaches.rst.txt +++ b/Documentation/Major/PostupgradeTasks/ClearCaches.rst.txt @@ -1,13 +1,13 @@ -.. include:: /Includes.rst.txt +.. include:: /Includes.rst.txt -.. _clear_caches: +.. _clear_caches: You have to clear all caches when upgrading. Go to the :guilabel:`Admin Tools > Maintenance` backend module and click on the :guilabel:`Flush cache` button: -.. include:: /Images/AutomaticScreenshots/AdminTools/ClearAllCache.rst.txt +.. include:: /Images/AutomaticScreenshots/AdminTools/ClearAllCache.rst.txt Additionally, after an upgrade to a new major version, you should also delete the other temporary files, which TYPO3 saves in the :file:`typo3temp/` folder. @@ -21,4 +21,4 @@ appropriate folders. visiting a webpage the next time. This may slow down the first rendering of the webpage. -.. include:: /Images/AutomaticScreenshots/AdminTools/RemoveTemporaryAssets.rst.txt +.. include:: /Images/AutomaticScreenshots/AdminTools/RemoveTemporaryAssets.rst.txt diff --git a/Documentation/Major/PostupgradeTasks/DatabaseAnalyser.rst.txt b/Documentation/Major/PostupgradeTasks/DatabaseAnalyser.rst.txt index d5a81a28..aa458344 100644 --- a/Documentation/Major/PostupgradeTasks/DatabaseAnalyser.rst.txt +++ b/Documentation/Major/PostupgradeTasks/DatabaseAnalyser.rst.txt @@ -1,6 +1,6 @@ -.. include:: /Includes.rst.txt +.. include:: /Includes.rst.txt -.. _database_analyser: +.. _database_analyser: While in the previous step, tables and columns have been *changed or added* to allow running the upgrade wizards smoothly. The next step gives you the @@ -8,36 +8,34 @@ possibility to *remove* old and unneeded tables and columns from the database. Use the "Maintenance section" and click "Analyze Database". -.. include:: /Images/AutomaticScreenshots/AdminTools/DatabaseAnalyzer.rst.txt +.. include:: /Images/AutomaticScreenshots/AdminTools/DatabaseAnalyzer.rst.txt You will be able to execute queries to remove these tables and columns so that your database corresponds to the structure required for the new TYPO3 version. -.. warning:: +.. warning:: + Be careful if you have deliberately added columns and/or tables to your + TYPO3 database for your own purposes! Those tables and columns are removed + only if you mark them to be deleted of course, but please be careful that + you don't delete them by mistake! - Be careful if you have deliberately added columns and/or tables to your - TYPO3 database for your own purposes! Those tables and columns are removed - only if you mark them to be deleted of course, but please be careful that - you don't delete them by mistake! +.. note:: + TYPO3 does not directly remove tables and fields, but first renames them + with a prefix `zzz_deleted_*`. This allows checking whether the fields and + tables really are not needed anymore or were accidentally marked as deleted + by wrong configuration. -.. note:: - - TYPO3 does not directly remove tables and fields, but first renames them - with a prefix `zzz_deleted_*`. This allows checking whether the fields and - tables really are not needed anymore or were accidentally marked as deleted - by wrong configuration. - - When you are sure you aren't going to need them anymore, you can drop them - via the wizard. + When you are sure you aren't going to need them anymore, you can drop them + via the wizard. Select the upgrades you want and press "Execute": -.. include:: /Images/ManualScreenshots/DatabaseAnalyzerUpdatesExecuted.rst.txt +.. include:: /Images/ManualScreenshots/DatabaseAnalyzerUpdatesExecuted.rst.txt When you then click "Compare current database with specification" again and you only see the message -.. include:: /Images/AutomaticScreenshots/AdminTools/DatabaseAnalyzerDatabaseAnalyzed.rst.txt +.. include:: /Images/AutomaticScreenshots/AdminTools/DatabaseAnalyzerDatabaseAnalyzed.rst.txt -then all database updates have been applied. \ No newline at end of file +then all database updates have been applied. diff --git a/Documentation/Major/PostupgradeTasks/Index.rst b/Documentation/Major/PostupgradeTasks/Index.rst index d105a650..a503d470 100644 --- a/Documentation/Major/PostupgradeTasks/Index.rst +++ b/Documentation/Major/PostupgradeTasks/Index.rst @@ -1,42 +1,42 @@ -.. include:: /Includes.rst.txt +.. include:: /Includes.rst.txt -.. _postupgradetasks: +.. _postupgradetasks: ================== Post-upgrade tasks ================== -.. _run_upgrade_wizard: +.. _run_upgrade_wizard: Run the upgrade wizard ====================== -.. include:: UpgradeWizard.rst.txt +.. include:: UpgradeWizard.rst.txt -.. _run_the_database_analyser: +.. _run_the_database_analyser: Run the database analyser ========================= -.. include:: DatabaseAnalyser.rst.txt +.. include:: DatabaseAnalyser.rst.txt -.. _clear_user_settings: +.. _clear_user_settings: Clear user settings =================== -.. include:: UserSettings.rst.txt +.. include:: UserSettings.rst.txt -.. _post_upgrade_clear_caches: +.. _post_upgrade_clear_caches: Clear caches ============ -.. include:: ClearCaches.rst.txt +.. include:: ClearCaches.rst.txt -.. _update_backend_translation: +.. _update_backend_translation: Update backend translations =========================== -.. include:: BackendTranslations.rst.txt +.. include:: BackendTranslations.rst.txt diff --git a/Documentation/Major/PostupgradeTasks/UpgradeWizard.rst.txt b/Documentation/Major/PostupgradeTasks/UpgradeWizard.rst.txt index 51c62bcb..2e1f8813 100644 --- a/Documentation/Major/PostupgradeTasks/UpgradeWizard.rst.txt +++ b/Documentation/Major/PostupgradeTasks/UpgradeWizard.rst.txt @@ -1,11 +1,11 @@ -.. include:: /Includes.rst.txt +.. include:: /Includes.rst.txt -.. _use-the-upgrade-wizard: +.. _use-the-upgrade-wizard: Enter the Install Tool at :samp:`https://example.org/typo3/install.php` on your TYPO3 site. -.. include:: /Images/AutomaticScreenshots/Upgrade/UpgradeWizard.rst.txt +.. include:: /Images/AutomaticScreenshots/Upgrade/UpgradeWizard.rst.txt TYPO3 provides an upgrade wizard for easy upgrading. Go to the :guilabel:`Upgrade` section and choose :guilabel:`Upgrade Wizard`. @@ -22,33 +22,31 @@ sufficient to add them. After you added these tables and columns, go on to the next wizard. -.. hint:: +.. hint:: + If you have CLI access you can run the update wizards on command line, too. + This allows you to run all upgrade wizards at once and might help with + long-running wizards that may fail because of webserver timeouts otherwise. - If you have CLI access you can run the update wizards on command line, too. - This allows you to run all upgrade wizards at once and might help with long - running wizards that may fail because of webserver timeouts otherwise + For Composer mode - For Composer Mode + Run :bash:`./vendor/bin/typo3 upgrade:list -a` to show a complete status of + upgrade wizards. - Run :bash:`./vendor/bin/typo3 upgrade:list -a` to show a complete status of - upgrade wizards. + Use :bash:`./vendor/bin/typo3 upgrade:run ` to run a specific wizard. - Use :bash:`./vendor/bin/typo3 upgrade:run ` to run a specific wizard. + Use :bash:`./vendor/bin/typo3 upgrade:run` to run all wizards. - Use :bash:`./vendor/bin/typo3 upgrade:run` to run all wizards. - - For Classic Mode (Non Composer Mode) replace :bash:`./vendor/bin/typo3` with - `./typo3/sysext/core/bin/typo3`. + For legacy mode (non-Composer mode) replace :bash:`./vendor/bin/typo3` with + `./typo3/sysext/core/bin/typo3`. The "Version Compatibility" wizard sets the compatibility version of your TYPO3 -installation to the new version. This allows your Frontend output to use new +installation to the new version. This allows your frontend output to use new features of the new TYPO3 version. -.. note:: - - This wizard might affect how your website is rendered. After finishing - the upgrade, check that your website still displays the way it is - supposed to be and adjust your TypoScript if necessary. +.. note:: + This wizard might affect how your website is rendered. After finishing + the upgrade, check that your website still displays the way it is + supposed to be and adjust your TypoScript if necessary. Go through all wizards and apply the (database) updates they propose. Please note that some wizards provide optional features, like installing system @@ -58,7 +56,7 @@ Apply the optional wizards too - just be sure to select the correct option (e.g. "No, do not execute"). This way, these wizards will also be removed from the list of wizards to execute and the upgrade will be marked as "done". -.. include:: /Images/ManualScreenshots/UpgradeWizardExecute.rst.txt +.. include:: /Images/ManualScreenshots/UpgradeWizardExecute.rst.txt After running through the upgrade wizards go to :guilabel:`Maintenance` > :guilabel:`Analyze Database Structure`. @@ -66,10 +64,9 @@ You will be able to execute queries to adapt them so that the tables and columns used by the TYPO3 Core correspond to the structure required for the new TYPO3 version. -.. note:: - +.. note:: If you don't know the current Install Tool password, you can set a new one by entering one in the Install Tool login screen, hitting enter and then setting the displayed hash as value of :php:`$GLOBALS['TYPO3_CONF_VARS']['BE']['installToolPassword']` - in :file:`typo3conf/LocalConfiguration.php`. + in :file:`config/system/settings.php`. diff --git a/Documentation/Major/PostupgradeTasks/UserSettings.rst.txt b/Documentation/Major/PostupgradeTasks/UserSettings.rst.txt index 2a72c149..27513865 100644 --- a/Documentation/Major/PostupgradeTasks/UserSettings.rst.txt +++ b/Documentation/Major/PostupgradeTasks/UserSettings.rst.txt @@ -1,10 +1,10 @@ -.. include:: /Includes.rst.txt +.. include:: /Includes.rst.txt -.. _user_settings: +.. _user_settings: You might consider clearing the Backend user preferences. This can avoid problems, if something in the upgrade requires this. Go to "Clean up", scroll to "Reset user preferences" and click "Reset backend user preferences". -.. include:: /Images/AutomaticScreenshots/AdminTools/ResetUserPreferences.rst.txt +.. include:: /Images/AutomaticScreenshots/AdminTools/ResetUserPreferences.rst.txt diff --git a/Documentation/Major/PreupgradeTasks/Backup.rst.txt b/Documentation/Major/PreupgradeTasks/Backup.rst.txt index b1c79d05..48a17db8 100644 --- a/Documentation/Major/PreupgradeTasks/Backup.rst.txt +++ b/Documentation/Major/PreupgradeTasks/Backup.rst.txt @@ -1,16 +1,16 @@ -.. include:: /Includes.rst.txt +.. include:: /Includes.rst.txt -.. _backup: +.. _backup: Make a backup first! If things go wrong, you can at least go back to the old version. You need a backup of -* all files of your TYPO3 installation (by using FTP, SCP, rsync, or any other - method) +* all files of your TYPO3 installation (by using FTP, SCP, rsync, or any other + method) -* the database (by exporting the database to an SQL file) +* the database (by exporting the database to an SQL file) -Also you may prefer to upgrade a copy of your site first, if there have been a +Also, you may prefer to upgrade a copy of your site first, if there have been a lot of changes and some of them might interfere with functions of your site. See the :doc:`changelog ` to check that. diff --git a/Documentation/Major/PreupgradeTasks/Changelog.rst.txt b/Documentation/Major/PreupgradeTasks/Changelog.rst.txt index b3177e30..8e43faf4 100644 --- a/Documentation/Major/PreupgradeTasks/Changelog.rst.txt +++ b/Documentation/Major/PreupgradeTasks/Changelog.rst.txt @@ -1,29 +1,28 @@ -.. include:: /Includes.rst.txt +.. include:: /Includes.rst.txt In addition to the deprecations you may want to read the information about important changes, new features and breaking changes for the release you are updating to. -The ChangeLog is divided into four sections "Breaking Changes", "Features", "Deprecation" and +The changelog is divided into four sections "Breaking Changes", "Features", "Deprecation" and "Important". Before upgrading you should at least take a look at the sections "Breaking Changes" and "Important" - changes described in those areas might affect your website. -.. tip:: - - Breaking changes should be of no concern to you if you already handled the - deprecations before upgrading. +.. tip:: + Breaking changes should be of no concern to you if you already handled the + deprecations before upgrading. The detailed information contains a section called "Affected Installations" which contains hints whether or not your website is affected by the change. -There are 3 different methods you can use to read the Changelogs: +There are 3 different methods you can use to read the changelogs: -#. Look through the :doc:`changelogs ` - online. This has the advantage that code blocks will be formatted nicely with - syntax highlighting. -#. Read the Changelogs in the backend: :guilabel:`Upgrade > View Upgrade Documentation`. - This has the advantage that you can filter by tags and mark individual Changelogs - as done. This way, it is possible to use the list like a todo list. -#. Read the changelog in the :ref:`Extension Scanner ` - (as explained above). +#. Look through the :doc:`changelogs ` + online. This has the advantage that code blocks will be formatted nicely with + syntax highlighting. +#. Read the changelogs in the backend: :guilabel:`Upgrade > View Upgrade Documentation`. + This has the advantage that you can filter by tags and mark individual changelogs + as done. This way, it is possible to use the list like a todo list. +#. Read the changelog in the :ref:`Extension Scanner ` + (as explained above). -.. include:: /Images/AutomaticScreenshots/Upgrade/UpgradeAnalysis.rst.txt +.. include:: /Images/AutomaticScreenshots/Upgrade/UpgradeAnalysis.rst.txt diff --git a/Documentation/Major/PreupgradeTasks/Deprecations.rst.txt b/Documentation/Major/PreupgradeTasks/Deprecations.rst.txt index 77eb7207..c43e5294 100644 --- a/Documentation/Major/PreupgradeTasks/Deprecations.rst.txt +++ b/Documentation/Major/PreupgradeTasks/Deprecations.rst.txt @@ -1,4 +1,4 @@ -.. include:: /Includes.rst.txt +.. include:: /Includes.rst.txt If you notice some API you are using is deprecated, you should look up the corresponding :doc:`changelog ` @@ -13,28 +13,29 @@ or as a standalone tool (https://github.com/tuurlijk/typo3scan). The extension scanner will show the corresponding changelog which contains a description of how to migrate your code. See :ref:`check-the-changelog-and-news-md` -for more information about the Changelogs and how to read them. +for more information about the changelogs and how to read them. -In addition you can use the tool `typo3-rector `__ to automatically refactor the code for a lot of deprecations. +In addition, you can use the tool `typo3-rector `__ +to automatically refactor the code for a lot of deprecations. -.. note:: +.. note:: - TYPO3 aims at providing a reliable backwards compatibility between versions: + TYPO3 aims at providing a reliable backwards compatibility between versions: - * Minor versions are always backwards compatible - unless explicitly stated - otherwise (for example in case of security updates) + * Minor versions are always backwards compatible - unless explicitly stated + otherwise (for example in case of security updates) - * Major versions may contain breaking changes - normally these are - deprecated one major version in advance + * Major versions may contain breaking changes - normally these are + deprecated one major version in advance - * Most breaking changes usually happen in the first Sprint Release + * Most breaking changes usually happen in the first Sprint Release - If PHP classes, methods, constants, functions or parameters are to be - removed, they will be *marked as deprecated* first and not removed until the - next major release of TYPO3. For example: a method that gets deprecated in - version 9.4.0 will remain fully functional in all 9.x.x releases, but will - be removed in version 10. + If PHP classes, methods, constants, functions or parameters are to be + removed, they will be *marked as deprecated* first and not removed until the + next major release of TYPO3. For example: a method that gets deprecated in + version 12.3.0 will remain fully functional in all 12.x.y releases, but will + be removed in version 13. - This strategy gives developers sufficient time to adjust their TYPO3 - extensions, assuming many agencies upgrade from one LTS release to the next - (usually 1.5 years). + This strategy gives developers sufficient time to adjust their TYPO3 + extensions, assuming many agencies upgrade from one LTS release to the next + (usually 1.5 years). diff --git a/Documentation/Major/UpgradeCore.rst b/Documentation/Major/UpgradeCore.rst index db9d5ca0..4132bc67 100644 --- a/Documentation/Major/UpgradeCore.rst +++ b/Documentation/Major/UpgradeCore.rst @@ -1,6 +1,6 @@ -.. include:: /Includes.rst.txt +.. include:: /Includes.rst.txt -.. _upgradecore: +.. _upgradecore: ================ Upgrade the Core @@ -55,16 +55,16 @@ be used to help generate the Composer upgrade command. Assuming that the packages below are installed locally, the following example would upgrade each of them to version 12.4. -.. code-block:: bash +.. code-block:: bash - composer require --update-with-all-dependencies "typo3/cms-adminpanel:^12.4" \ - "typo3/cms-backend:^12.4" "typo3/cms-belog:^12.4" "typo3/cms-beuser:^12.4" \ - "typo3/cms-core:^12.4" "typo3/cms-dashboard:^12.4" "typo3/cms-felogin:^12.4" \ - "typo3/cms-filelist:^12.4" "typo3/cms-filemetadata:^12.4" "typo3/cms-fluid:^12.4" \ - "typo3/cms-form:^12.4" "typo3/cms-frontend:^12.4" "typo3/cms-info:^12.4" \ - "typo3/cms-install:^12.4" "typo3/cms-linkvalidator:^12.4" "typo3/cms-lowlevel:^12.4" \ - "typo3/cms-recycler:^12.4" "typo3/cms-rte-ckeditor:^12.4" "typo3/cms-setup:^12.4" \ - "typo3/cms-t3editor:^12.4" "typo3/cms-tstemplate:^12.4" "typo3/cms-viewpage:^12.4" + composer require --update-with-all-dependencies "typo3/cms-adminpanel:^12.4" \ + "typo3/cms-backend:^12.4" "typo3/cms-belog:^12.4" "typo3/cms-beuser:^12.4" \ + "typo3/cms-core:^12.4" "typo3/cms-dashboard:^12.4" "typo3/cms-felogin:^12.4" \ + "typo3/cms-filelist:^12.4" "typo3/cms-filemetadata:^12.4" "typo3/cms-fluid:^12.4" \ + "typo3/cms-form:^12.4" "typo3/cms-frontend:^12.4" "typo3/cms-info:^12.4" \ + "typo3/cms-install:^12.4" "typo3/cms-linkvalidator:^12.4" "typo3/cms-lowlevel:^12.4" \ + "typo3/cms-recycler:^12.4" "typo3/cms-rte-ckeditor:^12.4" "typo3/cms-setup:^12.4" \ + "typo3/cms-t3editor:^12.4" "typo3/cms-tstemplate:^12.4" "typo3/cms-viewpage:^12.4" A typical TYPO3 installation is likely to have multiple third-party extensions installed and running the above command can create dependency errors. @@ -89,7 +89,7 @@ also be found by searching in the :doc:`changelogs ` for the extension by its key name. -.. _install-next-step: +.. _install-next-step: Next steps ==========