Skip to content
This repository has been archived by the owner on Oct 28, 2024. It is now read-only.

Commit

Permalink
[TASK] Adjust indentations in "Major upgrade" chapter (#373)
Browse files Browse the repository at this point in the history
Additionally, streamline some spellings.

Releases: main, 12.4

Co-authored-by: Chris Müller <2566282+brotkrueml@users.noreply.github.com>
  • Loading branch information
github-actions[bot] and brotkrueml authored Mar 28, 2024
1 parent 0092a40 commit 2326fc2
Show file tree
Hide file tree
Showing 11 changed files with 142 additions and 147 deletions.
56 changes: 28 additions & 28 deletions Documentation/Major/Index.rst
Original file line number Diff line number Diff line change
@@ -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 <PreupgradeTasks>`
.. rubric:: :ref:`Pre-upgrade tasks <PreupgradeTasks>`

.. 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 <UpgradeCore>`
.. rubric:: :ref:`Upgrade the Core <UpgradeCore>`

.. 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 <PostUpgradeTasks>`
.. rubric:: :ref:`Post-upgrade tasks <PostUpgradeTasks>`

.. 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
Original file line number Diff line number Diff line change
@@ -1,11 +1,11 @@
.. 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
only be displayed in English. Missing languages or translations can be added
following the section
:ref:`Internationalization and Localization <t3coreapi:internationalization>`.

.. include:: /Images/AutomaticScreenshots/AdminTools/InstallLanguagePacks.rst.txt
.. include:: /Images/AutomaticScreenshots/AdminTools/InstallLanguagePacks.rst.txt
8 changes: 4 additions & 4 deletions Documentation/Major/PostupgradeTasks/ClearCaches.rst.txt
Original file line number Diff line number Diff line change
@@ -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.
Expand All @@ -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
38 changes: 18 additions & 20 deletions Documentation/Major/PostupgradeTasks/DatabaseAnalyser.rst.txt
Original file line number Diff line number Diff line change
@@ -1,43 +1,41 @@
.. 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
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.
then all database updates have been applied.
24 changes: 12 additions & 12 deletions Documentation/Major/PostupgradeTasks/Index.rst
Original file line number Diff line number Diff line change
@@ -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
47 changes: 22 additions & 25 deletions Documentation/Major/PostupgradeTasks/UpgradeWizard.rst.txt
Original file line number Diff line number Diff line change
@@ -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`.
Expand All @@ -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 <wizardName>` to run a specific wizard.

Use :bash:`./vendor/bin/typo3 upgrade:run <wizardName>` 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
Expand All @@ -58,18 +56,17 @@ 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`.
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`.
6 changes: 3 additions & 3 deletions Documentation/Major/PostupgradeTasks/UserSettings.rst.txt
Original file line number Diff line number Diff line change
@@ -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
12 changes: 6 additions & 6 deletions Documentation/Major/PreupgradeTasks/Backup.rst.txt
Original file line number Diff line number Diff line change
@@ -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 <ext_core:Index>` to check that.

Expand Down
Loading

0 comments on commit 2326fc2

Please sign in to comment.