Migration¶

If you want to migrate from using Sphinx to render TYPO3 documentation to using the render-guides, the file Documentation/Settings.cfg has to be replaced by an XML file, Documentation/guides.xml.

To facilitate migration the extension t3docs/typo3-guides-cli in this mono-repository comes with a Symfony console command to automatically migrate the outdated Settings.cfg.

After migration, you can add your guides.xml file to your custom repository, and optionally also remove the old Settings.cfg 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.

docker run --rm --pull always -v $(pwd):/project -it ghcr.io/typo3-documentation/render-guides:main migrate /path/to/Documentation

With make¶

make migrate-settings path=path/to/Documentation

With ddev¶

ddev composer make migrate-settings path=path/to/Documentation

With PHP¶

packages/typo3-guides-cli/bin/typo3-guides migrate path/to/Documentation