[TASK] Rework the testing framework section in the docs#1480
Conversation
oliverklee
left a comment
oliverklee
left a comment
There was a problem hiding this comment.
Now that it's not relevant to choose a testing framework anymore, I think we can change this section of the documentation to be about the release and branching strategy and less about which TF to use. This then should involve a changed file heading and renaming this file.
I have renamed the file to ReleaseBranchingStrategy.rst and updated the content to reflect the release and branching strategies as per the feedback. Please feel free to let me know if any further modifications or confirmations are needed. |
oliverklee
left a comment
oliverklee
left a comment
There was a problem hiding this comment.
You'll need to include the new file from Documentation/Index.rst so it can get rendered.
With this command, you can render the documentation locally and check if there are any warnings:
./Build/Scripts/runTests.sh -s docsGenerateYou then can also view the rendered documentation by opening Documentation-GENERATED-temp/Index.html in your browser.
|
Hi, Added the new file ReleaseBranchingStrategy to the Documentation/Index.rst so it can be rendered. |
oliverklee
left a comment
oliverklee
left a comment
There was a problem hiding this comment.
There are still warnings when rendering the documentation. Please have a look at the CI build (or build the documentation locally) and fix those warnings.
If you have questions for that, please feel free to ask!
|
Thank you for pointing out the warnings in the documentation. I’m not very familiar with handling CI actions, troubleshooting, or fixing warnings during the documentation rendering process. Could you help clarify the following points for me? I'll be very thankful to you. |
Remove "# Added new entry here" from index.rst
|
Hi, Thank you! |
Adjusted the length of the '====' lines to align with the header text for consistent formatting
Updated the code to ensure that all line lengths are now limited to a maximum of 80 characters for better readability
SalmanDeveloperz
left a comment
SalmanDeveloperz
left a comment
There was a problem hiding this comment.
Please review changes and let me know if any furture requirement needed.
Just drop this document (and the reference to it) altogether.
oliverklee
changed the title
Remove TestingFramework from Table of Contents.
SalmanDeveloperz
left a comment
SalmanDeveloperz
left a comment
There was a problem hiding this comment.
Just removed TestingFramework from Table of Contents.
|
Hi, |
|
Congratulations on your first merged PR for this project! 🎉 |
|
Thank you so much! 🎉 I really appreciate your guidance throughout the process. I’m excited to contribute more and continue learning from the team. Looking forward to the next challenge! |
3 participants
This Pull Request reworks the documentation for the testing framework section, specifically addressing the deprecation of the Nimut testing framework. Key changes include:
Removed references to the Nimut testing framework, as it is no longer maintained.
Updated the documentation to reflect that the TYPO3 Core Testing Framework now supports multiple TYPO3 LTS versions simultaneously, making the unique selling point of the Nimut TF irrelevant.
These changes aim to clarify the current best practices for testing within TYPO3 and provide a more accurate and up-to-date guide for developers.
Please feel free to let me know if any modifications or confirmations are needed.
Related Issue
This PR addresses ticket #535.