[TASK] Improve Migration Documentation #406
Closed
Conversation
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
* [TASK] Adjust rendering page Releases: draft * Update Documentation/WritingDocForExtension/Migrate.rst Co-authored-by: Chris Müller <[email protected]> --------- Co-authored-by: Chris Müller <[email protected]>
* [TASK] Adjust rendering page Releases: draft * Update Documentation/RenderingDocs/Index.rst Co-authored-by: Chris Müller <[email protected]> * Update Documentation/RenderingDocs/Index.rst Co-authored-by: Chris Müller <[email protected]> * [TASK] Apply suggestions from code review * Update Documentation/RenderingDocs/Index.rst Co-authored-by: Chris Müller <[email protected]> * [TASK] Apply suggestions from code review --------- Co-authored-by: Chris Müller <[email protected]>
* [TASK] Replace .. code-block:: rest with .. code-block:: rst Releases: draft * [TASK] Remove the custom configuration schemes We do not support them anymore in the new rendering Releases: draft * [TASK] Remove outdated information about subtree split This has been outdated since TYPO3 9, the links dont work anymore Release: draft * [TASK] Fix outdated references Release: draft * [TASK] Remove Glossary section We don't support it anymore and it was never really used. Release: draft * [TASK] Introduce automatic testing So that the documentation renders without Release: draft * [TASK] Restore information from migration section That was still linked from these files
* [TASK] Update information on how to handle Core changes * Update Documentation/Maintainers/Changelog.rst Co-authored-by: Chris Müller <[email protected]> * Update Documentation/Maintainers/Changelog.rst Co-authored-by: Chris Müller <[email protected]> --------- Co-authored-by: Chris Müller <[email protected]> (cherry picked from commit 276c5a4)
The information is outdated, the suggested php storm plugins are not really helpful, the section on visual studio just general information how to create code snippets. (cherry picked from commit a0fb736)
There is no more usefull information in here. (cherry picked from commit e6d93e2)
* [TASK] Overhaul general file structure section * Update Documentation/GeneralConventions/FileStructure.rst Co-authored-by: Chris Müller <[email protected]> * Update Documentation/GeneralConventions/FileStructure.rst Co-authored-by: Chris Müller <[email protected]> * [TASK] Apply suggestions from code review * [TASK] Apply suggestions from code review --------- Co-authored-by: Chris Müller <[email protected]>
* [TASK] Overhaul about page * Update Documentation/About.rst (cherry picked from commit 8e9f83a)
In my eyes it is not really helpful, to much information, graphs that dont really say much... (cherry picked from commit 7e944fb)
* [TASK] Drop General "How to use GitHub" information Move specific information for our organization to the according chapters * [TASK] Use TYPO3 Explained as example (cherry picked from commit 9a43c59)
(cherry picked from commit 13bbda0)
Co-authored-by: lina.wolf <[email protected]>
prune unnecessary information.
* [TASK] Introduce Makefile and command 'make docs' This is more convenient then having to copy-paste the command all the time * Update CONTRIBUTING.rst
* [TASK] Move best practises for additonal readme files * Update Documentation/GeneralConventions/FileStructure.rst Co-authored-by: Chris Müller <[email protected]> * Update Documentation/GeneralConventions/FileStructure.rst Co-authored-by: Chris Müller <[email protected]> * Update Documentation/GeneralConventions/FileStructure.rst Co-authored-by: Chris Müller <[email protected]> * Update Documentation/GeneralConventions/FileStructure.rst Co-authored-by: Chris Müller <[email protected]> * Update Documentation/GeneralConventions/FileStructure.rst Co-authored-by: Chris Müller <[email protected]> * Update Documentation/GeneralConventions/ReadmeFile.rst Co-authored-by: Chris Müller <[email protected]> * Update Documentation/GeneralConventions/ReadmeFile.rst Co-authored-by: Chris Müller <[email protected]> * Update Documentation/GeneralConventions/ReadmeFile.rst Co-authored-by: Chris Müller <[email protected]> * Update Documentation/GeneralConventions/ReadmeFile.rst Co-authored-by: Chris Müller <[email protected]> * Update Documentation/GeneralConventions/ReadmeFile.rst Co-authored-by: Chris Müller <[email protected]> * Update Documentation/GeneralConventions/ReadmeFile.rst Co-authored-by: Chris Müller <[email protected]> * Update Documentation/GeneralConventions/ReadmeFile.rst Co-authored-by: Chris Müller <[email protected]> * Update Documentation/GeneralConventions/FileStructure.rst * Update Documentation/GeneralConventions/ReadmeFile.rst Co-authored-by: Chris Müller <[email protected]> * Update Documentation/GeneralConventions/ReadmeFile.rst Co-authored-by: Chris Müller <[email protected]> * Update Documentation/GeneralConventions/ReadmeFile.rst Co-authored-by: Chris Müller <[email protected]> * Update Documentation/GeneralConventions/ReadmeFile.rst Co-authored-by: Chris Müller <[email protected]> --------- Co-authored-by: Chris Müller <[email protected]>
* [TASK] Overhaul Startpage and menu / toctree configuration * [TASK] Apply suggestions from code review * Apply suggestions from code review Co-authored-by: Chris Müller <[email protected]> * Update Documentation/GeneralConventions/FileStructure.rst * Update Documentation/GeneralConventions/FileStructure.rst * Update Documentation/GeneralConventions/FileStructure.rst * Update Documentation/GeneralConventions/FileStructure.rst * Update Documentation/GeneralConventions/FileStructure.rst --------- Co-authored-by: Chris Müller <[email protected]>
It is not needed anymore except in rare edge cases.
* [TASK] Remove section on genindex We currently do not support a generated output of this file and in most cases it was not very usefull. * [TASK] Remove genindex It was not really usefull and does not work in the new rendering. We will use the indexes to enhance the elastic search instead
The textroles are already defined in the render-guides. the Includes.rst.txt is only needed now to display central messages. I will include a central message about the scope of this manual (render-guides only) in a follow-up.
I will explain the interlink mapping in depth in a follow-up. Co-authored-by: Chris Müller <[email protected]>
* Include in the toctree * Include a table of contents * Improve the title
We do not really have knowledge in this area and the information is quite outdated Co-authored-by: lina.wolf <[email protected]>
It was never really adopted and will not work anymore in the new rendering. The uml graphs can be used instead Co-authored-by: lina.wolf <[email protected]>
Displaying wrong syntax in order to teach someone is generally not considered best practise. Also some of these are specific to sphinx or outdated spinx versions.
Displaying wrong syntax in order to teach someone is generally not considered best practise. Also some of these are specific to sphinx or outdated spinx versions. Co-authored-by: lina.wolf <[email protected]>
We do not have strict rules for commit messages. Where necessary we can refer to core rules, but we do not need to repeat them here.
Co-authored-by: lina.wolf <[email protected]>
…396) * [TASK] Simplify UML graphic examples * Update Documentation/WritingReST/Reference/Graphics/Diagrams.rst Co-authored-by: Chris Müller <[email protected]> * Update Documentation/WritingReST/Reference/Graphics/Diagrams.rst --------- Co-authored-by: lina.wolf <[email protected]> Co-authored-by: Lina Wolf <[email protected]> Co-authored-by: Chris Müller <[email protected]>
(cherry picked from commit b176a02)
(cherry picked from commit 4b2b87b)
For the word attention, the article "an" is used, instead of "a", because attention starts with a vowel. (cherry picked from commit 363a439)
* The REST README must not be in markdown There is a markdown table which does not work in REST. * use samp method around links * fix headers to REST * headers (cherry picked from commit 2384f2e)
1: Add ":orphan:" to the ReadmeFile. Don't know where this is linked to. Maybe this can be removed (in a follow-up) 2: Remove usage-version-selector reference, this no longer exists on the DocsHome repository
* [TASK] Add in-depth notes for migration * Apply suggestions from code review Co-authored-by: Chris Müller <[email protected]> * [TASK] Implement changes from code review * [TASK] Use bignum formatting * [TASK] Enhances Makefile with a "test-docs" command * [TASK] Tell about Makefile tab indentation oddities * [TASK] Remove "screenshots.json" reference * Update Documentation/WritingDocForExtension/Migrate.rst Co-authored-by: Chris Müller <[email protected]> * Apply suggestions from code review Co-authored-by: Chris Müller <[email protected]> * [TASK] Implement review feedback * [TASK] Use diff syntax instead emphasize-lines * Small adjustments --------- Co-authored-by: Chris Müller <[email protected]>
* [TASK] Add note about podman and optimize docker run commands * [BUGFIX] Revert part of the commit, I think this is still needed.
And advertise it on the front page.
linawolf
reviewed
Apr 16, 2024
| The main difference compared to the Sphinx rendering is that the PHP-based rendering | ||
| requires a file called :file:`Documentation/guides.xml` for configuration. | ||
| The Sphinx rendering required a file called :file:`Documentation/Settings.cfg`. | ||
| In the transition period the process detects if a file called |
There was a problem hiding this comment.
I would give the "process" a name. "The Webhook"? The "GitHub Action"?
linawolf
reviewed
Apr 16, 2024
| PHP-based rendering. | ||
|
|
||
| .. _migrate_guides_xml: | ||
|
|
||
| Create the settings file :file:`Documentation/guides.xml` | ||
| ========================================================= | ||
|
|
||
| The Docker container for the PHP-based rendering additionally contains | ||
| The Docker container for the PHP-based rendering additionally consists out of |
linawolf
reviewed
Apr 16, 2024
| After the migration is performed, you will see some output in the terminal about which settings were | ||
| converted, if some old settings were discarded, or errors occurred. When you see this: | ||
|
|
||
| .. code-block:: text |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
No description provided.