From 534e99bf131e9a331761eceaeb45a8e9ef1ee776 Mon Sep 17 00:00:00 2001 From: Cameron Moore Date: Wed, 29 Jul 2020 17:13:33 -0500 Subject: [PATCH] Add a table of contents to some of the docs --- docs/Hook-Examples.md | 16 ++++++++++++++++ docs/Hook-Rules.md | 17 ++++++++++++++++- 2 files changed, 32 insertions(+), 1 deletion(-) diff --git a/docs/Hook-Examples.md b/docs/Hook-Examples.md index 23896a7..48ad38b 100644 --- a/docs/Hook-Examples.md +++ b/docs/Hook-Examples.md @@ -1,6 +1,22 @@ # Hook examples This page is still work in progress. Feel free to contribute! +### Table of Contents + +* [Incoming Github webhook](#incoming-github-webhook) +* [Incoming Bitbucket webhook](#incoming-bitbucket-webhook) +* [Incoming Gitlab webhook](#incoming-gitlab-webhook) +* [Incoming Gogs webhook](#incoming-gogs-webhook) +* [Incoming Gitea webhook](#incoming-gitea-webhook) +* [Slack slash command](#slack-slash-command) +* [A simple webhook with a secret key in GET query](#a-simple-webhook-with-a-secret-key-in-get-query) +* [JIRA Webhooks](#jira-webhooks) +* [Pass File-to-command sample](#pass-file-to-command-sample) +* [Incoming Scalr Webhook](#incoming-scalr-webhook) +* [Travis CI webhook](#travis-ci-webhook) +* [XML Payload](#xml-payload) +* [Multipart Form Data](#multipart-form-data) + ## Incoming Github webhook ```json [ diff --git a/docs/Hook-Rules.md b/docs/Hook-Rules.md index e1f92f6..0ff30b3 100644 --- a/docs/Hook-Rules.md +++ b/docs/Hook-Rules.md @@ -1,5 +1,20 @@ # Hook rules +### Table of Contents + +* [And](#and) +* [Or](#or) +* [Not](#not) +* [Multi-level](#multi-level) +* [Match](#match) + * [Match value](#match-value) + * [Match regex](#match-regex) + * [Match payload-hash-sha1](#match-payload-hash-sha1) + * [Match payload-hash-sha256](#match-payload-hash-sha256) + * [Match payload-hash-sha512](#match-payload-hash-sha512) + * [Match Whitelisted IP range](#match-whitelisted-ip-range) + * [Match scalr-signature](#match-scalr-signature) + ## And *And rule* will evaluate to _true_, if and only if all of the sub rules evaluate to _true_. ```json @@ -267,4 +282,4 @@ Given the time check make sure that NTP is enabled on both your Scalr and webhoo "secret": "Scalr-provided signing key" } } -``` \ No newline at end of file +```