Migration
If you want to migrate from using Sphinx to render TYPO3 documentation
using the render-guides, the file Documentation/
has to be
replaced by an XML file, Documentation/
.
To facilitate migration the extension t3docs/
in this
mono-repository comes with a Symfony console command to automatically migrate
the outdated Settings.
.
After migration, you can add your guides.
file to your custom repository,
and optionally also remove the old Settings.
file.
With official Docker container
Note
Work in progress - Note that we will use :stable
at a later point to always provide stable
images with a locked dependency and theme asset set.
To migrate your settings to the new rendering method, run the following command in your project's root folder:
docker run --rm --pull always -v $(pwd):/project -it ghcr.io/typo3-documentation/render-guides:latest migrate Documentation
The last option is the folder (here: Documentation
). When running the
command from another folder than the project's root folder, adapt the given
path accordingly.
Note
Note that the parameter -v $
always uses project
as
the directory name. You do not need to replace that directory name with
anything else, because the container rendering depends on this.
With make
To migrate your settings to the new rendering method, run the following command in your project's root folder:
make migrate-settings path=Documentation
When running the command from another folder than the project's root folder, adapt the given path accordingly.
With ddev
To migrate your settings to the new rendering method, run the following command in your project's root folder:
ddev composer make migrate-settings path=Documentation
When running the command from another folder than the project's root folder, adapt the given path accordingly.
With PHP
To migrate your settings to the new rendering method, run the following command in your project's root folder:
packages/typo3-guides-cli/bin/typo3-guides migrate Documentation
The last option is the folder (here: Documentation
). When running the
command from another folder than the project's root folder, adapt the given
path accordingly.