Skip to content

Commit 5c7e238

Browse files
authored
Further improvements to Gitea webhook documentation
1 parent 3a59c2a commit 5c7e238

File tree

1 file changed

+13
-3
lines changed

1 file changed

+13
-3
lines changed

docs/webhooks.rst

+13-3
Original file line numberDiff line numberDiff line change
@@ -96,14 +96,22 @@ GitLab
9696
Gitea
9797
~~~~~
9898

99+
These instructions apply to any Gitea instance.
100+
99101
.. warning::
100102

101103
This isn't officially supported, but using the "GitHub webhook" is an effective workaround,
102104
because Gitea uses the same payload as GitHub. The generic webhook is not compatibile with Gitea.
105+
See `issue #8364`_ for more details. Official support may be implemented in the future.
103106

104-
* Manually create a "GitHub webhook" integration on Read the Docs
107+
On Read the Docs:
108+
109+
* Manually create a "GitHub webhook" integration
105110
(this will show a warning about the webhook not being correctly set up,
106111
that will go away when the webhook is configured in Gitea)
112+
113+
On your Gitea instance:
114+
107115
* Go to the :guilabel:`Settings` > :guilabel:`Webhooks` page for your project on your Gitea instance
108116
* Create a new webhook of type "Gitea"
109117
* For **URL**, use the URL of the integration on Read the Docs,
@@ -117,9 +125,11 @@ Gitea
117125
* Ensure **Active** is enabled; it is by default
118126
* Finish by clicking **Add Webhook**
119127
* Test the webhook with :guilabel:`Delivery test`
120-
* On Read the Docs, check that the warnings have disappeared and the delivery test triggered a build
121128

122-
These instructions apply to any Gitea instance.
129+
Finally, on Read the Docs, check that the warnings have disappeared
130+
and the delivery test triggered a build.
131+
132+
.. _issue #8364: https://github.com/readthedocs/readthedocs.org/issues/8364
123133

124134
.. _webhook-integration-generic:
125135

0 commit comments

Comments
 (0)