Skip to content

Commit

Permalink
[TASK] Document Includes.rst.txt (#447)
Browse files Browse the repository at this point in the history
Resolves #433
  • Loading branch information
linawolf authored Jul 28, 2024
1 parent 1125aec commit 650d593
Show file tree
Hide file tree
Showing 2 changed files with 33 additions and 0 deletions.
3 changes: 3 additions & 0 deletions Documentation/Reference/FileStructure.rst
Original file line number Diff line number Diff line change
Expand Up @@ -171,6 +171,9 @@ that:
Maintainers/Index
.. include:: _FileStructure/_Includes.rst.txt
:show-buttons:

.. index:: File structure; Documentation/Sitemap.rst, Sitemap.rst
.. _sitemap-rst:

Expand Down
30 changes: 30 additions & 0 deletions Documentation/Reference/_FileStructure/_Includes.rst.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
.. _includes-rst-txt:

Optional: :file:`Documentation/Includes.rst.txt`
------------------------------------------------

The :file:`Includes.rst.txt` is optional for Extension documentation. We use
it by convention in all official documentation.

By default it only contains a comment:

.. code-block:: rst
:caption: Documentation/Includes.rst.txt
.. You can put central messages to display on all pages here
In the official documentation we use it to mark outdated and eLTS versions:

.. code-block:: rst
:caption: Documentation/Includes.rst.txt
.. You can put central messages to display on all pages here
.. attention::
TYPO3 v10 has reached end-of-life as of April 30th 2023 and
is no longer being maintained. [...]
Before :ref:`migration <migrate>` to the new rendering it also contained
configuration settings. All those have been moved to the
:ref:`guides.xml <guides-xml>` or have been replaced by defaults in our theme
implementation.

0 comments on commit 650d593

Please sign in to comment.