[TASK] Setup GitHub workflow "render-docs" #1771
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
|
This is how the generated ViewHelpers pages look like: |
Is now handled in PR TYPO3-Documentation/fluid-documentation-generator#5. |
Automatically generate reST documentation files from the Fluid ViewHelpers implementation in Documentation/fluidtypo3/vhs/, commit and push.
The documentation files were created by manually processing the "render-docs.yml" on a local machine. This is due to the fact that the bin/generate-schema binary of the typo3/fluid-schema-generator project does not yet work properly with TYPO3 11+, which is documented in TYPO3-Documentation/t3docs-ci-deploy#4 and has to be fixed to make "render-docs.yml" work properly.
The reST documentation exporter has been adapted to handle the Markdown format of the VHS ViewHelpers documentation.
This helps to parse Markdown to reST in the Fluid Documentation Generator.
Adjusted documentation in ViewHelper classes by replacing all code blocks formatted by indentation with code blocks wrapped by "```". Reflect these changes in the generated documentation.
Disable until the related issue of the Fluid Schema Generator is solved: TYPO3-Documentation/t3docs-ci-deploy#4
|
I rebased the PR on the current |
NamelessCoder
force-pushed
the
development
branch
3 times, most recently
from
7b35850
to
50d769b
Compare
Most of the ViewHelper documentation is generated from the ViewHelper source code. Therefore, the "Edit on GitHub" workflow is counterproductive because it applies PRs to the reST files that will be overwritten during the next generation run. Remove the "Edit on GitHub" workflow and instead add a contribution page that explains all the manual steps.
|
Has been integrated in meantime by Claus. |
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.
Automatically generate reST documentation files from the Fluid ViewHelpers implementation in Documentation/fluidtypo3/vhs/, commit and push.
This is inspired from the rendering workflow of the basic Fluid ViewHelpers documentation.
What i did:
What is missing:
In the long run the Fluid documentation generator has to be adapted to generate proper reST. Currently it has some flaws.