diff --git a/static/css/docs.css b/static/css/docs.css index 070c8eec..f6b70a5c 100644 --- a/static/css/docs.css +++ b/static/css/docs.css @@ -26,6 +26,10 @@ font-family: monospace; } +.docs-heading { + margin-top: 40px; +} + h2.rule { border-top: 3px solid #eee; margin-top: 30px; @@ -38,6 +42,10 @@ h3.api-section { margin: 20px 0; } +h3.docs-example { + margin-top: 40px; +} + .api-path { font-family: monospace; font-weight: bold; diff --git a/templates/front/base_docs.html b/templates/front/base_docs.html index fd9bf4d0..89c49a3a 100644 --- a/templates/front/base_docs.html +++ b/templates/front/base_docs.html @@ -1,4 +1,6 @@ {% extends "base.html" %} +{% load hc_extras %} + {% block content %}
Each check in My Checks page has a unique "ping" URL. Whenever you make a HTTP request to this URL, @@ -29,7 +29,8 @@ if still no ping, sends you an alert.
alerts. As soon as it fails to check in on time, you get notified. It is a simple idea. -At the end of your batch job, add a bit of code to request your ping URL. @@ -50,7 +51,7 @@ It is a simple idea.
The response will have status code "200 OK" and response body will be a short and simple string "OK".
-
Append /fail
to a ping URL and use it to actively signal a
failure. Requesting the /fail
URL will immediately mark the
@@ -62,8 +63,24 @@ work function returns an unexpected value or throws an exception:
+ Jump to example: + Crontab, + Bash, + Python, + Ruby, + Node, + PHP, + C#, + Browser, + PowerShell, + Email. +
+ -When using cron, probably the easiest is to append a curl @@ -128,7 +145,7 @@ task runs. Feel free to adjust the curl options to your liking. -
Both curl
and wget
examples accomplish the same
thing: they fire off a HTTP GET method.
If you are already using the @@ -158,19 +175,19 @@ thing: they fire off a HTTP GET method.
{% include "front/snippets/python_urllib2.html" %} -You can use PowerShell and Windows Task Scheduler to automate various tasks on a Windows system. @@ -210,7 +227,7 @@ using the "-command" argument:
{% include "front/snippets/powershell_inline.html" %} -As an alternative to HTTP/HTTPS requests, you can "ping" this check by sending an @@ -234,7 +251,7 @@ using the "-command" argument:
-Each check has a configurable Period parameter, with the default value of one day. For periodic tasks, this is the expected time gap between two runs.