-
Notifications
You must be signed in to change notification settings - Fork 111
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
[TASK] Document Includes.rst.txt (#447)
Resolves #433
- Loading branch information
Showing
2 changed files
with
33 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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. |