Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Webhooks doc page has a self-referencing link causing confusion #4282

Closed
annegentle opened this issue Jun 20, 2018 · 1 comment
Closed

Webhooks doc page has a self-referencing link causing confusion #4282

annegentle opened this issue Jun 20, 2018 · 1 comment
Labels
Needed: documentation Documentation is required

Comments

@annegentle
Copy link
Contributor

Details

Difficulty understanding the Payload URL for a webhook. I had trouble with the doc page:
https://docs.readthedocs.io/en/latest/webhooks.html
source: https://github.com/rtfd/readthedocs.org/blob/master/docs/webhooks.rst
and so did this person on Stack Overflow: https://stackoverflow.com/questions/50757576/how-to-obtain-a-webhook-for-a-readthedocument

  • Read the Docs project URL: n/a
  • Build URL (if applicable): n/a
  • Read the Docs username (if applicable): rockthedocs

Expected Result

In reading that page, when I clicked a link to " found on the integration detail page page" the "integration detail page" simply links to an anchor on the same page, "https://docs.readthedocs.io/en/latest/webhooks.html#webhook-integrations"- I think the doc should go into deeper detail about where the Payload URL can be found.

Suggest more info:

I believe you go to readthedocs.org/dashboard, log in with your username and password for rtd, then go to Admin > Integrations to see the Payload URL. Then follow the instructions in https://docs.readthedocs.io/en/latest/webhooks.html.

For one of my projects, I go to this link for the Dashboard > Admin > Integrations page: https://readthedocs.org/dashboard/rockthedocs-demo/integrations/40708/ On that page, the Payload URL looks like this: readthedocs.org/api/v2/webhook/rockthedocs-demo/40708/

You can verify if the webhook is working at the bottom of the GitHub page under Recent Deliveries. If you see a Response 200, then the webhook is correctly configured.

Actual Result

Self-referencing link to the same docs page.

annegentle added a commit to annegentle/readthedocs.org that referenced this issue Jun 20, 2018
@stsewd stsewd added the Needed: documentation Documentation is required label Jun 20, 2018
@stsewd
Copy link
Member

stsewd commented Jun 26, 2018

This was fixed in #4283

@stsewd stsewd closed this as completed Jun 26, 2018
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Needed: documentation Documentation is required
Projects
None yet
Development

No branches or pull requests

2 participants