Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
[DOC] Replace "Edit on GitHub" workflow with contribution page
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. Conflicts: Documentation/Index.rst
- Loading branch information
1 parent
8e6f21d
commit abc0318
Showing
3 changed files
with
32 additions
and
3 deletions.
There are no files selected for viewing
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,26 @@ | ||
.. include:: /Includes.rst.txt | ||
|
||
============ | ||
Contribution | ||
============ | ||
|
||
Unlike most TYPO3 documentation, this manual does not support the | ||
popular *Edit on GitHub* workflow for manual contributions, as these | ||
documentation files are automatically generated from the ViewHelper | ||
source files - and overwritten on each generation run. | ||
|
||
Therefore, contribute to this documentation by editing the appropriate source | ||
files at | ||
|
||
* https://github.com/FluidTYPO3/vhs/tree/development/Classes/ViewHelpers | ||
|
||
For example, adding a new core feature list item to the *asset* page at | ||
|
||
* https://docs.typo3.org/other/fluidtypo3/vhs/main/en-us/fluidtypo3/vhs/latest/Asset.html | ||
|
||
is done by editing the class comment in | ||
|
||
* https://github.com/FluidTYPO3/vhs/blob/development/Classes/ViewHelpers/AssetViewHelper.php | ||
|
||
To enrich the comment text you can use the common directives of the Markdown | ||
markup language. |
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 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