Skip to content
This repository has been archived by the owner on Oct 31, 2024. It is now read-only.

[TASK] Make TypoScript documentation clearer and more consistent #86

Merged

Conversation

PKuhlmay
Copy link
Contributor

Enhanced TypoScript documentation by fixing minor formatting issues, standardizing element list syntax, and improving clarity. Added a screenshot to illustrate the renamed "TypoScript" module in CMS version 12. Further refined texts and syntax for better readability.

Enhanced TypoScript documentation by fixing minor formatting issues, standardizing element list syntax, and improving clarity. Added a screenshot to illustrate the renamed "TypoScript" module in CMS version 12. Further refined texts and syntax for better readability.
@linawolf
Copy link
Member

Thanks alot for adressing this long neglected tutorial!

@linawolf
Copy link
Member

If you rebase onto main the issues with the automatic tests are resolved

@linawolf linawolf merged commit be8d254 into TYPO3-Documentation:main Oct 31, 2024
1 check failed
Copy link

The backport to 13.4 failed:

The process '/usr/bin/git' failed with exit code 128
stderr
error: commit e6dd65b18930f1c7443c3dc76d892ea7294fa76c is a merge but no -m option was given.
fatal: cherry-pick failed

stdout
Auto-merging Documentation/TypoScriptOverview/TheTermTemplate/Index.rst
[backport-86-to-13.4 1334112] [TASK] Make TypoScript documentation clearer and more consistent
 Author: Philipp Kuhlmay <info@treupo.de>
 Date: Fri Oct 25 16:20:05 2024 +0200
 13 files changed, 60 insertions(+), 49 deletions(-)
 create mode 100644 Documentation/Images/ManualScreenshots/ModuleNameTypoScript.png
Auto-merging Documentation/TypoScriptOverview/TheTermTemplate/Index.rst
[backport-86-to-13.4 f514928] Apply suggestions from code review
 Author: Lina Wolf <48202465+linawolf@users.noreply.github.com>
 Date: Sat Oct 26 07:01:20 2024 +0200
 3 files changed, 3 insertions(+), 3 deletions(-)

To backport manually, run these commands in your terminal:

# Fetch latest updates from GitHub
git fetch
# Create a new working tree
git worktree add .worktrees/backport-13.4 13.4
# Navigate to the new working tree
cd .worktrees/backport-13.4
# Create a new branch
git switch --create backport-86-to-13.4
# Cherry-pick the merged commit of this pull request and resolve the conflicts
git cherry-pick 0375022166075cc9f55d224ae1ccd70b79b7a750,3ba2bb40e46dc45f8dbd9df8c746b191912aa50b,e6dd65b18930f1c7443c3dc76d892ea7294fa76c
# Push it to GitHub
git push --set-upstream origin backport-86-to-13.4
# Go back to the original working tree
cd ../..
# Delete the working tree
git worktree remove .worktrees/backport-13.4

Then, create a pull request where the base branch is 13.4 and the compare/head branch is backport-86-to-13.4.

Copy link

The backport to 12.4 failed:

The process '/usr/bin/git' failed with exit code 128
stderr
error: commit e6dd65b18930f1c7443c3dc76d892ea7294fa76c is a merge but no -m option was given.
fatal: cherry-pick failed

stdout
Auto-merging Documentation/TypoScriptOverview/TheTermTemplate/Index.rst
[backport-86-to-12.4 f182c07] [TASK] Make TypoScript documentation clearer and more consistent
 Author: Philipp Kuhlmay <info@treupo.de>
 Date: Fri Oct 25 16:20:05 2024 +0200
 13 files changed, 60 insertions(+), 49 deletions(-)
 create mode 100644 Documentation/Images/ManualScreenshots/ModuleNameTypoScript.png
Auto-merging Documentation/TypoScriptOverview/TheTermTemplate/Index.rst
[backport-86-to-12.4 b538bbd] Apply suggestions from code review
 Author: Lina Wolf <48202465+linawolf@users.noreply.github.com>
 Date: Sat Oct 26 07:01:20 2024 +0200
 3 files changed, 3 insertions(+), 3 deletions(-)

To backport manually, run these commands in your terminal:

# Fetch latest updates from GitHub
git fetch
# Create a new working tree
git worktree add .worktrees/backport-12.4 12.4
# Navigate to the new working tree
cd .worktrees/backport-12.4
# Create a new branch
git switch --create backport-86-to-12.4
# Cherry-pick the merged commit of this pull request and resolve the conflicts
git cherry-pick 0375022166075cc9f55d224ae1ccd70b79b7a750,3ba2bb40e46dc45f8dbd9df8c746b191912aa50b,e6dd65b18930f1c7443c3dc76d892ea7294fa76c
# Push it to GitHub
git push --set-upstream origin backport-86-to-12.4
# Go back to the original working tree
cd ../..
# Delete the working tree
git worktree remove .worktrees/backport-12.4

Then, create a pull request where the base branch is 12.4 and the compare/head branch is backport-86-to-12.4.

linawolf added a commit to TYPO3-Documentation/TYPO3CMS-Reference-Typoscript that referenced this pull request Oct 31, 2024
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants