Browse Source

Improve docs

pull/551/head
Pēteris Caune 3 years ago
parent
commit
4756527185
No known key found for this signature in database GPG Key ID: E28D7679E9A9EDE2
4 changed files with 24 additions and 14 deletions
  1. +4
    -0
      templates/docs/api.html
  2. +6
    -0
      templates/docs/api.md
  3. +7
    -7
      templates/docs/configuring_notifications.html
  4. +7
    -7
      templates/docs/configuring_notifications.md

+ 4
- 0
templates/docs/api.html View File

@ -148,6 +148,8 @@ specified value.</p>
<span class="p">}</span>
</code></pre></div>
<p>The possible values for the <code>status</code> field are: <code>new</code>, <code>started</code>, <code>up</code>, <code>grace</code>, <code>down</code>,
and <code>paused</code>.</p>
<p>When using the read-only API key, SITE_NAME omits the following fields from responses:
<code>ping_url</code>, <code>update_url</code>, <code>pause_url</code>, <code>channels</code>. It adds an extra
<code>unique_key</code> field. The <code>unique_key</code> identifier is stable across API calls, and
@ -231,6 +233,8 @@ using the read-only API key) as an identifier.</p>
<span class="p">}</span>
</code></pre></div>
<p>The possible values for the <code>status</code> field are: <code>new</code>, <code>started</code>, <code>up</code>, <code>grace</code>, <code>down</code>,
and <code>paused</code>.</p>
<h3>Example Read-Only Response</h3>
<p>When using the read-only API key, SITE_NAME omits the following fields from responses:
<code>ping_url</code>, <code>update_url</code>, <code>pause_url</code>, <code>channels</code>. It adds an extra


+ 6
- 0
templates/docs/api.md View File

@ -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/<uuid>
}
```
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:


+ 7
- 7
templates/docs/configuring_notifications.html View File

@ -44,18 +44,18 @@ in any of your projects.
Set them up in <a href="../../accounts/profile/notifications/">Account Settings › Email Reports</a>:</li>
</ul>
<p><img alt="Email reminder options" src="IMG_URL/email_reports.png" /></p>
<h2>Monthly Reports</h2>
<p>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."</p>
<p>A monthly report shows checks from all your projects.
For each check, it lists:</p>
<h2>Weekly and Monthly Reports</h2>
<p>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."</p>
<p>The reports list checks from all your projects, grouped by project.
For each check, they show:</p>
<ul>
<li>check's current status</li>
<li>the number of downtimes by month, for the last two months</li>
<li>the total downtime duration by month, for the last two months</li>
</ul>
<p><img alt="Example monthly report" src="IMG_URL/monthly_report.png" /></p>
<p>You can opt-out from the monthly reports in the
<p>You can opt-out from receiving the the reports in the
<a href="../../accounts/profile/notifications/">Account Settings › Email Reports</a> page
or by clicking the "Unsubscribe" link in the email report's footer.</p>

+ 7
- 7
templates/docs/configuring_notifications.md View File

@ -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.

Loading…
Cancel
Save