[TASK] Make the docs render

in2code-de · Nov 9, 2024 · 5f9c6a2 · 5f9c6a2
1 parent 3812ff6
commit 5f9c6a2
Show file tree

Hide file tree

Showing 15 changed files with 66 additions and 58 deletions.
diff --git a/Documentation/Changelog/Readme.md → Documentation/Changelog/Index.md b/Documentation/Changelog/Readme.md → Documentation/Changelog/Index.md
@@ -2,7 +2,7 @@
 
 **Note:** Breaking changes are marked with !!!
 
-See [Upgrade instructions and breaking changes](/Documentation/Changelog/UpgradeInstructions.md) for some details on
+See [Upgrade instructions and breaking changes](/Changelog/UpgradeInstructions.md) for some details on
 breaking changes and how to handle them
 
 | Version         | Release Date | Description                                                                                                                                                                                                           |

diff --git a/Documentation/FAQ/Readme.md → Documentation/FAQ/Index.md b/Documentation/FAQ/Readme.md → Documentation/FAQ/Index.md
diff --git a/Documentation/ForAdministrators/BestPractice.md b/Documentation/ForAdministrators/BestPractice.md
@@ -2,24 +2,24 @@
 
 This chapter show you some best practice how you can deal with your daily business together with powermail
 
-* [Templates](/Documentation/ForAdministrators/BestPractice/Templates.md)
-* [ChangingLabels](/Documentation/ForAdministrators/BestPractice/ChangingLabels.md)
-* [PrefillField](/Documentation/ForAdministrators/BestPractice/PrefillField.md)
-* [DynamicReceiver](/Documentation/ForAdministrators/BestPractice/DynamicReceiver.md)
-* [RemoveValuesFromPowermailAll](/Documentation/ForAdministrators/BestPractice/RemoveValuesFromPowermailAll.md)
-* [ManipulateValuesFromPowermailAll](/Documentation/ForAdministrators/BestPractice/ManipulateValuesFromPowermailAll.md)
-* [UniqueValues](/Documentation/ForAdministrators/BestPractice/UniqueValues.md)
-* [SaveSession](/Documentation/ForAdministrators/BestPractice/SaveSession.md)
-* [AjaxSubmit](/Documentation/ForAdministrators/BestPractice/AjaxSubmit.md)
-* [FilterFormSelection](/Documentation/ForAdministrators/BestPractice/FilterFormSelection.md)
-* [SetPidForNewForms](/Documentation/ForAdministrators/BestPractice/SetPidForNewForms.md)
-* [DevelopmentContext](/Documentation/ForAdministrators/BestPractice/DevelopmentContext.md)
-* [SpamPrevention](/Documentation/ForAdministrators/BestPractice/SpamPrevention.md)
-* [PreventDuplicates](/Documentation/ForAdministrators/BestPractice/PreventDuplicates.md)
-* [SavingValuesToThirdPartyTables](/Documentation/ForAdministrators/BestPractice/SavingValuesToThirdPartyTables.md)
-* [SendingValuesToThirdPartySoftware](/Documentation/ForAdministrators/BestPractice/SendingValuesToThirdPartySoftware.md)
-* [Debug](/Documentation/ForAdministrators/BestPractice/Debug.md)
-* [MainTypoScript](/Documentation/ForAdministrators/BestPractice/MainTypoScript.md)
-* [DateConverterUserFunc](/Documentation/ForAdministrators/BestPractice/DateConverterUserFunc.md)
-* [TypoScriptConditions](/Documentation/ForAdministrators/BestPractice/TypoScriptConditions.md)
-* [PasswordField](/Documentation/ForAdministrators/BestPractice/PasswordField.md)
+* [Templates](/ForAdministrators/BestPractice/Templates.md)
+* [ChangingLabels](/ForAdministrators/BestPractice/ChangingLabels.md)
+* [PrefillField](/ForAdministrators/BestPractice/PrefillField.md)
+* [DynamicReceiver](/ForAdministrators/BestPractice/DynamicReceiver.md)
+* [RemoveValuesFromPowermailAll](/ForAdministrators/BestPractice/RemoveValuesFromPowermailAll.md)
+* [ManipulateValuesFromPowermailAll](/ForAdministrators/BestPractice/ManipulateValuesFromPowermailAll.md)
+* [UniqueValues](/ForAdministrators/BestPractice/UniqueValues.md)
+* [SaveSession](/ForAdministrators/BestPractice/SaveSession.md)
+* [AjaxSubmit](/ForAdministrators/BestPractice/AjaxSubmit.md)
+* [FilterFormSelection](/ForAdministrators/BestPractice/FilterFormSelection.md)
+* [SetPidForNewForms](/ForAdministrators/BestPractice/SetPidForNewForms.md)
+* [DevelopmentContext](/ForAdministrators/BestPractice/DevelopmentContext.md)
+* [SpamPrevention](/ForAdministrators/BestPractice/SpamPrevention.md)
+* [PreventDuplicates](/ForAdministrators/BestPractice/PreventDuplicates.md)
+* [SavingValuesToThirdPartyTables](/ForAdministrators/BestPractice/SavingValuesToThirdPartyTables.md)
+* [SendingValuesToThirdPartySoftware](/ForAdministrators/BestPractice/SendingValuesToThirdPartySoftware.md)
+* [Debug](/ForAdministrators/BestPractice/Debug.md)
+* [MainTypoScript](/ForAdministrators/BestPractice/MainTypoScript.md)
+* [DateConverterUserFunc](/ForAdministrators/BestPractice/DateConverterUserFunc.md)
+* [TypoScriptConditions](/ForAdministrators/BestPractice/TypoScriptConditions.md)
+* [PasswordField](/ForAdministrators/BestPractice/PasswordField.md)
diff --git a/Documentation/ForAdministrators/BestPractice/DynamicReceiver.md b/Documentation/ForAdministrators/BestPractice/DynamicReceiver.md
@@ -34,8 +34,8 @@ plugin.tx_powermail.settings.setup.receiver.predefinedReceiver {
 ### Dynamic example 1
 
 In a bit more advanced example, we want to choose the receiver by a given value (e.g. of a select box).
-If value 1 is given in a field with marker *{receiver}*, *[email protected]* should be chosen
-and if value 2 or something else is given, *[email protected]* should be chosen.
+If value 1 is given in a field with marker `{receiver}`, `[email protected]` should be chosen
+and if value 2 or something else is given, `[email protected]` should be chosen.
 See following TypoScript setup example:
 
 ```

diff --git a/Documentation/ForAdministrators/Readme.md → Documentation/ForAdministrators/Index.md b/Documentation/ForAdministrators/Readme.md → Documentation/ForAdministrators/Index.md
@@ -1,4 +1,4 @@
-# TYPO3 Extension powermail - Documentation - For administrators
+# For administrators
 
 This chapter describes how you can install and configure powermail on your TYPO3 instance
 

diff --git a/Documentation/ForAdministrators/Upgrade.md b/Documentation/ForAdministrators/Upgrade.md
@@ -8,7 +8,7 @@ as possible.
 
 ## Upgrade Instructions
 
-You find instructions for each major version. [Upgrade Instructions](/Documentation/Changelog/UpgradeInstructions.md)
+You find instructions for each major version. [Upgrade Instructions](/Changelog/UpgradeInstructions.md)
 
 ## Any Upgrade
 

diff --git a/Documentation/ForContributors/Readme.md → Documentation/ForContributors/Index.md b/Documentation/ForContributors/Readme.md → Documentation/ForContributors/Index.md
@@ -1,4 +1,4 @@
-# TYPO3 Extension powermail - Documentation for contributors
+# For contributors
 
 If you want to contribute to the TYPO3 extension powermail, you are very welcome.
 
@@ -54,7 +54,7 @@ ddev exec composer run test:php:phpstan:generate-baseline
 
 ## Behaviour tests
 
-More information on running behaviour tests is available here: [Behaviour tests](../../Tests/Behavior/readme.md)
+More information on running behaviour tests is available here: [Behaviour tests](https://github.com/in2code-de/powermail/tree/documentation-draft/Tests/Behavior/readme.md)
 
 ## Frontend Development
 
@@ -71,3 +71,10 @@ There is a small build pipeline to build the assets. The artifacts are committed
 * `npm run build` will build the necessary files
 * `npm run watch` will watch the files and rebuild them on changes
 
+## Render the Documentation
+
+You can render the documentation locally with
+
+```bash
+composer render:docs
+```
diff --git a/Documentation/ForDevelopers/Index.md b/Documentation/ForDevelopers/Index.md
@@ -0,0 +1,17 @@
+# For developers
+
+Powermail can be extended in similar ways. If you want to execute something on a submit, look at the Finisher Classes.
+If you want to add own spamshield methods, look in this chapter, etc...
+
+* [AddFinisherClasses](/ForDevelopers/AddFinisherClasses.md)
+* [AddSpamshieldMethods](/ForDevelopers/AddSpamshieldMethods.md)
+* [DisableSpamshield](/ForDevelopers/DisableSpamshield.md)
+* [EventDispatcher](/ForDevelopers/EventDispatcher.md)
+* [AddNewFields](/ForDevelopers/AddNewFields.md)
+* [AddNewFieldProperties](/ForDevelopers/AddNewFieldProperties.md)
+* [AddNewFlexFormProperties](/ForDevelopers/AddNewFlexFormProperties.md)
+* [WriteOwnValidators](/ForDevelopers/WriteOwnValidators.md)
+* [AddDataProcessors](/ForDevelopers/AddDataProcessors.md)
+* [UserfuncsWithCobject](/ForDevelopers/UserfuncsWithCobject.md)
+* [DatabaseModel](/ForDevelopers/DatabaseModel.md)
+* [Local Development with Docker](/ForDevelopers/LocalDevelopment.md)
diff --git a/Documentation/ForDevelopers/Readme.md b/Documentation/ForDevelopers/Readme.md
diff --git a/Documentation/ForEditors/Readme.md → Documentation/ForEditors/Index.md b/Documentation/ForEditors/Readme.md → Documentation/ForEditors/Index.md
@@ -1,4 +1,4 @@
-# TYPO3 Extension powermail - Documentation - For editors
+# For editors
 
 This chapter describes how to work with powermail from the view of an editor.
 

diff --git a/Documentation/README.md → Documentation/Index.md b/Documentation/README.md → Documentation/Index.md
@@ -86,14 +86,14 @@ See the reporting about the delivered mails (Form or Marketing Data Analyses are
 
 ## Documentation overview
 
-* [Introduction](/Documentation/Readme.md)
-* [Development Model](/Documentation/DevelopmentModel.md)
-* [Documentation for editors](/Documentation/ForEditors/Readme.md)
-* [Documentation for administrators](/Documentation/ForAdministrators/Readme.md)
-* [Documentation for developers](/Documentation/ForDevelopers/Readme.md)
-* [Documentation for contributors](/Documentation/ForContributors/Readme.md)
-* [FAQ](/Documentation/FAQ/Readme.md) (with a lot of stuff and best practice)
-* [Changelog](/Documentation/Changelog/Readme.md)
-* [Upgrade Instructions](/Documentation/Changelog/UpgradeInstructions.md)
-* [Support](/Documentation/Support/Readme.md)
-* [Additional links](/Documentation/Links/Readme.md)
+* [Introduction](/Index.md)
+* [Development Model](/DevelopmentModel.md)
+* [Documentation for editors](/ForEditors/Index.md)
+* [Documentation for administrators](/ForAdministrators/Index.md)
+* [Documentation for developers](/ForDevelopers/Index.md)
+* [Documentation for contributors](/ForContributors/Index.md)
+* [FAQ](/FAQ/Index.md) (with a lot of stuff and best practice)
+* [Changelog](/Changelog/Index.md)
+* [Upgrade Instructions](/Changelog/UpgradeInstructions.md)
+* [Support](/Support/Index.md)
+* [Additional links](/Links/Index.md)
diff --git a/Documentation/Links/Readme.md → Documentation/Links/Index.md b/Documentation/Links/Readme.md → Documentation/Links/Index.md
diff --git a/Documentation/Support/Readme.md → Documentation/Support/Index.md b/Documentation/Support/Readme.md → Documentation/Support/Index.md
diff --git a/Documentation/guides.xml b/Documentation/guides.xml
@@ -4,7 +4,7 @@
     xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
     xsi:schemaLocation="https://www.phpdoc.org/guides vendor/phpdocumentor/guides-cli/resources/schema/guides.xsd"
     input-format="md"
-    index-name="Readme"
+    index-name="Index"
     automatic-menu="true"
 >
     <project

diff --git a/composer.json b/composer.json
@@ -103,6 +103,7 @@
 		}
 	},
 	"scripts": {
+		"render:docs": "docker run --rm --pull always -v $(pwd):/project -it ghcr.io/typo3-documentation/render-guides:latest --config=Documentation",
 		"test:behaviour": "behat --config Tests/Behavior/behat.yml",
 		"test:behaviour:tag": "behat --config Tests/Behavior/behat.yml --tags",
 		"test:behaviour:stop": "behat --config Tests/Behavior/behat.yml --stop-on-failure",