6
6
Migration
7
7
=========
8
8
9
- If you want to migrate from using Sphinx to render TYPO3 documentation to
9
+ If you want to migrate from using Sphinx to render TYPO3 documentation
10
10
using the render-guides, the file :file: `Documentation/Settings.cfg ` has to be
11
11
replaced by an XML file, :file: `Documentation/guides.xml `.
12
12
@@ -25,27 +25,53 @@ With official Docker container
25
25
Work in progress - Note that we will use `:stable ` at a later point to always provide stable
26
26
images with a locked dependency and theme asset set.
27
27
28
- .. code-block :: sh
28
+ To migrate your settings to the new rendering method, run the following
29
+ command in your project's root folder:
29
30
30
- docker run --rm --pull always -v $( pwd) :/project -it ghcr.io/typo3-documentation/render-guides:latest migrate /path/to/Documentation
31
+ .. code-block :: shell
32
+
33
+ docker run --rm --pull always -v $( pwd) :/project -it ghcr.io/typo3-documentation/render-guides:latest migrate Documentation
34
+
35
+ The last option is the folder (here: :file: `Documentation `). When running the
36
+ command from another folder than the project's root folder, adapt the given
37
+ path accordingly.
31
38
32
39
With make
33
40
=========
34
41
35
- .. code-block :: sh
42
+ To migrate your settings to the new rendering method, run the following
43
+ command in your project's root folder:
44
+
45
+ .. code-block :: shell
46
+
47
+ make migrate-settings path=Documentation
36
48
37
- make migrate-settings path=path/to/Documentation
49
+ When running the command from another folder than the project's root folder,
50
+ adapt the given path accordingly.
38
51
39
52
With ddev
40
53
=========
41
54
42
- .. code-block :: sh
55
+ To migrate your settings to the new rendering method, run the following
56
+ command in your project's root folder:
43
57
44
- ddev composer make migrate-settings path=path/to/Documentation
58
+ .. code-block :: shell
59
+
60
+ ddev composer make migrate-settings path=Documentation
61
+
62
+ When running the command from another folder than the project's root folder,
63
+ adapt the given path accordingly.
45
64
46
65
With PHP
47
66
========
48
67
49
- .. code-block :: sh
68
+ To migrate your settings to the new rendering method, run the following
69
+ command in your project's root folder:
70
+
71
+ .. code-block :: shell
72
+
73
+ packages/typo3-guides-cli/bin/typo3-guides migrate Documentation
50
74
51
- packages/typo3-guides-cli/bin/typo3-guides migrate path/to/Documentation
75
+ The last option is the folder (here: :file: `Documentation `). When running the
76
+ command from another folder than the project's root folder, adapt the given
77
+ path accordingly.
0 commit comments