[TASK] Move migration chapter a level up

And advertise it on the front page.
TYPO3-Documentation · Apr 16, 2024 · 28ccd1d · 28ccd1d
1 parent 3eb3cfc
commit 28ccd1d
Show file tree

Hide file tree

Showing 5 changed files with 21 additions and 4 deletions.
diff --git a/...entation/WritingDocForExtension/_Makefile → Documentation/CodeSnippets/_Makefile b/...entation/WritingDocForExtension/_Makefile → Documentation/CodeSnippets/_Makefile
diff --git a/...WritingDocForExtension/_documentation.yml → ...mentation/CodeSnippets/_documentation.yml b/...WritingDocForExtension/_documentation.yml → ...mentation/CodeSnippets/_documentation.yml
diff --git a/Documentation/Index.rst b/Documentation/Index.rst
@@ -31,6 +31,20 @@ reST and Sphinx.
 
 ----
 
+.. container:: row m-0 p-0
+
+   .. container:: col-md-6 pl-0 pr-3 py-3 m-0
+
+      .. container:: card px-0 h-100
+
+         .. rst-class:: card-header h3
+
+            .. rubric:: :ref:`Migration <migrate>`
+
+         .. container:: card-body
+
+            Migrate your documentation to the new, PHP-based reST rendering.
+
 .. container:: row m-0 p-0
 
    .. container:: col-md-6 pl-0 pr-3 py-3 m-0
@@ -113,6 +127,7 @@ What's new in this guide?
    :hidden:
    :caption: HOWTOS
 
+   Migration/Index
    WritingDocForExtension/Index
    WritingDocsOfficial/Index
    RenderingDocs/Index

diff --git a/...tation/WritingDocForExtension/Migrate.rst → Documentation/Migration/Index.rst b/...tation/WritingDocForExtension/Migrate.rst → Documentation/Migration/Index.rst
@@ -3,7 +3,6 @@
     Documentation; Migration
     docs.typo3.org
 ..  _migrate:
-..  _register-for-rendering:
 
 =============================================
 Migration: From Sphinx to PHP-based rendering
@@ -182,7 +181,7 @@ https://github.com/TYPO3-Documentation/render-guides/blob/main/Makefile
 
 A small example :file:`Makefile`:
 
-..  literalinclude:: _Makefile
+..  literalinclude:: /CodeSnippets/_Makefile
     :caption: Makefile
 
 ..  hint::
@@ -209,7 +208,7 @@ ensure the extension's documentation renders without warnings.
 An example workflow on GitHub would be established via this file in
 :file:`.github/actions/documentation.yml`:
 
-..  literalinclude:: _documentation.yml
+..  literalinclude:: /CodeSnippets/_documentation.yml
     :caption: .github/actions/documentation.yml
 
 

diff --git a/Documentation/WritingDocForExtension/Index.rst b/Documentation/WritingDocForExtension/Index.rst
@@ -10,6 +10,10 @@
 How to document an extension
 ============================
 
+..  hint::
+    If your extension does not have a file :file:`EXT:my_extension/Documentation/guides.xml`
+    you should :ref:`migrate to the new PHP-based rendering <migrate>`.
+
 This chapter explains how to write documentation for a new extension.
 
 This guide uses the `example extension manual <https://github.com/TYPO3-Documentation/TYPO3CMS-Example-ExtensionManual>`__
@@ -152,7 +156,6 @@ The rendering supports two branches within repositories:
    :maxdepth: 1
    :hidden:
 
-   Migrate
    Webhook
    ReregisterVersions
    FAQ