From 95fdf47d2d8db693b9754d4e87bf0fcd6c419a61 Mon Sep 17 00:00:00 2001 From: Lina Wolf <112@linawolf.de> Date: Mon, 25 Mar 2024 18:39:34 +0100 Subject: [PATCH] [DOCS] Switch changelog documentation to PHP-based rendering You can try out the rendering locally with ``` cd typo3/sysext/core docker run --rm --pull always -v $(pwd):/project -it ghcr.io/typo3-documentation/render-guides:latest --config=Documentation ``` Resolves: #103484 Releases: main Change-Id: I3e0645fd8e0d27afeb9857945da444520b416a7e Reviewed-on: https://review.typo3.org/c/Packages/TYPO3.CMS/+/83588 Tested-by: core-ci <typo3@b13.com> Tested-by: Benni Mack <benni@typo3.org> Reviewed-by: Lina Wolf <112@linawolf.de> Reviewed-by: Benni Mack <benni@typo3.org> Reviewed-by: Garvin Hicking <gh@faktor-e.de> Tested-by: Lina Wolf <112@linawolf.de> --- .../core/Documentation/Includes.rst.txt | 36 +--------- typo3/sysext/core/Documentation/Settings.cfg | 65 ------------------- typo3/sysext/core/Documentation/guides.xml | 23 +++++++ 3 files changed, 24 insertions(+), 100 deletions(-) delete mode 100644 typo3/sysext/core/Documentation/Settings.cfg create mode 100644 typo3/sysext/core/Documentation/guides.xml diff --git a/typo3/sysext/core/Documentation/Includes.rst.txt b/typo3/sysext/core/Documentation/Includes.rst.txt index b981f2fb5649..236250747b4d 100644 --- a/typo3/sysext/core/Documentation/Includes.rst.txt +++ b/typo3/sysext/core/Documentation/Includes.rst.txt @@ -1,35 +1 @@ -.. More information about this file: - https://docs.typo3.org/m/typo3/docs-how-to-document/main/en-us/GeneralConventions/FileStructure.html#includes-rst-txt - -.. ---------- -.. text roles -.. ---------- - -.. role:: aspect(emphasis) -.. role:: bash(code) -.. role:: css(code) -.. role:: html(code) -.. role:: js(code) -.. role:: php(code) -.. role:: rst(code) -.. role:: sep(strong) -.. role:: sql(code) - -.. role:: tsconfig(code) - :class: typoscript - -.. role:: typoscript(code) -.. role:: xml(code) - :class: html - -.. role:: yaml(code) - -.. default-role:: code - -.. --------- -.. highlight -.. --------- - -.. By default, code blocks use PHP syntax highlighting - -.. highlight:: php +.. You can put central messages to display on all pages here diff --git a/typo3/sysext/core/Documentation/Settings.cfg b/typo3/sysext/core/Documentation/Settings.cfg deleted file mode 100644 index f8426a2d9b83..000000000000 --- a/typo3/sysext/core/Documentation/Settings.cfg +++ /dev/null @@ -1,65 +0,0 @@ -# More information about this file: -# https://docs.typo3.org/m/typo3/docs-how-to-document/main/en-us/GeneralConventions/FileStructure.html#settings-cfg - -[general] - -project = Core -version = main (development) -release = main (development) -copyright = since 1997 by the TYPO3 contributors - -[html_theme_options] - -# "Edit on GitHub" button -github_repository = typo3/typo3 -github_branch = main -path_to_documentation_dir = typo3/sysext/core/Documentation/ - -# Footer links -project_home = https://extensions.typo3.org/extension/core/ -project_contact = https://typo3.slack.com/archives/C025BQLFA -project_repository = https://github.com/typo3/typo3 -project_issues = https://forge.typo3.org/projects/typo3cms-core/issues -project_discussions = - -use_opensearch = - -[intersphinx_mapping] - -# Official TYPO3 manuals -h2document = https://docs.typo3.org/m/typo3/docs-how-to-document/main/en-us/ -# t3content = https://docs.typo3.org/m/typo3/guide-contentandmarketing/main/en-us/ -# t3contribute = https://docs.typo3.org/m/typo3/guide-contributionworkflow/main/en-us/ -t3coreapi = https://docs.typo3.org/m/typo3/reference-coreapi/main/en-us/ -# t3editors = https://docs.typo3.org/m/typo3/tutorial-editors/main/en-us/ -# t3extexample = https://docs.typo3.org/m/typo3/guide-example-extension-manual/main/en-us/ -# t3home = https://docs.typo3.org/ -# t3sitepackage = https://docs.typo3.org/m/typo3/tutorial-sitepackage/main/en-us/ -# t3start = https://docs.typo3.org/m/typo3/tutorial-getting-started/main/en-us/ -t3tca = https://docs.typo3.org/m/typo3/reference-tca/main/en-us/ -# t3translate = https://docs.typo3.org/m/typo3/guide-frontendlocalization/main/en-us/ -t3tsconfig = https://docs.typo3.org/m/typo3/reference-tsconfig/main/en-us/ -t3tsref = https://docs.typo3.org/m/typo3/reference-typoscript/main/en-us/ -# t3ts45 = https://docs.typo3.org/m/typo3/tutorial-typoscript-in-45-minutes/main/en-us/ -# t3viewhelper = https://docs.typo3.org/other/typo3/view-helper-reference/main/en-us/ -# t3upgrade = https://docs.typo3.org/m/typo3/guide-installation/main/en-us/ - -# TYPO3 system extensions -# ext_adminpanel = https://docs.typo3.org/c/typo3/cms-adminpanel/main/en-us/ -# ext_core = https://docs.typo3.org/c/typo3/cms-core/main/en-us/ -# ext_dashboard = https://docs.typo3.org/c/typo3/cms-dashboard/main/en-us/ -# ext_felogin = https://docs.typo3.org/c/typo3/cms-felogin/main/en-us/ -# ext_form = https://docs.typo3.org/c/typo3/cms-form/main/en-us/ -# ext_fsc = https://docs.typo3.org/c/typo3/cms-fluid-styled-content/main/en-us/ -# ext_impexp = https://docs.typo3.org/c/typo3/cms-impexp/main/en-us/ -# ext_indexed_search = https://docs.typo3.org/c/typo3/cms-indexed-search/main/en-us/ -ext_linkvalidator = https://docs.typo3.org/c/typo3/cms-linkvalidator/main/en-us/ -# ext_lowlevel = https://docs.typo3.org/c/typo3/cms-lowlevel/main/en-us/ -ext_reactions = https://docs.typo3.org/c/typo3/cms-reactions/main/en-us/ -# ext_recycler = https://docs.typo3.org/c/typo3/cms-recycler/main/en-us/ -# ext_redirects = https://docs.typo3.org/c/typo3/cms-redirects/main/en-us/ -# ext_reports = https://docs.typo3.org/c/typo3/cms-reports/main/en-us/ -# ext_rte_ckeditor = https://docs.typo3.org/c/typo3/cms-rte-ckeditor/main/en-us/ -# ext_scheduler = https://docs.typo3.org/c/typo3/cms-scheduler/main/en-us/ -# ext_seo = https://docs.typo3.org/c/typo3/cms-seo/main/en-us/ -# ext_workspaces = https://docs.typo3.org/c/typo3/cms-workspaces/main/en-us/ diff --git a/typo3/sysext/core/Documentation/guides.xml b/typo3/sysext/core/Documentation/guides.xml new file mode 100644 index 000000000000..326241d64dad --- /dev/null +++ b/typo3/sysext/core/Documentation/guides.xml @@ -0,0 +1,23 @@ +<?xml version="1.0" encoding="UTF-8"?> +<guides xmlns="https://www.phpdoc.org/guides" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" + xsi:schemaLocation="https://www.phpdoc.org/guides ../vendor/phpdocumentor/guides-cli/resources/schema/guides.xsd" + links-are-relative="true" + max-menu-depth="2" +> + <extension class="\T3Docs\Typo3DocsTheme\DependencyInjection\Typo3DocsThemeExtension" + project-home="https://extensions.typo3.org/extension/core/" + project-contact="https://typo3.slack.com/archives/C025BQLFA" + project-repository="https://github.com/typo3/typo3" + project-issues="https://forge.typo3.org/projects/typo3cms-core/issues" + edit-on-github-branch="main" + edit-on-github="typo3/typo3" + edit-on-github-directory="typo3/sysext/core/Documentation/" + typo3-core-preferred="main" + interlink-shortcode="changelog" + /> + <project title="Core" + release="main (development)" + version="main (development)" + copyright="since 1997 by the TYPO3 contributors" + /> +</guides> -- GitLab