diff --git a/Documentation/WritingDocForExtension/_Makefile b/Documentation/CodeSnippets/_Makefile similarity index 100% rename from Documentation/WritingDocForExtension/_Makefile rename to Documentation/CodeSnippets/_Makefile diff --git a/Documentation/WritingDocForExtension/_documentation.yml b/Documentation/CodeSnippets/_documentation.yml similarity index 100% rename from Documentation/WritingDocForExtension/_documentation.yml rename to Documentation/CodeSnippets/_documentation.yml diff --git a/Documentation/Index.rst b/Documentation/Index.rst index 060e740b..14a7015a 100644 --- 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 ` + + .. 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/Documentation/WritingDocForExtension/Migrate.rst b/Documentation/Migration/Index.rst similarity index 98% rename from Documentation/WritingDocForExtension/Migrate.rst rename to Documentation/Migration/Index.rst index 53828c69..3fc22fe5 100644 --- a/Documentation/WritingDocForExtension/Migrate.rst +++ b/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 index 191f81d2..07751a79 100644 --- 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 `. + This chapter explains how to write documentation for a new extension. This guide uses the `example extension manual `__ @@ -152,7 +156,6 @@ The rendering supports two branches within repositories: :maxdepth: 1 :hidden: - Migrate Webhook ReregisterVersions FAQ