diff --git a/Documentation/WritingDocForExtension/CreateFromScratch.rst b/Documentation/WritingDocForExtension/CreateFromScratch.rst index 2711fbfb..30673aad 100644 --- a/Documentation/WritingDocForExtension/CreateFromScratch.rst +++ b/Documentation/WritingDocForExtension/CreateFromScratch.rst @@ -127,8 +127,7 @@ Method 2: Start Documentation from Example Manual .. important:: In order to trigger documentation rendering on the documentation server you have to - add `https://docs-hook.typo3.org/` as a webhook to your - public repository. Make sure to set the content type to `application-json`. + add an webhook, see :ref:`webhook`. .. tip:: diff --git a/Documentation/WritingDocForExtension/Index.rst b/Documentation/WritingDocForExtension/Index.rst index 09a28e8d..0af2ea23 100644 --- a/Documentation/WritingDocForExtension/Index.rst +++ b/Documentation/WritingDocForExtension/Index.rst @@ -14,6 +14,10 @@ changes to existing documentation of extensions. The extension may be a third party extension by someone else or one you maintain yourself, it may be a system extension in the core. +.. important:: + + When redirected here, :ref:`webhook` might be the place to check out. This + section explains how to setup new rendering via webhook for TYPO3 extensions. .. toctree:: @@ -23,4 +27,5 @@ be a system extension in the core. CreateFromScratch ContributeToThirdPartyExtension ContributeToSystemExtension + Webhook ExtensionAuthorTips diff --git a/Documentation/WritingDocForExtension/Webhook.rst b/Documentation/WritingDocForExtension/Webhook.rst new file mode 100644 index 00000000..e935615a --- /dev/null +++ b/Documentation/WritingDocForExtension/Webhook.rst @@ -0,0 +1,66 @@ +.. include:: ../Includes.txt + +.. _webhook: + +======= +Webhook +======= + +This section describes how to add webhooks for auto rendering to an repository. + +.. _webhook-github: + +GitHub +====== + +Add auto rendering for an Repository via GitHub webhook in five steps: + +.. rst-class:: bignums-xxl + +#. Go to "Settings" tab within the repository + + .. figure:: /images/webhook/github/repository-start.png + :width: 932 + +#. Go to "Webhooks" section within the repository settings + + .. figure:: /images/webhook/github/settings-tab.png + :width: 932 + +#. Add webhook + + .. figure:: /images/webhook/github/webhook-section.png + :width: 932 + +#. Fill in webhook configuration + + #. Configure URL ``https://docs-hook.typo3.org`` for field "Payload URL". + + #. Select ``application/json`` as "Content type". + + #. Enable "SSL verification". + + #. Select ``Just the push event.`` for "Which events would you like to trigger this webhook?". + + #. Enable "Activate". + + #. Click on "Add webhook" + + .. figure:: /images/webhook/github/webhook-add.png + :width: 932 + +#. Webhook was added + + GitHub should show an notice that creation of Webhook was successful. + + .. figure:: /images/webhook/github/webhook-added.png + :width: 932 + +#. (Optional) visit intercept and check request + + If curious, visit https://intercept.typo3.com/admin/docs/deployments and + check "Recent actions" (scroll down). The repository should have created an + "Docs hook ping from github repository". + + .. figure:: /images/webhook/github/intercept-feedback.png + :width: 932 diff --git a/Documentation/images/webhook/github/intercept-feedback.png b/Documentation/images/webhook/github/intercept-feedback.png new file mode 100644 index 00000000..8c268f74 Binary files /dev/null and b/Documentation/images/webhook/github/intercept-feedback.png differ diff --git a/Documentation/images/webhook/github/repository-start.png b/Documentation/images/webhook/github/repository-start.png new file mode 100644 index 00000000..f0ffc8a1 Binary files /dev/null and b/Documentation/images/webhook/github/repository-start.png differ diff --git a/Documentation/images/webhook/github/settings-tab.png b/Documentation/images/webhook/github/settings-tab.png new file mode 100644 index 00000000..567e7ff6 Binary files /dev/null and b/Documentation/images/webhook/github/settings-tab.png differ diff --git a/Documentation/images/webhook/github/webhook-add.png b/Documentation/images/webhook/github/webhook-add.png new file mode 100644 index 00000000..50cfffc4 Binary files /dev/null and b/Documentation/images/webhook/github/webhook-add.png differ diff --git a/Documentation/images/webhook/github/webhook-added.png b/Documentation/images/webhook/github/webhook-added.png new file mode 100644 index 00000000..453b42dc Binary files /dev/null and b/Documentation/images/webhook/github/webhook-added.png differ diff --git a/Documentation/images/webhook/github/webhook-section.png b/Documentation/images/webhook/github/webhook-section.png new file mode 100644 index 00000000..3cd03bae Binary files /dev/null and b/Documentation/images/webhook/github/webhook-section.png differ