improve documentation #15
Closed
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This probably isn't the best message, but I think it could be really helpful to be specifically clear about this example. I don't think it's immediately clear that the webhook URL that you specify in GitHub should not be of the same host name as one of the mounted apps. When it is incorrectly configured this way, GitHub merely gets an unhelpful 404 response. Of course the reason why is that the mounted app picks up on the host name specified in the Github webhook and of course that route is not configured; but this isn't necessarily obvious, nor is the solution: pick an altogether separate hostname such as prepending _ to the hostname as in http://_my_app.example.com/reload/1/2/3/4/5 or perhaps some other preferred recommendation.
|
Thanks! I hope my version is OK. If not: please comment 👍 |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This probably isn't the best message, but I think it could be really helpful to be specifically clear about this example. I don't think it's immediately clear that the webhook URL that you specify in GitHub should not be of the same host name as one of the mounted apps. When it is incorrectly configured this way, GitHub merely gets an unhelpful 404 response. Of course the reason why is that the mounted app picks up on the host name specified in the Github webhook and of course that route is not configured; but this isn't necessarily obvious, nor is the solution: pick an altogether separate hostname such as prepending _ to the hostname as in http://_my_app.example.com/reload/1/2/3/4/5 or perhaps some other preferred recommendation.