Skip to content

Commit 6cf9a13

Browse files
authored
[DOCS] Adapt path to Documentation folder on migration (#232)
Most users would run the command in the project's root folder (like now for the Sphinx rendering method). This change eases running the command, as it is just copy'n'paste now.
1 parent ba7219b commit 6cf9a13

File tree

1 file changed

+35
-9
lines changed

1 file changed

+35
-9
lines changed

Documentation/Migration/Index.rst

Lines changed: 35 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66
Migration
77
=========
88

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
1010
using the render-guides, the file :file:`Documentation/Settings.cfg` has to be
1111
replaced by an XML file, :file:`Documentation/guides.xml`.
1212

@@ -25,27 +25,53 @@ With official Docker container
2525
Work in progress - Note that we will use `:stable` at a later point to always provide stable
2626
images with a locked dependency and theme asset set.
2727

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:
2930

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.
3138

3239
With make
3340
=========
3441

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
3648
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.
3851

3952
With ddev
4053
=========
4154

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:
4357

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.
4564

4665
With PHP
4766
========
4867

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
5074
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

Comments
 (0)