Skip to content

Commit

Permalink
[DOC] Update migration guide
Browse files Browse the repository at this point in the history
  • Loading branch information
@flossels
flossels committed Jun 10, 2020
1 parent cc9d0f2 commit 92f7f7d
Show file tree
Hide file tree
Showing 2 changed files with 62 additions and 25 deletions.
37 changes: 36 additions & 1 deletion Documentation/About/Changelog/3-3-0.rst
View file
Original file line number Diff line number Diff line change
Expand Up @@ -4,9 +4,14 @@
Version 3.3.0 - TBA
===================

This is a feature release. It is estimated for the 3rd quarter of 2020.
This is a feature release. It is estimated for the mid of June.

TODO: Link to PSR-14 Event documentation and add documentation for obsolete hook.
TODO: Add this file to table of contents
TODO: Migration guide
TODO: Documentation BE Module
TODO: Link to BE Module documentation
TODO: Deprecation notices on typoscript roles and propertyMapping documentation

Download
========
Expand All @@ -21,6 +26,7 @@ Added
:php:`$GLOBALS['TYPO3_CONF_VARS']['SC_OPTIONS']['t3lib/class.t3lib_userauth.php']['auth0']['redirect_pre_processing']` hook
* `Settings.yaml` file for listening to PSR-14 events in TYPO3 v10
* Event listener for adding parameters to :php:`$GLOBALS['TYPO3_CONF_VARS']['FE']['cacheHash']['excludedParameters']`
* Dedicated backend module for handling data mapping and applications

Changed
=======
Expand All @@ -33,12 +39,41 @@ Deprecated
* Hook :php:`$GLOBALS['TYPO3_CONF_VARS']['SC_OPTIONS']['t3lib/class.t3lib_userauth.php']['auth0']['redirect_pre_processing']` is
now deprecated and will be removed with next major version. You should use the newly introduced PSR-14 Event where possible
* Using signal `afterExtensionInstall` of class :php:`TYPO3\CMS\Extensionmanager\Utility\InstallUtility`
* Following TypoScript settings are now deprecated: :typoscript:`plugin.tx_auth0.settings.roles` and
:typoscript:`plugin.tx_auth0.settings.propertyMapping`. You should use the newly introduced backend module instead.

All Changes
===========

This is a list of all changes in this release::

2020-06-10 [TASK] Use existing property (Commit 443acf4 by Florian Wessels)
2020-06-10 [BUGFIX] Disable logging (Commit ea23555 by Florian Wessels)
2020-06-10 [TASK] Mark classes as final (Commit 509c427 by Florian Wessels)
2020-06-10 [FEATURE] Introduce module for property mapping (Commit 2df082a by Florian Wessels)
2020-06-09 [BUGFIX][DOC] Spelling (Commit 716d9cc by Florian Wessels)
2020-06-09 [TASK] Add application list to backend module (Commit 8207b5f by Florian Wessels)
2020-06-08 [TASK] Load roles key from TypoScript configuration (Commit de408ff by Florian Wessels)
2020-06-08 [TASK] Try to load defaults from TCA (Commit 381c9e3 by Florian Wessels)
2020-06-08 [TASK] Assign default backend role only if user is not an admin (Commit da6b017 by Florian Wessels)
2020-06-08 [BUGFIX] Assign default properties to new backend users (Commit d8e6c58 by Florian Wessels)
2020-06-08 [TASK] Assign admin flag even if no TypoScript exists (Commit 882a0ee by Florian Wessels)
2020-06-08 [TASK] Add german translations for new features (Commit 5ea89d2 by Florian Wessels)
2020-06-08 [TASK] Restructrue roles view (Commit 8f4ac09 by Florian Wessels)
2020-06-08 [TASK] Update labels (Commit 380aaf0 by Florian Wessels)
2020-06-08 [TASK] Allow to import admin flag (Commit b8b2311 by Florian Wessels)
2020-06-08 [BUGFIX] Use proper values (Commit 93d05cd by Florian Wessels)
2020-06-08 [TASK] Allow to set default groups and admin roles (Commit fd14f5c by Florian Wessels)
2020-06-08 [BUGFIX] Get rid of EXT:redirects middleware override (Commit 2ca8345 by Florian Wessels)
2020-06-08 [FEATURE] Add german translations (Commit 1972097 by Florian Wessels)
2020-06-06 [TASK] Allow to import TS settings (Commit 72bef43 by Florian Wessels)
2020-06-05 [TASK] Add labels for module (Commit 6dbd90f by Florian Wessels)
2020-06-05 [FEATURE] Add GUI for be_groups mapping (Commit f40dd64 by Florian Wessels)
2020-06-05 [FEATURE] Introduce dedicated backend module for handling group mapping (Commit ddaf0b4 by Florian Wessels)
2020-06-05 [TASK] Improve logging for debug purposes (Commit 6e686bc by Florian Wessels)
2020-06-05 [TASK] Adapt php CS to TYPO3 defaults (Commit 238b3b1 by Florian Wessels)
2020-06-05 [TASK] Use constants (Commit 6bf10fd by Florian Wessels)
2020-06-04 [TASK] Raise version to 3.3.0-dev (Commit 57a861d by Florian Wessels)
2020-06-04 [TASK] Add event for TYPO3 v10 (Commit 2b8d70c by Florian Wessels)
2020-06-04 [TASK] Apply CS (Commit c65f6fc by Florian Wessels)
2020-06-04 [TASK] Update funding file (Commit 6ffa5db by Florian Wessels)
Expand Down
50 changes: 26 additions & 24 deletions Documentation/Admin/Migrations/BackendModule.rst
View file
Original file line number Diff line number Diff line change
Expand Up @@ -9,41 +9,43 @@ TypoScript to Backend Module
If you update this extension from a version lower than 3.3.0, you must follow these steps to get rid of obsolete TypoScript
settings.

.. rst-class:: bignums
.. rst-class:: bignums-xxl

1. Make your TypoScript available for the backend module
1. Make your TypoScript available for the backend module

The TypoScript settings of both :typoscript:`plugin.tx_auth0.settings.roles` and
:typoscript:`plugin.tx_auth0.settings.propertyMapping` has to be available for the backend module. You can archive this by
adding following lines of TypoScript at the bottom of your TypoScript template:
The TypoScript settings of both :typoscript:`plugin.tx_auth0.settings.roles` and
:typoscript:`plugin.tx_auth0.settings.propertyMapping` has to be available for the backend module. You can archive this by
adding following lines of TypoScript at the bottom of your TypoScript template:

:typoscript:`module.tx_auth0.settings.roles < plugin.tx_auth0.settings.roles`
:typoscript:`module.tx_auth0.settings.propertyMapping < plugin.tx_auth0.settings.propertyMapping`
.. codeblock:: typoscript

2. Migrate the role mapping
module.tx_auth0.settings.roles < plugin.tx_auth0.settings.roles
module.tx_auth0.settings.propertyMapping < plugin.tx_auth0.settings.propertyMapping

Navigate into the Auth0 backend module and click on the "configure" button in the "Roles to Groups" card. There should be an
info box on top of the content. Click on the "Import configuration from TypoScript" button. After the page refreshed, the
module will output the configuration migrated from you TypoScript.
2. Migrate the role mapping

.. figure:: ../../Images/migrate-backend-module.png
:alt: The backend module.
:class: with-shadow
Navigate into the Auth0 backend module and click on the "configure" button in the "Roles to Groups" card. There should be an
info box on top of the content. Click on the "Import configuration from TypoScript" button. After the page refreshed, the
module will output the configuration migrated from you TypoScript.

View of the backend module.
.. figure:: ../../Images/migrate-backend-module.png
:alt: The backend module.
:class: with-shadow

.. rst-class:: bignums
View of the backend module.

3. Migrate the property mapping
3. Migrate the property mapping

Select the "Property Mapping" option of the select box on top of the page and proceed as described in 2.
Select the "Property Mapping" option of the select box on top of the page and proceed as described in 2.

4. Unset your TypoScript
4. Unset your TypoScript

Open your TypoScript template and unset the former configuration:
Open your TypoScript template and unset the former configuration:

:typoscript:`plugin.tx_auth0.settings.roles >`
:typoscript:`plugin.tx_auth0.settings.propertyMapping >`
.. codeblock:: typoscript

Do not forget to let the :typoscript:`module.tx_auth0` configuration extend the :typoscript:`plugin.tx_auth0` configuration.
Afterwards the info boxes in the backend module should be disappeared.
plugin.tx_auth0.settings.roles >
plugin.tx_auth0.settings.propertyMapping >

Do not forget to let the :typoscript:`module.tx_auth0` configuration extend the :typoscript:`plugin.tx_auth0` configuration.
Afterwards the info boxes in the backend module should be disappeared.

0 comments on commit 92f7f7d

Please sign in to comment.