From 4756527185d6578d3c4a49ae2f1fa07a87ba6c11 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?P=C4=93teris=20Caune?= Date: Thu, 12 Aug 2021 13:07:19 +0300 Subject: [PATCH] Improve docs --- templates/docs/api.html | 4 ++++ templates/docs/api.md | 6 ++++++ templates/docs/configuring_notifications.html | 14 +++++++------- templates/docs/configuring_notifications.md | 14 +++++++------- 4 files changed, 24 insertions(+), 14 deletions(-) diff --git a/templates/docs/api.html b/templates/docs/api.html index 21cfc6c7..f26c6caf 100644 --- a/templates/docs/api.html +++ b/templates/docs/api.html @@ -148,6 +148,8 @@ specified value.

} +

The possible values for the status field are: new, started, up, grace, down, +and paused.

When using the read-only API key, SITE_NAME omits the following fields from responses: ping_url, update_url, pause_url, channels. It adds an extra unique_key field. The unique_key identifier is stable across API calls, and @@ -231,6 +233,8 @@ using the read-only API key) as an identifier.

} +

The possible values for the status field are: new, started, up, grace, down, +and paused.

Example Read-Only Response

When using the read-only API key, SITE_NAME omits the following fields from responses: ping_url, update_url, pause_url, channels. It adds an extra diff --git a/templates/docs/api.md b/templates/docs/api.md index dee6cbbb..99d6b5b7 100644 --- a/templates/docs/api.md +++ b/templates/docs/api.md @@ -132,6 +132,9 @@ curl --header "X-Api-Key: your-api-key" SITE_ROOT/api/v1/checks/ } ``` +The possible values for the `status` field are: `new`, `started`, `up`, `grace`, `down`, +and `paused`. + When using the read-only API key, SITE_NAME omits the following fields from responses: `ping_url`, `update_url`, `pause_url`, `channels`. It adds an extra `unique_key` field. The `unique_key` identifier is stable across API calls, and @@ -228,6 +231,9 @@ curl --header "X-Api-Key: your-api-key" SITE_ROOT/api/v1/checks/ } ``` +The possible values for the `status` field are: `new`, `started`, `up`, `grace`, `down`, +and `paused`. + ### Example Read-Only Response When using the read-only API key, SITE_NAME omits the following fields from responses: diff --git a/templates/docs/configuring_notifications.html b/templates/docs/configuring_notifications.html index 5012a4b1..66889011 100644 --- a/templates/docs/configuring_notifications.html +++ b/templates/docs/configuring_notifications.html @@ -44,18 +44,18 @@ in any of your projects. Set them up in Account Settings › Email Reports:

Email reminder options

-

Monthly Reports

-

SITE_NAME sends monthly email reports at the start of each month. Use them -to make sure all checks have their expected state, and nothing has -"fallen through the cracks."

-

A monthly report shows checks from all your projects. -For each check, it lists:

+

Weekly and Monthly Reports

+

SITE_NAME sends periodic email reports, either monthly at the start of each month, +or weekly every Monday. Use them to make sure all checks have their expected state, +and nothing has "fallen through the cracks."

+

The reports list checks from all your projects, grouped by project. +For each check, they show:

Example monthly report

-

You can opt-out from the monthly reports in the +

You can opt-out from receiving the the reports in the Account Settings › Email Reports page or by clicking the "Unsubscribe" link in the email report's footer.

\ No newline at end of file diff --git a/templates/docs/configuring_notifications.md b/templates/docs/configuring_notifications.md index 5ed03752..0ca352a6 100644 --- a/templates/docs/configuring_notifications.md +++ b/templates/docs/configuring_notifications.md @@ -55,14 +55,14 @@ Set them up in [Account Settings › Email Reports](../../accounts/profile/notif ![Email reminder options](IMG_URL/email_reports.png) -## Monthly Reports +## Weekly and Monthly Reports -SITE_NAME sends monthly email reports at the start of each month. Use them -to make sure all checks have their expected state, and nothing has -"fallen through the cracks." +SITE_NAME sends periodic email reports, either monthly at the start of each month, +or weekly every Monday. Use them to make sure all checks have their expected state, +and nothing has "fallen through the cracks." -A monthly report shows checks from all your projects. -For each check, it lists: +The reports list checks from all your projects, grouped by project. +For each check, they show: * check's current status * the number of downtimes by month, for the last two months @@ -70,6 +70,6 @@ For each check, it lists: ![Example monthly report](IMG_URL/monthly_report.png) -You can opt-out from the monthly reports in the +You can opt-out from receiving the the reports in the [Account Settings › Email Reports](../../accounts/profile/notifications/) page or by clicking the "Unsubscribe" link in the email report's footer. \ No newline at end of file