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

Add to and reorder GitHub webhook docs #5514

Merged
merged 1 commit into from Mar 22, 2019
Merged

Conversation

@davidjb
Copy link
Contributor

@davidjb davidjb commented Mar 21, 2019

This does a small cleanup on the GitHub webhook docs by reordering the instructions in the order which fields are shown to the user on GitHub (reducing jumping around) but also explains the initial "ping" process that GitHub does. It was confusing to see RTD respond with {"detail":"Unhandled webhook event"} to a ping, when in fact this is working-as-expected.

stsewd
stsewd approved these changes Mar 21, 2019
Copy link
Member

@stsewd stsewd left a comment

Thanks!

Can you follow these guidelines https://docs.readthedocs.io/en/stable/docs.html#content?

The rest looks good :)

@davidjb
Copy link
Contributor Author

@davidjb davidjb commented Mar 22, 2019

Alright, updated in line with the documentation guidelines. There's quite a few parts of that documentation page that aren't in line with the guidelines (eg semantic linefeeds) so that's just been left as is.

I hadn't seen the guidelines for docs so I've opened #5522 to explain they exist. It also updates the install instructions, which are a bit more involved than just to install Sphinx.

This does a small cleanup on the GitHub webhook docs by reordering the instructions in the order which fields are shown to the user on GitHub (reducing jumping around) but also explains the initial "ping" process that GitHub does.  It was confusing to see RTD respond with `{"detail":"Unhandled webhook event"}` to a ping, when in fact this is working-as-expected.
@stsewd
Copy link
Member

@stsewd stsewd commented Mar 22, 2019

There's quite a few parts of that documentation page that aren't in line with the guidelines (eg semantic linefeeds) so that's just been left as is.

Yeah, we are trying to enforce this on new docs. Old docs are being refactored in small chunks, so they are easy to review. Thanks!

@stsewd stsewd merged commit 5ed7677 into readthedocs:master Mar 22, 2019
1 check passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Linked issues

Successfully merging this pull request may close these issues.

None yet

2 participants