Skip to content

Commit

Permalink
Merge pull request TYPO3-Documentation#71 from TYPO3-Documentation/fe…
Browse files Browse the repository at this point in the history
…ature/document-new-webhook

FEATURE: Add documentation for new webhook using intercept
  • Loading branch information
DanielSiepmann authored May 28, 2019
2 parents 2a11feb + 07045a0 commit fbb82b5
Show file tree
Hide file tree
Showing 9 changed files with 72 additions and 2 deletions.
3 changes: 1 addition & 2 deletions Documentation/WritingDocForExtension/CreateFromScratch.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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::

Expand Down
5 changes: 5 additions & 0 deletions Documentation/WritingDocForExtension/Index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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::
Expand All @@ -23,4 +27,5 @@ be a system extension in the core.
CreateFromScratch
ContributeToThirdPartyExtension
ContributeToSystemExtension
Webhook
ExtensionAuthorTips
66 changes: 66 additions & 0 deletions Documentation/WritingDocForExtension/Webhook.rst
Original file line number Diff line number Diff line change
@@ -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
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit fbb82b5

Please sign in to comment.