Update repo hooks documentation - #337
Conversation
Clarify and expand hook documentation to explain the differences between a `service` and an `event`, each of which got a section header with links throughout. Provide details on service configuration settings, default events and supported events. * Increase heading levels to support new sections * Provide more linking throughout * Add examples in the service and event sections
|
@elskwid Thanks for the ping, I missed this the first time around. At a cursory glance, it looks wonderful. I'll take a more in-depth look in a little bit, and probably provide comments. |
|
@gjtorikian, fantastic! Please do let me know if you'd like me to make any changes. |
There was a problem hiding this comment.
comma here, please: more [event](#events), regardless
There was a problem hiding this comment.
Hrm, as I'm reading this again should it be:
... can be configured for a specific service and one or more event ...
or
... can be configured for a specific service and one or more events ...
The second one sounds better to me.
There was a problem hiding this comment.
Yep, events makes sense.
|
@elskwid Love it! Made a few pedantic comments but overall it's solid work. Thanks! |
|
@gjtorikian - I'm on it. |
Pedants rejoice!
|
@gjtorikian: Okay, I put that last question/comment in about the plural for events. Other than that, this is good to go. |
Plurals are goods.
|
And there it is. Thanks again for all your help @gjtorikian. |
|
What, no way, thank you. Mergin' it. |
Update repo hooks documentation
🍸Update OAuth acceptance dialog
2 participants
I ran into some confusion over the weekend thinking that the web service should listen to all events by default. @kdaigle suggested that I update the docs, and so I have.
Clarify and expand hook documentation to explain the differences between a
serviceand anevent, each of which got a section header with links throughout. Provide details on service configuration settings, default events and supported events.